Add EPOS LHC-R (#221)

This PR adds EPOS LHC-R event generator to the list of supported models.

There are two flavors, the full (and slow) `class EposLHCR` and the
faster `EposLHCRNoHadrRescattering`.

It's up to debate if any whether the version without hadronic
rescattering should become the baseline or the one with rescattering.

---------

Co-authored-by: Anton Prosekin <[email protected]>
Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>

Author: 3 people

.github/workflows/release.yml

@@ -178,3 +178,51 @@ jobs:
           name: wheel-${{ matrix.py }}-${{ matrix.os }}-${{ matrix.arch }}
 
 
+  sdist:
+    name: source package
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          submodules: true
+
+      - name: Dump GitHub context
+        run: echo '${{ toJSON(github) }}'
+
+      - uses: actions/setup-python@v4
+        name: Install Python
+        with:
+          python-version: '3.12'
+
+      - uses: tlylt/install-graphviz@v1
+        name: Install Graphviz
+
+      - run: python -m pip install --upgrade pip wheel setuptools
+      - run: pipx run build --sdist
+      - run: python -m pip install --prefer-binary -v `echo dist/chromo-*`[test]
+      - run: python -m pytest -v
+
+      - uses: actions/upload-artifact@v4
+        with:
+          path: dist/*.tar.gz
+
+  upload_to_PyPI:
+    name: Upload to PyPI
+    needs: [wheels, sdist]
+    runs-on: ubuntu-latest
+    if: ${{ startsWith(github.ref, 'refs/tags/v') }}
+    steps:
+      - name: Download files in artifact to "dist/" directory
+        uses: actions/[email protected]
+        with:
+          merge-multiple: true
+          path: dist
+
+      - name: Publish package to PyPI
+        uses: pypa/gh-action-pypi-publish@release/v1.8
+        with:
+          user: __token__
+          password: ${{ secrets.PYPI_API_TOKEN }}
+
+
+

AGENTS.md

@@ -63,17 +63,17 @@ Please note that `chromo` only provides a user interface for the following model
 | [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.3d](https://inspirehep.net/literature/1768983)  | *hN, hA (A<=20)*          | incl. legacy versions -2.3/-2.3c |
-| [SIBYLL-2.3e](https://inspirehep.net/literature/1768983)  | *hN, hA (A<=20)*          |  |
-| [SIBYLL* (based on 2.3d)](https://inspirehep.net/literature/2774307)      | *hN, hA (A<=20)*          |  |
-| [SIBYLL* (based on 2.3e)](https://inspirehep.net/literature/2774307)      | *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 |
 
@@ -84,7 +84,7 @@ Please note that `chromo` only provides a user interface for the following model
 
 ### Supported platforms
 
-- Python 3.8+
+- 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

README.md

@@ -42,7 +42,11 @@ thread_dep  = dependency('threads')
 
 # Optional mold linker
 if find_program('mold', required:false).found() and cc.get_id() == 'gcc'
-  add_project_link_arguments('-fuse-ld=mold', language:['c','cpp','fortran'])
+ add_project_link_arguments('-fuse-ld=mold', language:['c','cpp','fortran'])
+endif
+
+if get_option('buildtype') == 'debug'
+  add_global_arguments('-fbacktrace', '-fcheck=all', language : ['fortran']) #'-shared-libasan','-fsanitize=address',
 endif
 
 add_project_arguments('-DNPY_NO_DEPRECATED_API=NPY_1_7_API_VERSION', language:['c','cpp'])
@@ -161,12 +165,22 @@ models = {
 
   # EPOS -----------------------------------------------------------------
   '_eposlhc':{
-    'src'   : run_command(py, scripts_dir + 'list_epos_sources.py', '--directory',
-                          f/'epos', check:true).stdout().strip().split('\n'),
-    'inc'   : [f/'epos/sources'],
-    'iface' : run_command(py,'scripts/list_epos_sources.py','--directory', f/'epos',
+    'src'   : run_command(py, scripts_dir + 'list_eposlhc_sources.py', '--directory',
+                          f/'epos-lhc', check:true).stdout().strip().split('\n'),
+    'inc'   : [f/'epos-lhc/sources'],
+    'iface' : run_command(py,'scripts/list_eposlhc_sources.py','--directory', f/'epos-lhc',
                       '--interface-only', check:true).stdout().strip().split('\n'),
     'funcs' : epos_syms + common_syms,
+    'flags' : ['-O0'],
+  },
+  '_eposlhcr':{
+    'src'   : run_command(py, scripts_dir + 'list_eposlhcr_sources.py', '--directory',
+                          f/'epos-lhc-r', check:true).stdout().strip().split('\n'),
+    'inc'   : [f/'epos-lhc-r/sources'],
+    'iface' : run_command(py,'scripts/list_eposlhcr_sources.py','--directory', f/'epos-lhc-r',
+                      '--interface-only', check:true).stdout().strip().split('\n'),
+    'funcs' : epos_syms + common_syms,
+    'flags' : ['-O0'],
   },
 }
 
@@ -242,12 +256,19 @@ foreach name, cfg : models
               '@OUTDIR@','@INPUT@'],
     build_by_default : true)
 
+  # Override optimization for EPOS models
+  override_opts = []
+  if name in ['_eposlhc', '_eposlhcr']
+    override_opts = ['optimization=0']
+  endif
+
   py.extension_module(name,
     sources            : srcs + [wrap, f2py_obj],
     include_directories: include_directories(inc_dirs),
     dependencies       : [py_dep, numpy_dep],
     c_args             : common_cargs + flags,
     fortran_args       : flags,
+    override_options   : override_opts,
     subdir             : 'chromo/models',
     install            : true,
     install_rpath      : rpath_tok,