gammasimtools 0.31.0

Tools for the Simulation System of the CTA Observatory

simtools

simtools is a modular toolkit for managing simulation model parameters, configuring, running, and validating simulation productions for arrays of imaging atmospheric Cherenkov telescopes.

Documentation: simtools documentation

simtools is part of the SimPipe pipeline of the Cherenkov Telescope Array Observatory (CTAO).

Authors: see the CITATION.cff file. Contributors: see the Contributors page.

Note simtools is under active development. Contact the developers before using it: [e-mail]

Features

• Simulation model libraries and management
• Database interfaces for simulation model parameters (see CTAO Simulation models)
• Tools for preparing, configuring, running, and validating simulation productions
• Applications for deriving and validating model parameters (see CTAO Model setting and validation workflows)
• Standardized interfaces and outputs independent of the simulation software (e.g., CORSIKA air shower simulations and sim_telarray telescope simulations)
• I/O and reporting tools for the simulation model and production database

Quick Start

For users:

pip install gammasimtools

Copy .env_template to .env and update the file to set up your environment.

For developers:

git clone https://github.com/gammasim/simtools.git
cd simtools
python3 -m venv .venv
source .venv/bin/activate
pip install -e '.[tests,dev,doc]'

Citing this Software

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

Software Quality

Generative AI disclosure

Generative AI tools (including, but not limited to, Claude, ChatGPT, and Gemini) were used to assist with code development, debugging, and documentation drafting. All AI-assisted outputs were reviewed, validated, and, where necessary, modified by the authors to ensure accuracy and reliability.

Acknowledgements

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