Quick Start

To get the source code for esi-g4ox, download or clone the repository from GitHub. If you have the code in your $HOME directory and prefer not to install all external dependencies manually, you can use esi-shell for development. The following command mounts your $HOME inside the container:

esi-shell -- -v $HOME -e HOME=$HOME -w $HOME -u $(id -u ${USER}):$(id -g ${USER})

Once inside the container, run the following commands:

cd $HOME
cmake -S esi-g4ox -B build
cmake --build build

To run a test that generates a NumPy file (out/photons.npy) with the simulated photons, execute:

./build/src/simtox

Similarly, to start a Geant4-based simulation of optical photons, run:

./build/src/simg4ox

Before runnning simg4ox it is recommended to set the following environment variables:

export TMP=/tmp/myname
export GEOM=mygeom
export OPTICKS_EVENT_MODE=DebugLite