Simulation for the Linear Collider (SLIC) Geant4 simulation application
Simulation for the Linear Collider (SLIC) - Geant4 simulation application
## Installation
## Installation
For now the installation is done manually by first building SLIC's dependencies and then the main package. Step-by-step instructions are given below.
SLIC is a C++ application that is built using the standard GCC compiler toolchain and the CMake build generation system.
### Tools
### Required Tools
* gcc 4.8 or greater (prob 4.9 or greater is preferable)
* gcc 4.8 or greater (prob 4.9 or greater is preferable)
* You cannot use the default gcc on RHE6 or similarly old distros so you would need to install one yourself or use a dev toolset.
* You cannot use the default gcc on RHE6 or similarly old distros so you would need to install one yourself or use a dev toolset.
...
@@ -14,20 +14,98 @@ For now the installation is done manually by first building SLIC's dependencies
...
@@ -14,20 +14,98 @@ For now the installation is done manually by first building SLIC's dependencies
### Initial Setup
### Initial Setup
There will be a `build` dir where all the packages are built and configured and an `install` dir where they are installed out of source.
You will create a build directory where all the required packages are configured and compiled.
This structure can be setup as follows:
Create the build directory within your slic project directory:
```
```
cd /scratch
mkdir build
mkdir slic; cd slic
mkdir install; cd install
export install_dir=$PWD
cd ..
mkdir build; cd build
```
```
### Geant4
All build commands will be executed from within this build directory (*not* from the slic project directory).
### Basic Build Instructions
The SLIC build system is able to download and install all dependencies for the project if they are not found on your system.
Start by executing CMake from the build dir:
```
cd slic/build
cmake ..
```
If no directory arguments are provided that point to locally installed packages, you will see a message stating "Some dependencies were not found." This is not an error, but to complete the build you will need to build these dependencies and then rerun CMake so they are resolved.
To build the dependencies, execute the following:
```
make
```
Once this is done, then you need to rerun `cmake ..` from the build directory. If the dependencies all installed successfully, then the message "All dependencies were found." should print. Now you can just type `make; make install` to complete the build using these installed dependencies.
The default installation directory for SLIC and its dependencies is `~/slic` which you can change by providing an argument `-DGLOBAL_INSTALL_DIR=/my/install/dir` to the CMake command.
### Specifying Dependencies
You may also have one or more of SLIC's dependencies installed locally, which you can use in your build by providing CMake with their root directories.
For instance, to use your own Geant4 installation, the command would be something like the following:
Read the help to get an idea of the actual commands that are available.
## Installing Dependencies Manually
This section covers in detail the manual installation of SLIC's dependencies.
These procedures are entirely optional, as running `cmake` without providing paths to pre-installed dependencies will cause them to be installed automatically.
#### Geant4
Download the 10.3.p01 tarball from the Geant4 website and untar it or you may clone a tag from the Geant4 github.
Download the 10.3.p01 tarball from the Geant4 website and untar it or you may clone a tag from the Geant4 github.
