search

fcs-proj / FastCaloSim

An experiment-independent library for fast calorimeter simulation
Apache License 2.0
3 stars 1 forks source link

readme

FastCaloSim

Checks Release Coverage Doxygen Documentation License Contributor Covenant

FastCaloSim is an experiment-independent toolkit for the fast parametrised and ML-based simulation of electromagnetic and hadronic showers in (high energy) physics experiments implemented in C++.

Quick Start

FastCaloSim is developed in C++ and is build using CMake. The following commands will clone the repository, configure, and build the library

git clone https://github.com/fcs-proj/FastCaloSim <source>
cmake -B <build> -S <source> -D CMAKE_BUILD_TYPE=Release
cmake --build <build>

For install options and instruction on how to include FastCaloSim in your experiment see the BUILDING document. For advanced developer configuration with presets and other useful information see the HACKING document.

Contributing

See the CONTRIBUTING document.

Authors

Contributors to the FastCaloSim project are listed in the AUTHORS file.

Licensing

The FastCaloSim project is published under the terms of the Apache 2.0 license, except where other licenses apply. A copy of the license can be found in the in the LICENSE file or at https://www.apache.org/licenses/LICENSE-2.0