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.1.0.tar.gz (111.3 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.1.0-py3-none-any.whl (90.5 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for mnished-3.1.0.tar.gz
Algorithm Hash digest
SHA256 96c989dde8a4b7e802d89c778770efaeef89ff3b9cccc221beb4b5fc43ab8909
MD5 f6e2fc98c21123d695ccaed4d2bb7e5e
BLAKE2b-256 3de9adc5334aafe0dfdcb7ae8a52614ed1fcab786c1459c9dc254fb7b37b58b5

See more details on using hashes here.

Provenance

The following attestation bundles were made for mnished-3.1.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.1.0-py3-none-any.whl.

File metadata

  • Download URL: mnished-3.1.0-py3-none-any.whl
  • Upload date:
  • Size: 90.5 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.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 f12349cae84b7feeb8762c11b8243c823bb6cefca9f157e8b88c4481d0d4fa2d
MD5 6c21b220552e63c9cecdf251d84aa633
BLAKE2b-256 c11c23d14e9ee981c4739ae489391b1ced49eb67796c56e3ddbc0b922f745a71

See more details on using hashes here.

Provenance

The following attestation bundles were made for mnished-3.1.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