Metadata-Version: 2.4
Name: MNiShed
Version: 3.0.0
Summary: Lumped-parameter watershed hydrological model
Author-email: "Andrew D. Wickert" <awickert@umn.edu>
License-Expression: GPL-3.0-or-later
Project-URL: Homepage, https://csdms.colorado.edu/wiki/Model:MNiShed
Project-URL: Repository, https://github.com/MNiMORPH/MNiShed
Project-URL: Documentation, https://mnished.readthedocs.io/
Project-URL: Issues, https://github.com/MNiMORPH/MNiShed/issues
Keywords: hydrology,linear reservoir,rainfall-runoff,snow,streamflow,discharge,water balance,evapotranspiration
Classifier: Development Status :: 5 - Production/Stable
Classifier: Programming Language :: Python :: 3
Classifier: Operating System :: OS Independent
Classifier: Intended Audience :: Science/Research
Classifier: Topic :: Scientific/Engineering :: Hydrology
Requires-Python: >=3.9
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: numpy
Requires-Dist: pandas
Requires-Dist: matplotlib
Requires-Dist: pyyaml
Requires-Dist: scipy
Provides-Extra: docs
Requires-Dist: sphinx>=5.2; extra == "docs"
Requires-Dist: sphinx-rtd-theme>=1.0; extra == "docs"
Provides-Extra: bmi
Requires-Dist: bmipy>=2.0; extra == "bmi"
Provides-Extra: jit
Requires-Dist: numba; extra == "jit"
Requires-Dist: numpy<2.3; extra == "jit"
Provides-Extra: lint
Requires-Dist: ruff; extra == "lint"
Dynamic: license-file

[![DOI](https://zenodo.org/badge/199317220.svg)](https://doi.org/10.5281/zenodo.6787390)
[![Documentation Status](https://readthedocs.org/projects/mnished/badge/?version=latest)](https://mnished.readthedocs.io/en/latest/?badge=latest)
[![PyPI version](https://img.shields.io/pypi/v/MNiShed)](https://pypi.org/project/MNiShed/)
[![Tests](https://github.com/MNiMORPH/MNiShed/actions/workflows/tests.yml/badge.svg)](https://github.com/MNiMORPH/MNiShed/actions/workflows/tests.yml)

# MNiShed
**Watershed hydrological model**

*MN* = Minnesota · *Mni* = water (Dakota) · *Mini* = small (lumped) · *Shed* = watershed

<!-- start-intro -->

MNiShed is a lumped, daily-timestep conceptual hydrological model. It routes precipitation through an optional snowpack stage and then through a cascade of one or more reservoirs (soil zone, groundwater, etc.), producing streamflow. Evapotranspiration is either read from a data file or computed with the Thornthwaite–Chang 2019 equation, and is scaled to close the long-run water balance. The model follows the [CSDMS Basic Model Interface (BMI)](https://csdms.colorado.edu/wiki/BMI).

<!-- end-intro -->

---

[Read the full documentation on ReadTheDocs](https://mnished.readthedocs.io/)

---

## Installation

```bash
pip install mnished
```

To install from source for development:

```bash
git clone https://github.com/MNiMORPH/MNiShed.git
cd MNiShed
pip install -e '.[bmi,jit]'   # optional extras: bmi, jit, docs, lint
```

The optional extras are `bmi` (CSDMS BMI wrapper), `jit` (Numba JIT
acceleration), `docs` (build the documentation), and `lint` (Ruff).

## Quick start

**Python API**

```python
import mnished

b = mnished.Buckets()
b.initialize('config.yml')
b.run()
b.compute_NSE(verbose=True)
b.plot()
```

**Command-line interface**

```bash
mnished -y config.yml
```

See the [Quick Start guide](https://mnished.readthedocs.io/en/latest/quickstart.html) for the configuration file format and input data requirements.

## Citation

If you use MNiShed, please cite it using the metadata in [CITATION.cff](CITATION.cff) or via the Zenodo record:

> Wickert, A. D. (2026). MNiShed: Watershed hydrological model. https://doi.org/10.5281/zenodo.6787390

## Contact

Please report bugs and request features via [GitHub Issues](https://github.com/MNiMORPH/MNiShed/issues).
