You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+25-66Lines changed: 25 additions & 66 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -3,7 +3,6 @@
3
3
Import a point cloud file and perform poisson 3D surface reconstruction algorithm,
4
4
integrated with third-party libraries like [open3d](http://www.open3d.org/docs/release/tutorial/geometry/surface_reconstruction.html?highlight=surface%20reconstruction#Poisson-surface-reconstruction) and [pymeshlab](https://github.com/cnr-isti-vclab/PyMeshLab)
5
5
6
-
# Installation
7
6
8
7
## Dependencies
9
8
@@ -14,92 +13,52 @@ integrated with third-party libraries like [open3d](http://www.open3d.org/docs/r
-[setuptools](https://pypi.org/project/setuptools): For installation via `setup.py`
20
19
-[setuptools-scm](https://pypi.org/project/setuptools-scm): To generate version numbers from **git tags**
21
20
-[wheel](https://pypi.org/project/wheel/): Built packages `.whl` to install packages with PIP
22
21
-[twine](https://pypi.org/project/twine): Publish packages to https://pypi.org
23
22
-[tqdm](https://pypi.org/project/tqdm): CLI progressbar when publish a package
24
23
25
-
# Getting Started
24
+
## Development guide
25
+
26
+
For local installation and develop new features for this package, follow the steps below:
26
27
27
-
Install a Python <= 3.8.x version using [pyenv](https://github.com/pyenv/pyenv) (recommended)
28
28
29
29
### Windows
30
30
31
-
```bash
32
-
# With Chocolatey
33
-
choco install pyenv-win
34
-
```
31
+
> Run unassigned powershell scripts on Windows requires change your execution policy with `Set-ExecutionPolicy` to `AllSigned`, or `Bypass -Scope Process`.
Install same Python version inside of the file **[.python-version](.python-version)**
51
+
### Unix systems (Comming soon)
59
52
60
53
```bash
61
-
cd [project-folder]
62
-
63
-
# Loads local version from .python-version file
64
-
pyenv local
65
-
66
-
# PS: The 3.8.2 Python version is latest available in Pyenv for Windows.
67
-
# On Unix systems, is possible install 3.8.8, for example.
68
-
pyenv install 3.8.2
54
+
# Default virtualenv folder is "venv"
55
+
./setup.sh
69
56
70
-
#Check the installed version
71
-
python --version
57
+
#Optionally, pass a custom virtual enviroment folder
58
+
./setup.sh --virtual-env-folder myenv
72
59
```
73
60
74
-
Create a **Virtual Environment** to store the packages dependencies, and activate it
75
-
76
-
```bash
77
-
python -m venv venv
78
-
79
-
# Activate
80
-
81
-
# Windows
82
-
.\venv\Scripts\activate.bat
83
-
84
-
# Unix systems
85
-
./venv/Scripts/activate
86
-
```
87
-
88
-
Install all dependencies
89
-
90
-
```bash
91
-
pip install -r .\requirements-dev.txt
92
-
```
93
-
94
-
# Configure Pycharm (Optional)
95
-
96
-
Define your interpreter in your preferable IDE (**Visual Studio, VSCode**...) from the virtual environment. In this case, we are using [Pycharm](https://www.jetbrains.com/pycharm) as example:
97
-
98
-
1. Click on `File` => `Settings` => `Python Interpeter`
99
-
2. Add your interpreter from your virtual environment (**recommended**)
100
-
3. If you prefer, download from the official python.org FTP clicking on `"New enviroment"`, as showed in the picture below
For more detailed installation, see the Wiki pages in: [Installation Development](https://github.com/mfdeveloper/surface_reconstruction_python/wiki/Installation-Details)
103
62
104
63
## Install this package
105
64
@@ -109,20 +68,20 @@ Quick way:
109
68
pip install surface_reconstruction
110
69
```
111
70
112
-
Or clone the repository and run from the project root:
71
+
Or clone this repository and run from the project root:
113
72
114
73
```bash
115
74
python setup.py install
116
75
```
117
76
118
-
## Run the unit tests
77
+
###Run the unit tests
119
78
120
79
```bash
121
80
# Run all tests of the module "surface_reconstruction_test`
0 commit comments