Metadata-Version: 2.1
Name: hydrogr
Version: 1.1.0
Classifier: Programming Language :: Rust
Classifier: Programming Language :: Python :: Implementation :: CPython
Classifier: Programming Language :: Python :: Implementation :: PyPy
Requires-Dist: numpy>=1.13.3
Requires-Dist: pandas>=0.20.3
Requires-Dist: pytest; extra == 'test'
Provides-Extra: test
License-File: LICENSE.txt
Summary: Hydrogr is a Python package that implement GR hydrological models in Rust
Author-email: SimonDelmas <delmas.simon@gmail.com>
Requires-Python: >=3.7
Description-Content-Type: text/markdown; charset=UTF-8; variant=GFM
Project-URL: homepage, https://github.com/SimonDelmas/hydrogr

[![PyPi version](https://img.shields.io/pypi/v/hydrogr.svg)](https://pypi.python.org/pypi/hydrogr/) 
[![](https://img.shields.io/badge/python-3.7+-blue.svg)](https://www.python.org/downloads/)
![GitHub Actions Workflow Status](https://img.shields.io/github/actions/workflow/status/SimonDelmas/hydrogr/CI.yml)
![GitHub issues](https://img.shields.io/github/issues/SimonDelmas/hydrogr)
![GitHub License](https://img.shields.io/github/license/SimonDelmas/hydrogr)

# HydroGR ![Python](https://img.shields.io/badge/python-3670A0?style=for-the-badge&logo=python&logoColor=ffdd54) ![Rust](https://img.shields.io/badge/rust-%23000000.svg?style=for-the-badge&logo=rust&logoColor=white)

Hydrogr is a python language software package for hydrological modelling, that implement several conceptual rainfall-runoff models (GR4H, GR4J, GR5J, GR6J, GR2M, GR1A).
It is inspired from Irstea R language package: [airGR](https://cran.r-project.org/web/packages/airGR/index.html).

## Getting Started

### Installation

The package can be installed with pip :

```bash
python -m pip install hydrogr
```

Test the installation by importing the package in Python :

```python
import hydrogr
print(hydrogr.__version__)
```

### Examples

Examples based on the examples in the airGR package are available in the [example folder](https://github.com/SimonDelmas/hydrogr/tree/master/example) for the different models.

An example for calibrating models using [spotpy](https://github.com/thouska/spotpy) is also available.

![gr4h](https://github.com/SimonDelmas/hydrogr/assets/28869386/3c980461-42d7-4de9-bae7-6bb127c978f1)


## License

This project is licensed under the GLP-2.0 License - see the [LICENSE.md](LICENSE.md) file for details.

