FastCaloSim
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.
Development in Containers
We recommend using Docker containers for FastCaloSim development. We provide two official containers with all necessary dependencies pre-installed:
- AlmaLinux 9 based:
fcsproj/fastcalosim-alma9 - Ubuntu 24.04 based:
fcsproj/fastcalosim-ubuntu24
Both containers support x86_64 (Intel/AMD) and ARM64 (Apple Silicon) architectures, ensuring consistent development across platforms.
VS Code Integration
When using VS Code with the DevContainer extension, containers are automatically pulled and configured when you open the repository, providing a complete development environment with all tools pre-configured.
LXPLUS Development with Apptainer
For development on LXPLUS, you can use our Docker containers via Apptainer. We provide an apptainer.sh script in the repository that contains the necessary command:
# Run using the provided script source apptainer.sh
Contributing
See the CONTRIBUTING document.
Authors
Contributors to the FastCaloSim project are listed in the [AUTHORS](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](LICENSE) file or at https:/