Skip to main content

Lumped-parameter watershed hydrological model

Project description

DOI Documentation Status PyPI version Tests

MNiShed

Watershed hydrological model

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

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).


Read the full documentation on ReadTheDocs


Installation

pip install mnished

To install from source for development:

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

import mnished

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

Command-line interface

mnished -y config.yml

See the Quick Start guide for the configuration file format and input data requirements.

Citation

If you use MNiShed, please cite it using the metadata in 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.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

mnished-3.0.0.tar.gz (93.4 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

mnished-3.0.0-py3-none-any.whl (81.3 kB view details)

Uploaded Python 3

File details

Details for the file mnished-3.0.0.tar.gz.

File metadata

  • Download URL: mnished-3.0.0.tar.gz
  • Upload date:
  • Size: 93.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for mnished-3.0.0.tar.gz
Algorithm Hash digest
SHA256 c1830655a9ce9e3154cb8efd02bcecdbf8b10f446a83bc94572b690c34263f43
MD5 08ea0f9df94ecd38fd77b0867634f98f
BLAKE2b-256 00a2852423f6fb9d4e1fda4024e6836e6a577db3d8e2a2e52535f257e33817c7

See more details on using hashes here.

Provenance

The following attestation bundles were made for mnished-3.0.0.tar.gz:

Publisher: publish.yml on MNiMORPH/MNiShed

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file mnished-3.0.0-py3-none-any.whl.

File metadata

  • Download URL: mnished-3.0.0-py3-none-any.whl
  • Upload date:
  • Size: 81.3 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for mnished-3.0.0-py3-none-any.whl
Algorithm Hash digest
SHA256 3a1a1b19c2824c3a40f06ccd49301817a9e317404e5ea15703a98565fedc8c18
MD5 31801f0d9d99536a8c595db95f371fcb
BLAKE2b-256 00c96c85b8ddcbaaba05fa9c860874dd384333b2d64bb2e9ed49967d5c01d7a4

See more details on using hashes here.

Provenance

The following attestation bundles were made for mnished-3.0.0-py3-none-any.whl:

Publisher: publish.yml on MNiMORPH/MNiShed

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page