https://github.com/niess/calzone
A Geant4 Python wrapper for the simulation of outdoor particle detectors
https://github.com/niess/calzone
geant4 monte-carlo python
Last synced: about 1 year ago
JSON representation
A Geant4 Python wrapper for the simulation of outdoor particle detectors
- Host: GitHub
- URL: https://github.com/niess/calzone
- Owner: niess
- License: lgpl-3.0
- Created: 2024-08-20T14:40:02.000Z (almost 2 years ago)
- Default Branch: master
- Last Pushed: 2024-12-17T10:35:59.000Z (over 1 year ago)
- Last Synced: 2025-04-15T00:11:27.096Z (about 1 year ago)
- Topics: geant4, monte-carlo, python
- Language: Rust
- Homepage: https://calzone.readthedocs.io/en/latest/
- Size: 1.31 MB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: COPYING.LESSER
Awesome Lists containing this project
README
# Calzone 
[![][RTD_BADGE]][RTD]
Calzone (**CAL**orimeter **ZONE**) is a Python package built on top of
[Geant4][Geant4]. It was developed in the context of geosciences with the
objective of studying the emission of radioactivity from volcanoes [(Terray et
al., 2020)][TGV+20], and in particular to simulate the response of gamma
spectrometers deployed in the field. To this end, Calzone was developed in
conjunction with [Goupil][GOUPIL] [(Niess et al., 2024)][NVT24], a backward
gamma transport engine, and is interoperable with the latter. Yet, both packages
can be used entirely independently, if necessary.
Please refer to the online [documentation][RTD] for further information.
## Installation
Binary distributions of Calzone are available from [PyPI][PyPI], for Linux
`x86_64`, e.g. as
```bash
pip3 install calzone
```
Alternatively, in order to build Calzone from the source, a working
[Geant4][Geant4] installation is required. Please refer to the corresponding
[documentation][RTD_INSTALLATION] entry for further instructions.
## License
The Calzone source is distributed under the **GNU LGPLv3** license. See the
provided [LICENSE][LICENSE] and [COPYING.LESSER][COPYING.LESSER] files.
Additionaly, Calzone uses software developed by Members of the [Geant4][Geant4]
Collaboration, which is under a [specific license][G4_LICENSE].
[COPYING.LESSER]: https://github.com/niess/calzone/blob/master/COPYING.LESSER
[JSON]: https://www.json.org/json-en.html
[Geant4]: http://cern.ch/geant4
[Goupil]: https://github.com/niess/goupil
[G4_LICENSE]: https://geant4.web.cern.ch/download/license#license
[LICENSE]: https://github.com/niess/calzone/blob/master/LICENSE
[NVT24]: https://doi.org/10.48550/arXiv.2412.02414
[PyPI]: https://pypi.org/project/calzone/
[RTD]: https://calzone.readthedocs.io/en/latest/?badge=latest
[RTD_BADGE]: https://readthedocs.org/projects/calzone/badge/?version=latest
[RTD_INSTALLATION]: https://calzone.readthedocs.io/en/latest/installation.html
[TGV+20]: https://doi.org/10.1029/2019JB019149
[TOML]: https://toml.io/en/
[YAML]: https://yaml.org/