Skip to content

Commit

Permalink
[setup] split dev requirements + update install doc
Browse files Browse the repository at this point in the history
  • Loading branch information
yann-lty committed Jun 8, 2018
1 parent cb285a6 commit 1a1251a
Show file tree
Hide file tree
Showing 5 changed files with 17 additions and 47 deletions.
40 changes: 5 additions & 35 deletions INSTALL.md
Expand Up @@ -19,43 +19,14 @@ ALICEVISION_SENSOR_DB=/path/to/database
ALICEVISION_VOCTREE=/path/to/voctree
```

### Python 2.7

### Pyside2 (for Qt >= 5.10)
#### Update (02/05/2018)
[Python for Qt](http://blog.qt.io/blog/2018/04/13/qt-for-python-is-coming-to-a-computer-near-you/) is becoming official
and [beta python wheels](http://download.qt.io/snapshots/ci/pyside/5.11/latest/pyside2/) are now provided.
### Python Environment
* Python 2 (>= 2.7) or Python 3 (>=3.5)

To install all the requirements for runtime, development and packaging, simply run:
```bash
pip install --index-url=http://download.qt.io/snapshots/ci/pyside/5.11/latest/ pyside2 --trusted-host download.qt.io
```

#### Build Instructions (based on [this guide](https://fredrikaverpil.github.io/2016/08/17/compiling-pyside2/))

Since PySide2 is (not yet) available in Qt installer and no prebuilt binaries are available for Qt 5.10,
you'll need to build it from source. The build procedure is quite similar on all platforms.

Pre-requisites:
* [Python 2.7](https://www.python.org/)
* [Qt 5.10](http://download.qt.io/official_releases/online_installers/)
* [llvm/libclang](http://download.qt.io/development_releases/prebuilt/libclang/)
* [CMake](https://cmake.org/download/)

##### Procedure
This procedure directly installs PySide as a package of the Python used for calling the setup script.
Make sure to use virtualenv if you want to keep this in a separate Python environment.

To simplify the build process, you can add 'bin' folders of cmake, llvm and qt in your PATH.
Alternatively, paths to binaries can be explicitely set when calling the setup.py script (as shown below).

```
# With {libclang}/bin in PATH
# /!\ branch 5.10 does not exist yet, but branch 5.9 is compatible with Qt-5.10
git clone --recursive --branch 5.9 https://codereview.qt-project.org/pyside/pyside-setup
cd pyside-setup
python setup.py --ignore-git install --cmake=/path/to/cmake --qmake=/path/to/qmake
pip install -r requirements.txt -r dev_requirements.txt
```
> Node: `dev_requirements` is only related to testing and packaging. It is not mandatory to run Meshroom.
### Qt Plugins
Additional Qt plugins can be built to extend Meshroom UI features. They can be found on separate repositories,
Expand All @@ -68,4 +39,3 @@ Adds support for Alembic file loading in Meshroom's 3D viewport. Allows to visua

#### [QtOIIO](https://github.com/alicevision/QtOIIO)
Use OpenImageIO as backend to load images in Qt. Allow to visualize RAW/EXR images in Meshroom.

9 changes: 5 additions & 4 deletions README.md
@@ -1,12 +1,13 @@
# ![Meshroom - 3D Reconstruction Sofware](/docs/logo/banner-meshroom.png)
# ![Meshroom - 3D Reconstruction Software](/docs/logo/banner-meshroom.png)

Meshroom is a free, open-source 3D Reconstruction Software based on the [AliceVision](https://github.com/alicevision/AliceVision) framework.

Learn more details about the pipeline on [AliceVision website](http://alicevision.github.io).

See [results of the pipeline on sketchfab](http://sketchfab.com/AliceVision).


Continous integration:
* Windows: [![Build status](https://ci.appveyor.com/api/projects/status/25sd7lfr3v0rnvni/branch/develop?svg=true)](https://ci.appveyor.com/project/AliceVision/meshroom/branch/develop)
## Photogrammetry

Photogrammetry is the science of making measurements from photographs.
Expand All @@ -26,13 +27,13 @@ The project is released under MPLv2, see [**COPYING.md**](COPYING.md).

See [**INSTALL.md**](INSTALL.md) to setup the project and pre-requisites.

Get the source code:
Get the source code and install runtime requirements:
```bash
git clone --recursive git://github.com/alicevision/meshroom
cd meshroom
pip install -r requirements.txt
```


## Start Meshroom

You need to have [AliceVision](https://github.com/alicevision/AliceVision) installation in your PATH and LD_LIBRARY_PATH.
Expand Down
4 changes: 2 additions & 2 deletions appveyor.yml
Expand Up @@ -6,9 +6,9 @@ environment:

install:
- "set PATH=%PYTHON%;%PYTHON%\\Scripts;%PATH%"
- "pip install -r requirements.txt"
- "pip install -r requirements.txt -r dev_requirements.txt"

build: off

test_script:
- "pytest tests/"
- "pytest tests/"
5 changes: 5 additions & 0 deletions dev_requirements.txt
@@ -0,0 +1,5 @@
# packaging
cx_Freeze

# testing
pytest
6 changes: 0 additions & 6 deletions requirements.txt
@@ -1,9 +1,3 @@
# packaging
cx_Freeze

# testing
pytest

# runtime
psutil
enum34;python_version<"3.4"
Expand Down

0 comments on commit 1a1251a

Please sign in to comment.