chromo 0.10.1
Hadronic Interaction Model interface in Python
License: BSD 3-Clause License
Requires Python: >=3.9

# ![](doc/chromo.svg)<br> Cosmic ray and HadROnic interactiOn MOnte-carlo frontend

[![DOI](https://zenodo.org/badge/DOI/10.5281/zenodo.16562752.svg)](https://doi.org/10.5281/zenodo.16562752)

This package provides a simple and generic user interface to popular event generators used in cosmic ray and high-energy particle physics. By removing the need for complicated Fortran-style interfaces, ASCII input cards, and C++ dependencies, the package simplifies the simulation of particle interactions, making it easier and faster for a wider audience to access.

## Usage

### Python user interface

To simulate interactions with one of the supported event generators, import the package and define the parameters of the collision. Then, create an instance of an event generator, and generate events.

```python
import numpy as np
import chromo

# Define the parameters of the collisions
kinematics = chromo.kinematics.CenterOfMass(
    13 * chromo.constants.TeV,
    "proton", "proton")
# Create an instance of an event generator
generator = chromo.models.Sibyll23d(kinematics)

nevents = 0
average_pt = 0

# Generate 10000 events
for event in generator(10000):
    # Filter event
    event = event.final_state_charged()
    # do something with event.pid, event.eta, event.en, event.pt, etc.
    # these variables are numpy arrays, that can be histogrammed or counted like
    pt = event.pt[np.abs(event.pid) == 211]
    # The list could be empty
    if len(pt) > 0:
        nevents += 1
        average_pt += np.mean(pt)

average_pt = average_pt / nevents
print("Average pT for charged pions {0:4.3f}".format(average_pt))
```

Further examples, such as [this](examples/compare_models.ipynb) can be found in the examples folder.

### Command line user interface (CLI) 

Installing `chromo` also makes a command-line interface available. If your Python runtime environment is properly set up, you can do

     chromo --help

To see the help of the command-line interface. If that does not work, just replace `chromo` with `python -m chromo`. The command-line interface was designed to feel familiar for users of [CRMC](https://gitlab.iap.kit.edu/AirShowerPhysics/crmc). The CLI can write events in a variety of output formats, as detailed below. HepMC output can be piped into RIVET and many other tools supporting the format.

## Output formats

- HepMC (via pyhepmc, optionally gzip compressed)
- ROOT (via uproot)
- SVG images of events (via pyhepmc package)

## Supported models and how to cite them

Please note that `chromo` only provides a user interface for the following models, and does not contain any particle physics models itself. When using any of these models in public-facing work, it is important to properly cite the original model reference by following the links below. Additionally, if you find `chromo` useful in your work, we would appreciate an acknowledgement, footnote, or link to `chromo`.

| Interaction model                                         | Supported proj/targ       | Comment                         | 
|------------------------------------------------------------|---------------------------|--------------------------------|
| [DPMJET-III 3.0.7](https://inspirehep.net/literature/538940) & [PHOJET 1.12-36](https://inspirehep.net/literature/373339)      | *hN, γγ, γN, hA, γA, AA*  | |
| [DPMJET-III & PHOJET 19.1 and 19.3](https://inspirehep.net/literature/1503512) [(repo on GitHub)](https://github.com/DPMJET/DPMJET) |  *hN, γγ, γN, hA, γA, AA* | |
| [EPOS-LHC](https://inspirehep.net/literature/1236629)     | *hN, hA, AA*              | |
| [EPOS-LHC-R](https://inspirehep.net/literature/2680791)     | *hN, hA, AA*              | |
| [EPOS-LHC-R (w/ hadr. rescattering)](https://inspirehep.net/literature/2680791)     | *hN, hA, AA*              | | Version with explicit hadronic rescattering in UrQMD (slow!)
| [PYTHIA 6.4](https://inspirehep.net/literature/712925)    | *hN, ee, γγ, γN*          | |
| [PYTHIA 8.3](https://inspirehep.net/literature/2056998) (https://pythia.org/) | *hN, ee, γγ, γN* & *hA, AA* (Argantyr) | unavailable on Windows |
| [QGSJet-01](https://inspirehep.net/literature/460408)     | *hN, hA, AA*              | |
| [QGSJet-II-03](https://inspirehep.net/literature/667881)  | *hN, hA, AA*              | |
| [QGSJet-II-04](https://inspirehep.net/literature/872658)  | *hN, hA, AA*              | |
| [QGSJet-III](https://inspirehep.net/literature/2771416)   | *hN, hA, AA*              | |
| [SIBYLL-2.1](https://inspirehep.net/literature/823839)    | *hN, hA (A<=20)*          | |
| [SIBYLL-2.3c/d/e](https://inspirehep.net/literature/1768983)  | *hN, hA (A<=20)*          | incl. legacy versions 2.3 can be build from source |
| [SIBYLL* (based on 2.3d and 2.3e)](https://inspirehep.net/literature/2774307)      | *hN, hA (A<=20)*          |  |
| [SOPHIA 2.0](https://inspirehep.net/literature/497602)    | *γN*                      | |
| [UrQMD 3.4](https://inspirehep.net/literature/468266) [+ second citation](https://inspirehep.net/literature/507334)    |  hN, hA, AA* | unavailable on Windows |


*h* = hadron, *N* = nucleon (p or n), *A* = nucleus, *γ* = photon, *e* = electron/positron

## Installation via PyPI

### Supported platforms

- Python 3.9+
- Linux, Mac OS X (x86 and M1/M2), Windows

The recommended way to install `chromo` is by using the pre-compiled binary wheel, which is available for most common architectures and Python versions

    pip install chromo

Advanced and developer installation instructions can be found [here](doc/dev_docs.md).

## Citation

If you use `chromo` in your research, please cite it using the following DOI:

[![DOI](https://zenodo.org/badge/DOI/10.5281/zenodo.16562752.svg)](https://doi.org/10.5281/zenodo.16562752)

You can also cite it in your bibliography as:

```
Fedynitch, A., Dembinski, H., Prosekin, A., El Hadri, S., & Watanabe, K. (2025). 
CHROMO: Cosmic ray and HadROnic interactiOn MOnte-carlo frontend. 
Zenodo. https://doi.org/10.5281/zenodo.16562752
```

## Authors

- Anatoli Fedynitch
- Hans Dembinski
- Anton Prosekin
- Sonia El Hadri
- Keito Watanabe

## LICENSE

The source code of chromo is licensed under the [BSD 3-clause license (see LICENSE for detail)](LICENSE). The source codes of the event generators are individually licensed under different conditions (see the COPYING files located in the subdirectories).