HydroDL 2.0: Differentiable Hydrological Model Repository

---

HydroDL 2.0 is store for differentiable hydrology models and modules designed to be used in concert with the generic differential modeling package, dMG.

This work is mantained by MHPI and advised by Dr. Chaopeng Shen. If you find it useful, please cite (dedicated citations are coming):

Shen, C., et al. (2023). Differentiable modelling to unify machine learning and physical models for geosciences. Nature Reviews Earth & Environment, 4(8), 552–567. <https://doi.org/10.1038/s43017-023-00450-9>.

Installation

To install hydrodl2, clone the repo and install in developer mode with Astral UV (recommended)

```bash
git clone https://github.com/mhpi/hydrodl2.git

cd hydrodl2
uv pip install .
```

or with pip

```bash
pip install .
```

Repo

```text
.
├── src/
|   └── hydrodl2/ 
│       ├── api/                   # Main API
│       |   ├── __init__.py        
│       |   └── methods.py         # Methods exposed to end-users
|       ├── core/                  # Methods used internally
│       ├── models/                # Shared models directory
│       |   └── hbv/               # HBV models
|       └── modules/               # Augmentations for dMG models
└── docs/                          
```

Contributing

We welcome contributions! Please submit changes via a fork and pull requests. For more details, refer to docs/CONTRIBUTING.md.

---

Please submit an issue to report any questions, concerns, bugs, etc.