[doc] how to use Meshroom without building AliceVision (#1487)

* documentation: how to use Meshroom without building AliceVision
* documentation: explain how to start and debug with PyCharm
* add comments as examples in start.sh
* fix wrong bash and if not in right dir (related with 692ecfa74d (commitcomment-53971206))
This commit is contained in:
Remy Mellet 2021-08-30 19:41:52 +02:00 committed by GitHub
parent 73da16d7a8
commit b1c421bfef
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
2 changed files with 31 additions and 4 deletions

View file

@ -72,7 +72,9 @@ If you use this project for research, please cite:
## Get the project ## Get the project
See [**INSTALL.md**](INSTALL.md) to setup the project and pre-requisites. You can [download pre-compiled binaries for the latest release](https://github.com/alicevision/meshroom/releases).
If you want to build it yourself, see [**INSTALL.md**](INSTALL.md) to setup the project and pre-requisites.
Get the source code and install runtime requirements: Get the source code and install runtime requirements:
```bash ```bash
@ -107,6 +109,22 @@ You may need to adjust the folder `/usr/lib/nvidia-340` with the correct driver
python bin/meshroom_batch --input INPUT_IMAGES_FOLDER --output OUTPUT_FOLDER python bin/meshroom_batch --input INPUT_IMAGES_FOLDER --output OUTPUT_FOLDER
``` ```
## Start Meshroom without building AliceVision
To use Meshroom (ui) without building AliceVision
* Download a [release](https://github.com/alicevision/meshroom/releases)
* Checkout corresponding Meshroom (ui) version/tag to avoid versions incompatibilities
* `LD_LIBRARY_PATH=~/foo/Meshroom-2021.1.0/aliceVision/lib/ PATH=$PATH:~/foo/Meshroom-2021.1.0/aliceVision/bin/ PYTHONPATH=$PWD python3 meshroom/ui`
## Start and Debug Meshroom in an IDE
PyCharm Community is free IDE which can be used. To start and debug a project with that IDE,
right-click on `Meshroom/ui/__main__.py` > `Debug`, then `Edit Configuration`, in `Environment variables` :
* If you want to use aliceVision built by yourself add: `PATH=$PATH:/foo/build/Linux-x86_64/`
* If you want to use aliceVision release add: `LD_LIBRARY_PATH=/foo/Meshroom-2021.1.0/aliceVision/lib/;PATH=$PATH:/foo/Meshroom-2021.1.0/aliceVision/bin/` (Make sure that you are on the branch matching the right version)
![image](https://user-images.githubusercontent.com/937836/127321375-3bf78e73-569d-414a-8649-de0307adf794.png)
## FAQ ## FAQ

15
start.sh Normal file → Executable file
View file

@ -1,3 +1,12 @@
#!/bin/sh #!/bin/bash
export PYTHONPATH="$(dirname "$(readlink -f "${BASH_SOURCE[0]}" )" )" export MESHROOM_ROOT="$(dirname "$(readlink -f "${BASH_SOURCE[0]}" )" )"
python meshroom/ui export PYTHONPATH=$MESHROOM_ROOT:$PYTHONPATH
# using existing alicevision release
#export LD_LIBRARY_PATH=/foo/Meshroom-2021.1.0/aliceVision/lib/
#export PATH=$PATH:/foo/Meshroom-2021.1.0/aliceVision/bin/
# using alicevision built source
#export PATH=$PATH:/foo/build/Linux-x86_64/
python "$MESHROOM_ROOT/meshroom/ui"