A number of external dependencies are requried and a complete list can be found here. It's best to use systems libraries on Linux when they are available (via apt, yum, etc.) and build additional libraries on your system. Details are left as an exercise to the reader. On Windows, it is suggested that you use vcpkg to install dependencies.
It is suggested that you use the submodule in Dependencies/vcpkg as it may contain ports which are not yet merged into the main Microsoft repository.
The following commands in cmd.exe will build and install package dependencies.
C:\dev\opticks> git submodule update
Submodule path 'Dependencies/vcpkg': checked out '84303dc1800f72cbca1ccd68cd7051c77e6bea76' <--- NOTE: the hash may be different
C:\dev\opticks> set PATH=C:\dev\opticks\Dependencies\vcpkg;%PATH%
C:\dev\opticks> set VCPKG_DEFAULT_TRIPLET=x64-windows
C:\dev\opticks> Dependencies\vcpkg\boostrap-vcpkg.bat
... <--- Lots of build messages
Building vcpkg.exe... done.
C:\dev\opticks> vcpkg install @Dependencies\vcpkg.list
... <--- Lots of build and install messages. This could take a while.
C:\dev\opticks>
This will install all of the required and optional dependencies in Dependencies\vcpkg\installed. You can now build Opticks with cmake.
You can use pre-built binaries on Windows by connecting to the Opticks Azure Artifacts stream. After bootstrapping vcpkg and before the vcpkg install connect to the stream as below.
C:\dev\opticks> vcpkg fetch nuget
C:\dev\opticks-org\opticks\Dependencies\vcpkg\downloads\tools\nuget-5.5.1-windows\nuget.exe
C:\dev\opticks> C:\dev\opticks-org\opticks\Dependencies\vcpkg\downloads\tools\nuget-5.5.1-windows\nuget.exe sources add -name OpticksDeps -Source https://pkgs.dev.azure.com/Opticks/aca72545-4b50-422e-87bb-6d06eb778bf0/_packaging/dependencies/nuget/v3/index.json
C:\dev\opticks> C:\dev\opticks-org\opticks\Dependencies\vcpkg\downloads\tools\nuget-5.5.1-windows\nuget.exe setapikey MyName -Source OpticksDeps
C:\dev\opticks> set VCPKG_BINARY_SOURCES=nuget,OpticksDeps
Instead of MyName use your machine name, a username, email address, or some other unique-ish key. Run the vcpkg install as above and it will check the artifact repository before building.
You can configure Opticks from the command line with the following commands executed in the Code directory. You must specify the platform to build
64-bit as 32-bit Opticks is no longer supported. On Windows, you may also want to specify the generator name if you have multiple versions of
Visual Studio installed and the default version for cmake is not the correct version. This is the optional -G.
cmake -B Build -S application -A x64 -G "Visual Studio 15 2017"
If you are using vcpkg you should use the vcpkg toolchain integration.
cmake -B Build -S application -DCMAKE_TOOLCHAIN_FILE=C:\dev\opticks\Dependencies\vcpkg\scripts\buildsystems\vcpkg.cmake
If you use cmake-gui with vcpkg you specify the platform and toolchain in the initial configuration dialog. Set x64 for the platform and
the path to the vcpkg.cmake after selecting "Specify toolchain file for cross-compiling."
There is an Install target (a project on Windows or "make install" on Linux) which preps an install tree. The standard build directory can be used as-is for debugging but the generated binaries contain rpath entries which need to be removed. Building the install target will do this and copy them to an install directory. (can be changed during cmake configuration and defaults to an "install" directory which is a sibling to the build directory) It will also copy the SupportFiles, DefaultSettings, and other items needed for an opticks install. If adds the SDK includes to an "include" directory and the public libs to a "lib" directory.
[Paths] Headers = ../include/qt4 Libraries = ../lib Binaries = ../bin Plugins = ../plugins