Metadata-Version: 2.4
Name: gammasimtools
Version: 0.15.0
Summary: Tools for the Simulation System of the CTA Observatory
Author-email: simtools developers <simtools-developer@desy.de>
License: BSD 3-Clause License
        
        Copyright (c) 2020, gammasim-tools, simtools developers
        All rights reserved.
        
        Redistribution and use in source and binary forms, with or without
        modification, are permitted provided that the following conditions are met:
        
        1. Redistributions of source code must retain the above copyright notice, this
           list of conditions and the following disclaimer.
        
        2. Redistributions in binary form must reproduce the above copyright notice,
           this list of conditions and the following disclaimer in the documentation
           and/or other materials provided with the distribution.
        
        3. Neither the name of the copyright holder nor the names of its
           contributors may be used to endorse or promote products derived from
           this software without specific prior written permission.
        
        THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
        AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
        IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
        DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
        FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
        DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
        SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
        CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
        OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
        OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
        
Project-URL: bug tracker, https://github.com/gammasim/simtools/issues
Project-URL: documentation, https://gammasim.github.io/simtools/
Project-URL: repository, https://github.com/gammasim/simtools
Classifier: Intended Audience :: Science/Research
Classifier: License :: OSI Approved :: BSD License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3 :: Only
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Classifier: Topic :: Scientific/Engineering :: Astronomy
Requires-Python: >=3.11
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: astropy
Requires-Dist: boost-histogram
Requires-Dist: ctao-dpps-cosmic-ray-spectra
Requires-Dist: ctapipe
Requires-Dist: eventio
Requires-Dist: jsonschema
Requires-Dist: matplotlib
Requires-Dist: numpy
Requires-Dist: particle
Requires-Dist: pymongo
Requires-Dist: pyproj
Requires-Dist: python-dotenv
Requires-Dist: pyyaml
Requires-Dist: scipy
Requires-Dist: toml
Provides-Extra: dev
Requires-Dist: pre-commit; extra == "dev"
Requires-Dist: pylint; extra == "dev"
Requires-Dist: ruff; extra == "dev"
Provides-Extra: doc
Requires-Dist: myst-parser; extra == "doc"
Requires-Dist: numpydoc; extra == "doc"
Requires-Dist: sphinx; extra == "doc"
Requires-Dist: sphinx-book-theme; extra == "doc"
Requires-Dist: towncrier; extra == "doc"
Provides-Extra: tests
Requires-Dist: pytest; extra == "tests"
Requires-Dist: pytest-cov; extra == "tests"
Requires-Dist: pytest-mock; extra == "tests"
Requires-Dist: pytest-profiling; extra == "tests"
Requires-Dist: pytest-random-order; extra == "tests"
Requires-Dist: pytest-repeat; extra == "tests"
Requires-Dist: pytest-requirements; extra == "tests"
Requires-Dist: pytest-xdist; extra == "tests"
Dynamic: license-file

# simtools

[![LICENSE](https://img.shields.io/badge/License-BSD_3--Clause-blue.svg)](https://github.com/gammasim/simtools/blob/main/LICENSE)
[![release](https://img.shields.io/github/v/release/gammasim/simtools)](https://github.com/gammasim/simtools/releases)
[![DOI](https://zenodo.org/badge/195011575.svg)](https://zenodo.org/badge/latestdoi/195011575)

[![conda](https://anaconda.org/conda-forge/gammasimtools/badges/version.svg)](https://anaconda.org/conda-forge/gammasimtools)
[![pypyi](https://badge.fury.io/py/gammasimtools.svg)](https://badge.fury.io/py/gammasimtools)

[![CI](https://github.com/gammasim/simtools/actions/workflows/CI-unittests.yml/badge.svg)](https://github.com/gammasim/simtools/actions/workflows/CI-unittests.yml)
[![CI-integrationtest](https://github.com/gammasim/simtools/actions/workflows/CI-integrationtests.yml/badge.svg)](https://github.com/gammasim/simtools/actions/workflows/CI-integrationtests.yml)
[![CI-docs](https://github.com/gammasim/simtools/actions/workflows/CI-docs.yml/badge.svg)](https://github.com/gammasim/simtools/actions/workflows/CI-docs.yml)

[![Quality](https://app.codacy.com/project/badge/Grade/a3f19df7454844059341edd0769e02a7)](https://app.codacy.com/gh/gammasim/simtools/dashboard?utm_source=gh&utm_medium=referral&utm_content=&utm_campaign=Badge_grade)
[![Coverage](https://codecov.io/gh/gammasim/simtools/graph/badge.svg?token=AYAIRPARCH)](https://codecov.io/gh/gammasim/simtools)
[![Coverage](https://sonar-cta-dpps.zeuthen.desy.de/api/project_badges/measure?project=gammasim_simtools_AY_ssha9WiFxsX-2oy_w&metric=coverage&token=sqb_ef68b705c0bc7f9800f4ff3f087f1d7f7471ff0e)](https://sonar-cta-dpps.zeuthen.desy.de/dashboard?id=gammasim_simtools_AY_ssha9WiFxsX-2oy_w)
[![Quality Gate Status](https://sonar-cta-dpps.zeuthen.desy.de/api/project_badges/measure?project=gammasim_simtools_AY_ssha9WiFxsX-2oy_w&metric=alert_status&token=sqb_ef68b705c0bc7f9800f4ff3f087f1d7f7471ff0e)](https://sonar-cta-dpps.zeuthen.desy.de/dashboard?id=gammasim_simtools_AY_ssha9WiFxsX-2oy_w)

Simulation tools and applications for the [Cherenkov Telescope Array (CTAO)](https://www.cta-observatory.org).

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](https://www.iap.kit.edu/corsika/), [sim_telarray](https://www.mpi-hd.mpg.de/hfm/~bernlohr/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](https://www.iap.kit.edu/corsika/) air shower simulation code and the [sim_telarray](https://www.mpi-hd.mpg.de/hfm/~bernlohr/sim_telarray/) telescope simulation code
- [simulation models](https://gitlab.cta-observatory.org/cta-science/simulations/simulation-model/simulation-models)
- [databases](https://gammasim.github.io/simtools/databases.html), 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](mailto:simtools-developer@desy.de).
:::

## Quick start

### Installation for users

Install simtools with pypi:

```bash
pip install gammasimtools
```

or using conda/mamba:

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

See the [user's guide](https://gammasim.github.io/simtools/user-guide/getting_started.html) for more details.

### Installation for developers

Install simtools from GitHub with conda/mamba:

```bash
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](https://gammasim.github.io/simtools/developer-guide/getting_started.html) for more details.

## Authors

- Raul R Prado (DESY)
- Orel Gueta (DESY)
- Eshita Joshi (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](https://doi.org/10.5281/zenodo.6346696) and [CITATION.cff](https://github.com/gammasim/simtools/blob/main/CITATION.cff) .

## Acknowledgements

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