Skip to content

gammasim/simtools

Repository files navigation

simtools

LICENSE release DOI

conda pypyi

CI CI-integrationtest CI-docs

Quality Coverage Coverage Quality Gate Status

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

simtools provides:

  • libraries for simulation model definition and management
  • model database interfaces
  • 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:

:::{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

Installation for users

Install simtools with pypi:

pip install gammasimtools

or using conda/mamba:

conda env create -n gammasimtools
conda install gammasimtools --channel conda-forge
conda activate gammasimtools

See the user's guide for more details.

Installation for developers

Install simtools from GitHub with conda/mamba:

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

See the developer's guide for more details.

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 is 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/).