simtools

Simulation tools and applications for the Cherenkov Telescope Array (CTAO).

License: BSD-3

Useful links: Documentation Source code Issue tracker Citation

simtools provides:

• libraries for simulation model definition and management
• model database interface
• tools for the preparation and configuration of simulation productions
• applications for simulation model parameter derivation and validation
• standardized interfaces and data products independent of the underlying simulation software (e.g., CORSIKA, sim_telarray)
• I/O and reporting tools for the MC simulation model parameter and production database

simtools is one part of the CTAO Simulation Pipeline, which consist of the following components:

• CORSIKA air shower simulation code and the sim_telarray telescope simulation code
• workflows for setting, derivation and validation of simulation model parameters
• simulation model parameter
• databases, especially the model parameter database

:::{note} simtools is currently under heavy development with continuous changes and additions planned. Please contact the developers before using it: simtools-developer@desy.de. :::

Quick start

:::{caution} The pip-installation of simtools provides limited functionality only and is not as well tested as the conda/mamba installation. :::

Install simtools with pypi (recommended for users):

pip install gammasimtools

Install simtools with mamba (recommended for developers):

git clone https://github.com/gammasim/simtools.git
cd simtools
mamba env create -f environment.yml
conda activate simtools
pip install -e .

For more detail see the Getting_Started section of the manual.

Authors

• Raul R Prado (DESY)
• Orel Gueta (DESY)
• Tobias Kleiner (DESY)
• Victor B. Martins (DESY)
• Gernot Maier (DESY)

Citing this Software

Please cite this software if it use used for a publication, see the Zenodo record and CITATION.cff .

Acknowledgements

This project is supported by the Deutsche Forschungsgemeinschaft (DFG, German Research Foundation) - project number 460248186 (PUNCH4NFDI https://www.punch4nfdi.de/).