Much of Opticks functionality can still be used on machines without an NVIDIA GPU by using Geant4 for simulation and OpenGL for visualization.
However to benefit from huge speedup factors requires an NVIDIA GPU with compute capability of 3.0 or better (Kepler, Maxwell or Pascal architectures).
Opticks installation uses the bash shell. The Windows bash shell that comes with the git-for-windows project was used for this purpose
Despite lack of an CUDA capable GPU, the OpenGL Opticks visualization was found to operate successfully.
Opticks uses GLSL shaders with version 400, corresponding to at least OpenGL 4.0
OpenGL versions supported by various systems are listed at the below links.
Clone the repository from bitbucket:
hg clone http://bitbucket.org/simoncblyth/opticks
Connect the opticks bash functions to your shell by adding a line to your .bash_profile and configure the location of the install with the LOCAL_BASE environment variable:
opticks-(){ . $HOME/opticks/opticks.bash && opticks-env $* ; }
export LOCAL_BASE=/usr/local
The first line defines the bash function opticks- that is termed a precursor function as running it will define other functions all starting with opticks- such as opticks-vi and opticks-usage.
Getting, configuring, unpacking, building and installing Opticks and its externals requires unix tools including:
A rather recent cmake version is required. Check your version with:
simon:~ blyth$ cmake --version
cmake version 3.4.1
Updating build tools is best done via your system package manager. For example on OSX with macports update cmake with:
port info cmake # check the version the package manager proposes
sudo port install cmake # do the install
If you or your system administrator are unable to update a tool via the system package manager then a local install of the tool must be done and your login shell PATH modified to use the updated tool. The Opticks repository includes bash functions for local installs of cmake with precursor function cmake-.
Assuming appropriate build tools and Boost, CUDA (includes Thrust) and OptiX are already installed the getting, building and installation of the other externals takes less then 10 minutes and the Opticks build takes less than 5 minutes.:
simon:env blyth$ opticks-fullclean | sh ## deletes dirs beneath $LOCAL_BASE/opticks
simon:env blyth$ opticks- ; opticks-full
Use the bash function opticks-externals-install:
opticks-externals-install
This gets the repositories or tarballs and perform the builds and installation. Tools like hg, git, curl, tar, zip are assumed to be in your PATH.
| precursor | pkg name | notes |
|---|---|---|
| glm- | GLM | OpenGL mathematics, 3D transforms |
| assimp- | Assimp | Assimp 3D asset importer, my fork that handles G4DAE extras |
| openmesh- | OpenMesh | basis for mesh navigation and fixing |
| glew- | GLEW | OpenGL extensions loading library, cmake build didnt work, includes vc12 sln for windows |
| glfw- | GLFW | Interface between system and OpenGL, creating windows and receiving input |
| gleq- | GLEQ | Keyboard event handling header from GLFW author, header only |
| imgui- | ImGui | OpenGL immediate mode GUI, depends on glfw and glew |
| plog- | PLog | Header only logging, supporting multi dll logging on windows |
| opticksdata- | Dayabay G4DAE and GDML geometry files for testing Opticks |
The pre-requisite Boost components listed in the table need to be installed. These are widely available via package managers. Use the standard one for your system:
The FindBoost.cmake provided with cmake is used to locate the installation.
| directory | precursor | pkg name | notes |
|---|---|---|---|
| boost | boost- | Boost | components: system thread program_options log log_setup filesystem regex |
If your version of Boost is not recent enough the cmake configuring step will yield errors like the below.:
CMake Error at /home/blyth/local/env/tools/cmake/cmake-3.5.2-Linux-x86_64/share/cmake-3.5/Modules/FindBoost.cmake:1657 (message):
Unable to find the requested Boost libraries.
Boost version: 1.41.0
If possible use your system package manager to update Boost. If that is not possible then do a local Boost install. Opticks includes bash functions starting boost- that can get and install Boost locally.
opticks-
boost-
opticks-configure -DBOOST_ROOT=$(boost-prefix)
CMake is used to configure Opticks and generate Makefiles or Visual Studio solution files on windows. For a visualization only build with system Boost the defaults should work OK and there is no need to explicitly configure. If a local Boost was required then:
opticks-configure -DBOOST_ROOT=$(boost-prefix)
For a full build with CUDA and OptiX configure with:
opticks-configure -DCUDA_TOOLKIT_ROOT_DIR=/Developer/NVIDIA/CUDA-7.0 \
-DOptiX_INSTALL_DIR=/Developer/OptiX \
-DCOMPUTE_CAPABILITY=52 \
-DBOOST_ROOT=$(boost-prefix)
The argument -DCOMPUTE_CAPABILITY=52 specifies to compile for compute capability 5.2 architectures corresponding to Maxwell 2nd generation GPUs. Lookup the appropriate capability for your GPU in the below short table.
| Compute Capability | Architecture | GPU Examples |
|---|---|---|
| 2.1 | Fermi | NOT SUPPORTED BY OPTICKS |
| 3.0 | Kepler | GeForce GT 750M |
| 5.0 | Maxwell 1st generation | Quadro M2000M |
| 5.2 | Maxwell 2nd generation | Quadro M5000 |
| 6.1 | Pascal | GeForce GTX 1080 |
For more complete tables see
Opticks requires a compute capability of at least 3.0, if you have no suitable GPU or would like to test without GPU acceleration use -DCOMPUTE_CAPABILITY=0.
These configuration values are cached in the CMakeCache.txt file in the build directory. These values are not overridden by rebuilding with the opticks– bash function. A subsequent opticks-configure however will wipe the build directory allowing new values to be set.
If the above configuration suceeded for you then you do not need to understand this machinery.
The below commands from the opticks-cmake bash function change directory to the build folder and invokes cmake to generate a configuration cache file and multiple Makefiles.:
opticks-bcd
cmake \
-DCMAKE_BUILD_TYPE=Debug \
-DCMAKE_INSTALL_PREFIX=$(opticks-prefix) \
-DOptiX_INSTALL_DIR=$(optix-prefix) \
$* \
$(opticks-sdir)
CMake is controlled via CMakeLists.txt files. The top level one includes the below lines that locate the CUDA and OptiX:
set(OPTICKS_CUDA_VERSION 5.5)
set(OPTICKS_OPTIX_VERSION 3.5)
...
find_package(CUDA ${OPTICKS_CUDA_VERSION})
find_package(OptiX ${OPTICKS_OPTIX_VERSION})
To build Opticks run:
opticks-
opticks-full
After the first full build, faster update builds can be done with:
opticks--
Full Opticks functionality with GPU simulation of optical photons requires all the above externals to be installed, however if your GPU is not able to run OptiX or the CUDA related externals have not been installed it is still possible to make a partial build of Opticks using cmake switch WITH_OPTIX=OFF. The partial mode provides OpenGL visualizations of geometry and photon propagations loaded from file.
The opticks-ctest functions runs ctests for all the opticks projects:
simon:opticks blyth$ opticks-
simon:opticks blyth$ opticks-ctest
Test project /usr/local/opticks/build
Start 1: SysRapTest.SEnvTest
1/65 Test #1: SysRapTest.SEnvTest ........................ Passed 0.00 sec
Start 2: SysRapTest.SSysTest
2/65 Test #2: SysRapTest.SSysTest ........................ Passed 0.00 sec
Start 3: SysRapTest.SDigestTest
3/65 Test #3: SysRapTest.SDigestTest ..................... Passed 0.00 sec
.....
.....
Start 59: cfg4Test.CPropLibTest
59/65 Test #59: cfg4Test.CPropLibTest ...................... Passed 0.05 sec
Start 60: cfg4Test.CTestDetectorTest
60/65 Test #60: cfg4Test.CTestDetectorTest ................. Passed 0.04 sec
Start 61: cfg4Test.CGDMLDetectorTest
61/65 Test #61: cfg4Test.CGDMLDetectorTest ................. Passed 0.45 sec
Start 62: cfg4Test.CG4Test
62/65 Test #62: cfg4Test.CG4Test ........................... Passed 5.06 sec
Start 63: cfg4Test.G4MaterialTest
63/65 Test #63: cfg4Test.G4MaterialTest .................... Passed 0.02 sec
Start 64: cfg4Test.G4StringTest
64/65 Test #64: cfg4Test.G4StringTest ...................... Passed 0.02 sec
Start 65: cfg4Test.G4BoxTest
65/65 Test #65: cfg4Test.G4BoxTest ......................... Passed 0.02 sec
100% tests passed, 0 tests failed out of 65
Total Test time (real) = 59.89 sec
opticks-ctest : use -V to show output
Some tests depend on the geometry cache being present. To create the geometry cache:
op.sh -G
All Opticks executables including the tests are installed into $LOCAL_BASE/opticks/lib/ an example .bash_profile to is provided below:
# .bash_profile
if [ -f ~/.bashrc ]; then ## typical setup
. ~/.bashrc
fi
export LOCAL_BASE=$HOME/local ## opticks hookup is needed by all Opticks users
export OPTICKS_HOME=$HOME/opticks
opticks-(){ [ -r $HOME/opticks/opticks.bash ] && . $HOME/opticks/opticks.bash && opticks-env $* ; }
opticks- ## defines several bash functions beginning opticks- eg opticks-info
o(){ cd $(opticks-home) ; hg st ; }
op(){ op.sh $* ; }
PATH=$OPTICKS_HOME/bin:$LOCAL_BASE/opticks/lib:$PATH ## easy access to scripts and executables
export PATH