Last updated: July 3, 2019
This README gives basic information on how to install NEXTSim from source. For more information on using the program, see the NEXTSim Wiki. For detailed information on changes to the master branch, see the changelog.
- Cory R Thornsberry
- David Pérez Loureiro
- Kyle Schmitt
- Xiadong Zhang
-
Required Prerequisites:
-
Recommended Prerequisites:
- ccmake
- Use
sudo apt-get install cmake-curses-gui
on Ubuntu
- Use
- Environment Modules
- ccmake
-
Optional Prerequisites:
- SimpleScan needed for nextSim output converter
- Build option
-DBUILD_SHARED=ON
is required
- Build option
- SimpleScan needed for nextSim output converter
git clone https://github.com/cthornsb/NEXTSim
cd NEXTSim
mkdir build
cd build
Common NEXTSim install options are shown in the table below
OPTION | DEFAULT | DESCRIPTION |
---|---|---|
CMAKE_INSTALL_PREFIX | install | Set the install prefix |
GEANT4_MT | OFF | Enable or disable multithreading capability |
GEANT4_GDML | OFF | Enable or disable support for loading GDML files |
GEANT4_UIVIS | ON | Enable or disable Geant4 UI and VIS drivers |
BUILD_TOOLS | OFF | Enable tool executables |
BUILD_TOOLS_NISTLIST | OFF | Build NIST database search executable |
BUILD_TOOLS_CONVERTER | OFF | Build NEXTSim -> SimpleScan converter tool |
BUILD_TOOLS_CMDSEARCH | OFF | Build NEXTSim macro command search executable |
Install options may be set using ccmake e.g.
cmake ..
ccmake ..
or by passing options to CMake using the command line e.g.
cmake -DCMAKE_INSTALL_PREFIX=/path/to/install -DBUILD_TOOLS=ON ..
and so forth. Once CMake has successfully generated the makefile, simply type
make install
to compile and install. Experimental/unstable beta versions of the simulation code may be found on the development branch
git checkout dev
cd build
make install
To switch back to the master release,
git checkout master
cd build
make install
By default, cmake will install binaries to
NEXTSim/install/bin
From there you may make symbolic links as required, or if you prefer you may use the NEXTSim module file
To install the NEXTSim module file, the module file must be copied to one of your module paths.
cp install/share/modulefiles/nextSim ${PATH_TO_MODULE_FILES}
Where PATH_TO_MODULE_FILES is dependent upon the configuration of your machine. You can check for the path by typing
module avail
For example, on my machine, the syntax would be
cp install/share/modulefiles/nextSim /usr/share/modules/modulefiles/
Whenever you want to use NEXTSim, load the NEXTSim module by typing
module load nextSim
In the ./NEXTSim/ directory type
git pull
cd build/
make install
Barring a substantial change in the structure of the source code, this should be sufficient for keeping your install up-to-date with the repository.