Metadata-Version: 2.1
Name: pyraingen
Version: 0.2.1
Summary: A package for stochastically generating daily and subdaily rainfall in Australia with ifd constraining.
License: None
Author: Caleb Dykman
Requires-Python: >=3.8
Classifier: License :: Other/Proprietary License
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Requires-Dist: matplotlib (>=3.6.2)
Requires-Dist: netCDF4 (>=1.6.2)
Requires-Dist: numba (>=0.56.4)
Requires-Dist: numpy (>=1.23.5)
Requires-Dist: scipy (>=1.9.3)
Description-Content-Type: text/markdown

# pyraingen

A package for stochastically generating daily and subdaily rainfall in Australia with ifd constraining.

## Installation

```bash
$ pip install pyraingen
```

## Usage

`pyraingen` can be used to stochastically generate regionalised daily rainfall, disaggregate daily rainfall to subdaily fragments and constrain generated rainfall to observed or predicted Intensity Frequency Duration (IFD) relationships.
The three main functions are:

```python
from pyraingen.regionaliseddailysim import regionaliseddailysim
from pyraingen.regionalisedsubdailysim import regionalisedsubdailysim
from pyraingen.ifdcond import ifdcond
```

## Contributing

Interested in contributing? Check out the contributing guidelines. Please note that this project is released with a Code of Conduct. By contributing to this project, you agree to abide by its terms.

## License

`pyraingen` was created by Caleb Dykman. Caleb Dykman retains all rights to the source and it may not be reproduced, distributed, or used to create derivative works.

## Credits

`pyraingen` was created with [`cookiecutter`](https://cookiecutter.readthedocs.io/en/latest/) and the `py-pkgs-cookiecutter` [template](https://github.com/py-pkgs/py-pkgs-cookiecutter).

