Metadata-Version: 2.1
Name: FluxComp
Version: 0.1.3
Summary: (ensator) provides numpy and pandas compatible implemenntations of cosmic ray flux models as well as calculation for simulation weights.
Home-page: https://github.com/The-Ludwig/FluxComp
Author-Email: Ludwig Neste <ludwig.neste@fysik.su.se>
License: MIT
Project-URL: Homepage, https://github.com/The-Ludwig/FluxComp
Project-URL: Repository, https://github.com/The-Ludwig/FluxComp
Project-URL: Documentation, https://fluxcomp.readthedocs.io/en/latest/
Requires-Python: <3.12,>=3.8
Requires-Dist: numpy<2.0.0,>=1.23.4
Requires-Dist: pandas<3.0.0,>=2.0.0
Requires-Dist: particle<1.0.0,>=0.21.0
Requires-Dist: scipy<2.0.0,>=1.10.1
Description-Content-Type: text/markdown

<img src="https://raw.github.com/The-Ludwig/FluxComp/main/logo.svg" style="float: left" width="300" alt="The Logo of the FluxComp python package depicting a stylized version of the Flux Capacitor from Back to the Future including a cosmic ray air shower">

[![Read the Docs](https://img.shields.io/readthedocs/fluxcomp?style=for-the-badge)](https://fluxcomp.readthedocs.io/en/latest/)
[![GitHub Workflow Status](https://img.shields.io/github/actions/workflow/status/The-Ludwig/FluxComp/ci.yml?style=for-the-badge)](https://github.com/The-Ludwig/FluxComp/actions/workflows/ci.yml)
[![Codecov](https://img.shields.io/codecov/c/github/The-Ludwig/FluxComp?label=test%20coverage&style=for-the-badge)](https://app.codecov.io/gh/The-Ludwig/FluxComp)
[![PyPI](https://img.shields.io/pypi/v/FluxComp?style=for-the-badge)](https://pypi.org/project/FluxComp/)
[![DOI](https://img.shields.io/badge/DOI-10.5281%20%2F%20zenodo.10210601-blue.svg?style=for-the-badge)](https://doi.org/10.5281/zenodo.10210601)

[![GitHub issues](https://img.shields.io/github/issues-raw/The-Ludwig/FluxComp?style=for-the-badge)](https://github.com/The-Ludwig/FluxComp/issues)
[![GitHub](https://img.shields.io/github/license/The-Ludwig/FluxComp?style=for-the-badge)](https://github.com/The-Ludwig/FluxComp/blob/main/LICENSE)
[![Codestyle](https://img.shields.io/badge/codesyle-Black-black.svg?style=for-the-badge)](https://github.com/psf/black)

A numpy/pandas compatible python package to calculate Cosmic Ray flux models.

This was born out of the [PANAMA](https://github.com/The-Ludwig/PANAMA) python package.

## Installation

```bash
pip install FluxComp
```

## Name

In the German dub of Back to the Future, the Flux Capacitor is translated as the 'Flux Compensator'.
We use cosmic ray flux models to compensate the unphysically distributed simulation fluxes to refer to
a physical model.

<!-- ## Installation -->

<!-- ```bash -->
<!-- pip install fluxcomp -->
<!-- ``` -->
