https://github.com/niess/calzone

A Geant4 Python wrapper
https://github.com/niess/calzone

geant4 monte-carlo python

Last synced: 2 months ago
JSON representation

A Geant4 Python wrapper

• Host: GitHub
• URL: https://github.com/niess/calzone
• Owner: niess
• License: lgpl-3.0
• Created: 2024-08-20T14:40:02.000Z (4 months ago)
• Default Branch: master
• Last Pushed: 2024-10-04T09:15:00.000Z (3 months ago)
• Last Synced: 2024-10-04T09:44:39.804Z (3 months ago)
• Topics: geant4, monte-carlo, python
• Language: Rust
• Homepage: https://calzone.readthedocs.io/en/latest/
• Size: 318 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: COPYING.LESSER

Awesome Lists containing this project

README

        
# Calzone

(**CAL**orimeter **ZONE**)

> [!WARNING]

> This is work in progress.

## Description

CalZone is a [Geant4][Geant4] Python wrapper for simulating the energy

deposition by high-energy particles in a calorimeter. The interface has been

designed with simplicity in mind. Primary particles are injected into the

simulation volume as a `numpy.ndarray`, and a `numpy.ndarray` of energy deposits

is returned. The Monte Carlo geometry is encoded in a Python `dict` which can be

loaded from configuration files, e.g. using [JSON][JSON], [TOML][TOML] or

[YAML][YAML] formats. This basic workflow is illustrated below,

```python

import calzone

simulation = calzone.Simulation("geometry.toml")

particles = calzone.particles(10000, energy=0.5, position=(0,0,1))

deposits = simulation.run(particles)

```

## License

The Calzone source is distributed under the **GNU LGPLv3** license. See the

provided [LICENSE](LICENSE) and [COPYING.LESSER](COPYING.LESSER) files.

[JSON]: https://www.json.org/json-en.html

[Geant4]: https://geant4.web.cern.ch/docs/

[TOML]: https://toml.io/en/

[YAML]: https://yaml.org/