ERICCa 0.1.0__tar.gz

ericca-0.1.0/.github/workflows/ci.yml

@@ -0,0 +1,30 @@
+name: CI
+
+on:
+  push:
+    branches: [main, dev]
+  pull_request:
+    branches: [main]
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        python-version: ["3.11", "3.13"]
+
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          fetch-depth: 0  # needed for setuptools_scm version detection
+
+      - name: Set up Python ${{ matrix.python-version }}
+        uses: actions/setup-python@v5
+        with:
+          python-version: ${{ matrix.python-version }}
+
+      - name: Install package and dev dependencies
+        run: pip install -e ".[dev]"
+
+      - name: Run fast tests
+        run: pytest -m "not slow" -v

ericca-0.1.0/.github/workflows/docs.yml

@@ -0,0 +1,49 @@
+name: Docs
+
+on:
+  push:
+    branches: [main]
+
+permissions:
+  contents: read
+  pages: write
+  id-token: write
+
+concurrency:
+  group: pages
+  cancel-in-progress: true
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+
+      - name: Set up Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: "3.11"
+
+      - name: Install package and doc dependencies
+        run: pip install -e ".[docs]"
+
+      - name: Build Sphinx docs
+        run: sphinx-build -b html docs docs/_build/html
+
+      - name: Upload pages artifact
+        uses: actions/upload-pages-artifact@v3
+        with:
+          path: docs/_build/html
+
+  deploy:
+    needs: build
+    runs-on: ubuntu-latest
+    environment:
+      name: github-pages
+      url: ${{ steps.deployment.outputs.page_url }}
+    steps:
+      - name: Deploy to GitHub Pages
+        id: deployment
+        uses: actions/deploy-pages@v4

ericca-0.1.0/.github/workflows/publish.yml

@@ -0,0 +1,47 @@
+name: Publish to PyPI
+
+on:
+  release:
+    types: [published]
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+
+      - name: Set up Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: "3.11"
+
+      - name: Install build tools
+        run: pip install build
+
+      - name: Build wheel and sdist
+        run: python -m build
+
+      - name: Upload distribution artifacts
+        uses: actions/upload-artifact@v4
+        with:
+          name: dist
+          path: dist/
+
+  publish:
+    needs: build
+    runs-on: ubuntu-latest
+    environment: pypi
+    permissions:
+      id-token: write  # required for OIDC trusted publishing
+
+    steps:
+      - name: Download distribution artifacts
+        uses: actions/download-artifact@v4
+        with:
+          name: dist
+          path: dist/
+
+      - name: Publish to PyPI
+        uses: pypa/gh-action-pypi-publish@release/v1

ericca-0.1.0/.gitignore

@@ -0,0 +1,76 @@
+# Python
+__pycache__/
+*.py[cod]
+*$py.class
+*.so
+*.pyd
+
+# Distribution / packaging
+dist/
+build/
+*.egg-info/
+*.egg
+MANIFEST
+.eggs/
+wheels/
+sdist/
+
+# Virtual environments
+.venv/
+venv/
+env/
+ENV/
+.env
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Testing
+.tox/
+.nox/
+.pytest_cache/
+.coverage
+.coverage.*
+htmlcov/
+coverage.xml
+*.cover
+nosetests.xml
+junit*.xml
+
+# Type checkers
+.mypy_cache/
+.dmypy.json
+dmypy.json
+.pytype/
+.pyre/
+
+# Jupyter
+.ipynb_checkpoints/
+*.ipynb_checkpoints
+
+# IDEs
+.vscode/
+.idea/
+*.swp
+*.swo
+*~
+.spyderproject.proj
+.spyproject
+.ropeproject
+
+# macOS
+.DS_Store
+.AppleDouble
+.LSOverride
+
+# Compiled C extensions
+*.c
+*.h.gch
+
+# Profiling
+*.prof
+
+# Documentation builds
+docs/_build/
+site/src/ERICCA/__version__.py

ericca-0.1.0/LICENSE

@@ -0,0 +1,22 @@
+#Example License from https://packaging.python.org/en/latest/tutorials/packaging-projects/
+#We will probably change this later!
+
+Copyright (c) 2026 The Python Packaging Authority
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

