diff --git a/README.md b/README.md index d9e7a5ae..e4bce2fa 100644 --- a/README.md +++ b/README.md @@ -72,7 +72,9 @@ If you use this project for research, please cite: ## 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: ```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 ``` +## 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 diff --git a/start.sh b/start.sh old mode 100644 new mode 100755 index 4e635b2a..a1c6a8fb --- a/start.sh +++ b/start.sh @@ -1,3 +1,12 @@ -#!/bin/sh -export PYTHONPATH="$(dirname "$(readlink -f "${BASH_SOURCE[0]}" )" )" -python meshroom/ui +#!/bin/bash +export MESHROOM_ROOT="$(dirname "$(readlink -f "${BASH_SOURCE[0]}" )" )" +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"