Setup - DigitalHolography/Holovibes GitHub Wiki

Initial setup

  1. Install GIT from here. And install CMake.

  2. Install Visual Studio 2022 from here.

    • The minimum requirements in Components (installable from Visual Studio installer) are the following:

      • Desktop applications in C++

    • The minimum requirements in Individual Components (installable from Visual Studio installer) are the following:

      • C++ AddressSanitizer
      • MSVC vXXX - VS XXXX C++ x64/x86 build tools (Latest)
      • MSVC vXXX - VS XXXX C++ Spectre-mitigated Libs (Latest)

  3. Install CUDA 12.6 from here

  4. Add Paths to PATH Environment Variables:

    • C:\Program Files\Microsoft Visual Studio\2022\Community\Common7\IDE\CommonExtensions\Microsoft\CMake\CMake\bin
    • Depending on your VS version (commonly Community):
      • C:\Program Files\Microsoft Visual Studio\2022\Community\VC\Tools\MSVC\14.41.34120\bin\Hostx64\x64
      • C:\Program Files\Microsoft Visual Studio\2022\Community\VC\Tools\MSVC\14.41.34120\bin\Hostx64\x86 OR
      • C:\Program Files\Microsoft Visual Studio\2022\Professional\VC\Tools\MSVC\14.39.33519\bin\Hostx64\x64
      • C:\Program Files\Microsoft Visual Studio\2022\Professional\VC\Tools\MSVC\14.39.33519\bin\Hostx64\x86
    • C:\Program Files\NVIDIA GPU Computing Toolkit\CUDA\v12.6\bin

  5. Reboot your PC.

  6. Install Python 3.8.10 from here. Ensure to tick Add Python 3.8 to PATH.

  7. Install NSIS from here.

  8. Install Conan 2.7.0:

    $ pip install conan && conan profile detect --force

Building the project

[!NOTE] All commands (except cpack) must be run at the root of the project:

Action Simple command Complete command
Install Dependencies (once) ./dev.py install conan install . --build missing --settings compiler.cppstd=20 --settings build_type=Release
Configure CMake ./dev.py cmake build\generators\conanbuild.bat && cmake --preset conan-release
Building ./dev.py build build\generators\conanbuild.bat && cmake --build --preset conan-release
Running ./dev.py run
Create an Installer (you must be in build/bin) cpack

Troubleshooting

  • 2021-10-04: If you encounter the issue clang_rt.asan_dbg_dynamic-x86_64.dll: cannot open shared object file: No such file or directory. You have to find the file and put it in your PATH or copy it into the build directory for it to work
  • 2021-12-03: If ./dev.py tells you that it cannot find conan or cmake. Please check if it's in your PATH.
  • 2021-12-05: If conan tells you that the XXX/system package needs to be installed. Please install the package XXX manually on your system
  • 2021-12-22: For some reason if you put a real function name like OutputHoloFile::export_compute_settings() in a log statement to be printed the program may segfault with an 0x5 SEH exception.
  • If the app crashes after launch, try removing the app settings from C:\Users\[user]\AppData\Roaming\Holovibes\[version]\*.
  • If the app crashes and tells you that camera configs where not found in the AppData, you can (or):
    • Install the release matching your current version and launch it (it will setup the folder in AppData)
    • Copy the Camera/configs folder and paste its content (except the bfml folder) into %APPDATA%/Holovibes/[version]/cameras_config