ericca-0.1.0/PKG-INFO

@@ -0,0 +1,100 @@
+Metadata-Version: 2.4
+Name: ERICCa
+Version: 0.1.0
+Summary: A nuclear reaction code that calculates nucleus-nucleus reaction cross section in the eikonal framework
+Author: Kyle Godbey
+Author-email: Andrew John Smith <smithan@frib.msu.edu>
+License: #Example License from https://packaging.python.org/en/latest/tutorials/packaging-projects/
+        #We will probably change this later!
+        
+        Copyright (c) 2026 The Python Packaging Authority
+        
+        Permission is hereby granted, free of charge, to any person obtaining a copy
+        of this software and associated documentation files (the "Software"), to deal
+        in the Software without restriction, including without limitation the rights
+        to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+        copies of the Software, and to permit persons to whom the Software is
+        furnished to do so, subject to the following conditions:
+        
+        The above copyright notice and this permission notice shall be included in all
+        copies or substantial portions of the Software.
+        
+        THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+        IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+        FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+        AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+        LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+        OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+        SOFTWARE.
+        
+Classifier: Programming Language :: Python :: 3
+Classifier: Operating System :: OS Independent
+Requires-Python: >=3.11
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: numpy>=2.2.6
+Requires-Dist: scipy>=1.15.3
+Provides-Extra: dev
+Requires-Dist: pytest>=7.0; extra == "dev"
+Requires-Dist: pytest-cov>=4.0; extra == "dev"
+Provides-Extra: docs
+Requires-Dist: sphinx>=7; extra == "docs"
+Requires-Dist: furo; extra == "docs"
+Requires-Dist: sphinx-autodoc-typehints; extra == "docs"
+Dynamic: license-file
+
+
+<p align="center">
+<img src="ERICCa_Logo.png" alt="drawing" width="300" /> 
+</p>
+
+# Eikonal Reaction, density Input, Cross section Calculator (ERICCa)
+
+A reaction code that calculates nucleus-nucleus reaction cross section in the eikonal framework using nuclear densities as inputs.
+
+## quick start
+```
+ pip install ERICCa
+```
+The release versions of the package are hosted at [INSERT]
+
+## Tutorials
+
+Tutorials live in `/tutorials/`.
+
+For the full tutorial use `tutorials/ERICCa_Tutorial.ipynb`.
+For a condensed version use `tutorials/ERICCa_TLDR.ipynb`.
+
+## description
+
+**ERICCa** (Eikonal Reaction, density Input, Cross section Calculator) is a Python package for calculating nucleus-nucleus reaction cross sections within the eikonal approximation framework. The code provides a flexible and robust approach to computing reaction observables by taking nuclear density distributions as direct inputs, allowing for accurate modeling of a wide range of nuclear reactions.
+
+### Key Features
+
+- **Eikonal Framework**: Employs the two-body eikonal framework for fast computation of reaction cross sections
+- **Density-Based Approach**:nuclear density distributions (matter or proton, and neutron densities) as inputs
+- **Accurate Integration**: Implements multi-dimensional numerical integration with adaptive mesh configurations
+- **Validated Results**: Benchmarked against experimental reaction data
+
+### Capabilities
+
+ERICCa can calculate:
+- Reaction cross sections using matter densities and proton and neutron densities as inputs and a profile function
+- Automatic density generation based on rms matter radius and mass number
+- Built-in profile functions for Energies 40-1000 MeV
+The package is designed for experimental nuclear physicists
+
+## contributing, developing, and testing
+
+## citation
+```latex
+@software{Smith_AJ_ERICCa_2026,
+author = {A. J. Smith, K. Godbey, C. Hebborn},
+license = {?},
+month = May,
+title = {{ERICCa}},
+url = {?},
+version = {1.0.0},
+year = {2026}
+}
+```

ericca-0.1.0/README.md

