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}
}
```
