Skip to content

Commit

Permalink
Update README.md (#127)
Browse files Browse the repository at this point in the history
* Update README.md
  • Loading branch information
alxvth authored Sep 17, 2024
1 parent f67feab commit ebe9d9a
Showing 1 changed file with 3 additions and 3 deletions.
6 changes: 3 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,14 +18,14 @@ This project builds two plugins which wrap the functionality of the [HDILib](htt
## Compilation with a locally built HDILib
By default, during the cmake configuration, a pre-built version of HDILib will be downloaded.
You might want to compile the [HDILib](https://github.com/biovault/HDILib) locally instead.
To use this locally compiled library, set the cmake variable `USE_ARTIFACTORY_LIBS` to `OFF` and provide `HDILIB_ROOT`, e.g. `PATH_TO_HDILib_install\lib\cmake\HDILib` for cmake to find the HDILib binaries.
To use this locally compiled library, set the cmake variable `MV_SNE_USE_ARTIFACTORY_LIBS` to `OFF` and provide `HDILIB_ROOT`, e.g. `PATH_TO_HDILib_install\lib\cmake\HDILib` for cmake to find the HDILib binaries.

On Windows, in order to manage the HDILib dependency [flann](https://github.com/flann-lib/flann), we recommend using [vcpkg](https://github.com/microsoft/vcpkg/). Set up cmake to find pacakges with vcpkg by providing the variables CMAKE_TOOLCHAIN_FILE (`PATH_TO/vcpkg/scripts/buildsystems/vcpkg.cmake`) and VCPKG_TARGET_TRIPLET `x64-windows-static`.
On Windows, in order to manage the HDILib dependency [flann](https://github.com/flann-lib/flann), we recommend using [vcpkg](https://github.com/microsoft/vcpkg/). Set up cmake to find packages with vcpkg by providing the variables CMAKE_TOOLCHAIN_FILE (`PATH_TO/vcpkg/scripts/buildsystems/vcpkg.cmake`) and VCPKG_TARGET_TRIPLET `x64-windows-static-md`. See the [HDILib](https://github.com/biovault/HDILib) Readme for more details.

Tested with Ubuntu 22.10, gcc 12.2.0:
```bash
# In your local t-SNE analysis plugin folder
cmake -S . -B build -DCMAKE_BUILD_TYPE=Release -DUSE_ARTIFACTORY_LIBS=OFF -DHDILIB_ROOT=/PATH/TO/YOUR/LOCALHDILIB -DManiVault_DIR=/PATH/TO/MANIVAULT
cmake -S . -B build -DCMAKE_BUILD_TYPE=Release -DMV_SNE_USE_ARTIFACTORY_LIBS=OFF -DHDILIB_ROOT=/PATH/TO/YOUR/LOCALHDILIB -DManiVault_DIR=/PATH/TO/MANIVAULT
cmake --build build --config Release --target install
```

Expand Down

0 comments on commit ebe9d9a

Please sign in to comment.