README.md

hydroDL2.0

This repository serves as a store for hydrology models and modules to be used with the generic differential modeling package, generic_diffModel.

How to Install:

git clone https://github.com/mhpi/hydroDL2.git
cd hydrodl2
pip install .

Developer Mode Installation:

The same clone as above, but use hatch's developer mode setting,

pip install -e .

Maintainers:

See Pyproject.toml for information.

Contributing:

We request all changes to this repo be made through a fork and PR.

Repository Structure:

.
├── src/
|   └── hydroDL2/ 
│       ├── api/                   # Main API code
│       |   ├── __init__.py        
│       |   └── methods.py         # Methods exposed to end-users
|       ├── core/                  # Methods used internally
│       ├── models/                # Shared models directory
│       |   ├── hbv/               # HBV models
│       |   └── prms/              # Marrmot PRMS models     
|       └── modules/               # Augmentations for `dMG` models
├── tests/                         # Test suite for API and models
│   ├── __init__.py            
│   └── test_models.py
├── docs/                          
├── LICENSE
├── mkdocs.yml
├── pyproject.toml             
└── README.md