@@ -0,0 +1,55 @@
+
+<p align="center">
+<img src="ERICCa_Logo.png" alt="drawing" width="300" /> 
+</p>
+
+# Eikonal Reaction, density Input, Cross section Calculator (ERICCa)
+
+A reaction code that calculates nucleus-nucleus reaction cross section in the eikonal framework using nuclear densities as inputs.
+
+## quick start
+```
+ pip install ERICCa
+```
+The release versions of the package are hosted at [INSERT]
+
+## Tutorials
+
+Tutorials live in `/tutorials/`.
+
+For the full tutorial use `tutorials/ERICCa_Tutorial.ipynb`.
+For a condensed version use `tutorials/ERICCa_TLDR.ipynb`.
+
+## description
+
+**ERICCa** (Eikonal Reaction, density Input, Cross section Calculator) is a Python package for calculating nucleus-nucleus reaction cross sections within the eikonal approximation framework. The code provides a flexible and robust approach to computing reaction observables by taking nuclear density distributions as direct inputs, allowing for accurate modeling of a wide range of nuclear reactions.
+
+### Key Features
+
+- **Eikonal Framework**: Employs the two-body eikonal framework for fast computation of reaction cross sections
+- **Density-Based Approach**:nuclear density distributions (matter or proton, and neutron densities) as inputs
+- **Accurate Integration**: Implements multi-dimensional numerical integration with adaptive mesh configurations
+- **Validated Results**: Benchmarked against experimental reaction data
+
+### Capabilities
+
+ERICCa can calculate:
+- Reaction cross sections using matter densities and proton and neutron densities as inputs and a profile function
+- Automatic density generation based on rms matter radius and mass number
+- Built-in profile functions for Energies 40-1000 MeV
+The package is designed for experimental nuclear physicists
+
+## contributing, developing, and testing
+
+## citation
+```latex
+@software{Smith_AJ_ERICCa_2026,
+author = {A. J. Smith, K. Godbey, C. Hebborn},
+license = {?},
+month = May,
+title = {{ERICCa}},
+url = {?},
+version = {1.0.0},
+year = {2026}
+}
+```

ericca-0.1.0/docs/api/cross_sections.rst

@@ -0,0 +1,6 @@
+cross\_sections
+===============
+
+.. automodule:: ERICCA.cross_sections
+   :members:
+   :undoc-members: False

ericca-0.1.0/docs/api/density.rst

@@ -0,0 +1,6 @@
+Density
+=======
+
+.. automodule:: ERICCA.density
+   :members:
+   :undoc-members: False

ericca-0.1.0/docs/api/index.rst

@@ -0,0 +1,9 @@
+API Reference
+=============
+
+.. toctree::
+   :maxdepth: 1
+
+   cross_sections
+   density
+   profile_function

ericca-0.1.0/docs/api/profile_function.rst

@@ -0,0 +1,6 @@
+ProfileFunction
+===============
+
+.. automodule:: ERICCA.profile_function
+   :members:
+   :undoc-members: False

ericca-0.1.0/docs/conf.py

@@ -0,0 +1,27 @@
+import os
+import sys
+
+sys.path.insert(0, os.path.abspath("../src"))
+
+project   = "ERICCa"
+copyright = "2026, A. J. Smith, K. Godbey, C. Hebborn"
+author    = "A. J. Smith, K. Godbey, C. Hebborn"
+
+extensions = [
+    "sphinx.ext.autodoc",
+    "sphinx.ext.napoleon",
+    "sphinx.ext.viewcode",
+    "sphinx.ext.mathjax",
+    "sphinx_autodoc_typehints",
+]
+
+autodoc_default_options = {
+    "members": True,
+    "undoc-members": False,
+    "show-inheritance": True,
+}
+
+html_theme = "furo"
+
+napoleon_google_docstring = False
+napoleon_numpy_docstring  = True

ericca-0.1.0/docs/index.rst

