Metadata-Version: 2.1
Name: crunchflow
Version: 2.0.5
Summary: A Python toolbox for working with the CrunchFlow reactive transport code
License: GPL-3.0-or-later
Author: Zach Perzan
Author-email: zach.perzan@unlv.edu
Requires-Python: >=3.9,<4.0
Classifier: License :: OSI Approved :: GNU General Public License v3 or later (GPLv3+)
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Requires-Dist: matplotlib (>=3.7.0,<4.0.0)
Requires-Dist: numpy (>=2.0.0,<3.0.0)
Requires-Dist: pandas (>=2.2.2,<3.0.0)
Description-Content-Type: text/markdown

# crunchflow

The Python crunchflow package is a toolbox for working with the CrunchFlow reactive transport model. It can be particularly useful for analyzing and plotting CrunchFlow model output.

## Installation

Use the package manager [pip](https://pip.pypa.io/en/stable/) or 
[conda](https://anaconda.org/anaconda/conda) to install `crunchflow`.

```bash
pip install crunchflow
```
or
```bash
conda install -c conda-forge crunchflow
```

## Usage
Full documentation can be found [here](https://readthedocs.org/projects/python-crunchflow/)

## Citation
If you use the Python `crunchflow` package in published work, please cite the paper for which it 
was originally developed:

Perzan, Z., Babey, T., Caers, J., Bargar, J.R. and Maher, K., 2021, Local and global sensitivity analysis of a reactive 
transport model simulating floodplain redox cycling, *Water Resources Research*, doi: 10.1029/2021WR029723

## Contributing
Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.

Please make sure to update tests as appropriate.

## License
[GPL](https://choosealicense.com/licenses/gpl-3.0/)

