Generic simulation framework for pixel detectors based on AllPix.
For more details about the project please have a look at the website at https://cern.ch/allpix-squared.
- ROOT (required, with the GenVector component)
- Geant4 (optional, but required for typical purposes)
- Eigen3 (optional, but required for typical purposes)
The CMake build system is used for compilation and installation. The install directory can be specified by adding -DCMAKE_INSTALL_PREFIX=<prefix> as argument to the CMake command below. Other configuration options are explained in the manual (see the documentation section below).
The dependencies need to be initialized for the build to succeed. Currently there are two methods to load these:
In order to install Allpix2 on the CERN LXPLUS batch cluster, a LXPLUS setup script is provided:
$ source etc/scripts/setup_lxplus.sh
Then, continue as described under the compilation section.
The dependencies listen above have to be satisfied. Both ROOT6 and Geant4 libraries and headers have to be in the path, this is usually achieved by sourcing the thisroot.sh or geant4.sh scripts. After this, continue as described below.
To compile and install a default installation of Allpix2, run the following commands
$ mkdir build && cd build/
$ cmake ..
$ make install
For more detailed installation instructions, please refer to the documentation below.
The most recently published version of the User's Manual is available online here. The Doxygen reference is published online too.
The latest PDF version of the User's Manual can also be created from source by executing
$ make pdf
After running the manual is available under usermanual/allpix-manual.pdf in the build directory.
To build the HTML version of the latest Doxygen reference, run the following command
$ make reference
The main page of the reference can then be found at reference/html/index.html in the build folder.
All type of minor and major contributions are very welcome. Please refer to our contribution guidelines for a description on how to get started.
Before adding changes it is very much recommended to carefully read through the documentation in the User's Manual first.
This software is distributed under the terms of the MIT license. A copy of this license can be found in LICENSE.md.
The documentation is distributed under the terms of the CC-BY-4.0 license. This license can be found in doc/COPYING.md.
The LaTeX and Pandoc CMake modules used by Allpix2 are licensed under the BSD 3-Clause License.
The octree library of the TCAD DF-ISE converter is made available under the MIT license, more information here.