@@ -0,0 +1,42 @@
+ERICCa Documentation
+====================
+
+.. toctree::
+   :maxdepth: 2
+   :caption: Contents
+
+   installation
+   api/index
+
+ERICCa is a Python package for calculating nucleus-nucleus reaction cross
+sections in the eikonal framework using optical limit approximation (OLA)
+or modified optical limit (MOL) models.
+
+Quick start
+-----------
+
+.. code-block:: python
+
+   import numpy as np
+   from ERICCA import CrossSection, Density, ProfileFunction
+
+   # Build nuclear densities (two-point Fermi fit)
+   dens = Density()
+   r = np.linspace(0.01, 15, 100)
+   dens.rho_m_2pt_fermi(12, 2.32)       # A=12, rms=2.32 fm
+   rho = dens.rho_m(r)
+
+   # Profile function from tabulated NN parameters at E=325 MeV
+   pf = ProfileFunction(model_type="matter", E=325)
+
+   # Calculate reaction cross section
+   cs = CrossSection()
+   rho_b = cs.dens_b_interpolator(r, rho)
+   sigma = cs.sigma_R_matter(rho_b, rho_b, pf.Gamma, Model="OLA")
+   print(f"sigma_R = {sigma:.1f} mb")
+
+Indices
+-------
+
+* :ref:`genindex`
+* :ref:`modindex`

ericca-0.1.0/docs/installation.rst

@@ -0,0 +1,19 @@
+Installation
+============
+
+From PyPI (once released)::
+
+   pip install ERICCa
+
+Development install from source::
+
+   git clone https://github.com/your-org/ERICCa.git
+   cd ERICCa
+   pip install -e ".[dev]"
+
+Requirements
+------------
+
+* Python >= 3.9
+* numpy >= 2.2.6
+* scipy >= 1.15.3

ericca-0.1.0/pyproject.toml

@@ -0,0 +1,48 @@
+[build-system]
+requires = ["setuptools>=61.0", "setuptools_scm[toml]>=6.2"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "ERICCa"
+authors = [
+  {name="Andrew John Smith", email="smithan@frib.msu.edu"},
+  {name="Kyle Godbey"}
+]
+description = "A nuclear reaction code that calculates nucleus-nucleus reaction cross section in the eikonal framework"
+readme = "README.md"
+license = { file="LICENSE" }
+requires-python = ">=3.11"
+dynamic = ["dependencies", "version"]
+classifiers = [
+    "Programming Language :: Python :: 3",
+    "Operating System :: OS Independent",
+]
+
+[project.optional-dependencies]
+dev = [
+    "pytest>=7.0",
+    "pytest-cov>=4.0",
+]
+docs = [
+    "sphinx>=7",
+    "furo",
+    "sphinx-autodoc-typehints",
+]
+
+[tool.setuptools.packages.find]
+where = ["src"]
+
+[tool.setuptools.package-data]
+ERICCA = ["*.txt"]
+
+[tool.setuptools.dynamic]
+dependencies = {file = ["requirements.txt"]}
+
+[tool.setuptools_scm]
+write_to = "src/ERICCA/__version__.py"
+
+[tool.pytest.ini_options]
+testpaths = ["tests"]
+markers = [
+    "slow: marks tests that run full sigma_R computations (several seconds each)",
+]

ericca-0.1.0/requirements.txt

@@ -0,0 +1,2 @@
+numpy>=2.2.6
+scipy>=1.15.3

ericca-0.1.0/setup.cfg

@@ -0,0 +1,4 @@
+[egg_info]
+tag_build = 
+tag_date = 0
+

ericca-0.1.0/src/ERICCA/__init__.py

@@ -0,0 +1,5 @@
+from .cross_sections import CrossSection
+from .profile_function import ProfileFunction
+from .density import Density
+
+__all__ = ["CrossSection", "ProfileFunction", "Density"]

ericca-0.1.0/src/ERICCA/__version__.py

@@ -0,0 +1,24 @@
+# file generated by vcs-versioning
+# don't change, don't track in version control
+from __future__ import annotations
+
+__all__ = [
+    "__version__",
+    "__version_tuple__",
+    "version",
+    "version_tuple",
+    "__commit_id__",
+    "commit_id",
+]
+
+version: str
+__version__: str
+__version_tuple__: tuple[int | str, ...]
+version_tuple: tuple[int | str, ...]
+commit_id: str | None
+__commit_id__: str | None
+
+__version__ = version = '0.1.0'
+__version_tuple__ = version_tuple = (0, 1, 0)
+
+__commit_id__ = commit_id = 'gd943c8ba7'