Skip to main content

HydroEval: An Evaluator for Streamflow Time Series In Python

Project description

PyPI Version DOI License: GPL v3 GitHub Actions Test Workflow Status

hydroeval is an open-source evaluator of goodness of fit between simulated and observed streamflow time series in Python. It is licensed under GNU GPL-3.0. The package provides a bundle of the most commonly used objective functions in hydrological science. The package is designed to calculate all objective functions in a vectorised manner (using numpy, and therefore C code in the background) which makes for very efficient computation of the objective functions.

If you are using hydroeval, please consider citing the software as follows (click on the link to get the DOI of a specific version):

Hallouin, T. (XXXX). HydroEval: Streamflow Simulations Evaluator (Version X.X.X). Zenodo. https://doi.org/10.5281/zenodo.2591217

Brief overview of the API

import hydroeval as he

simulations = [5.3, 4.2, 5.7, 2.3]
evaluations = [4.7, 4.3, 5.5, 2.7]

nse = he.evaluator(he.nse, simulations, evaluations)

kge, r, alpha, beta = he.evaluator(he.kge, simulations, evaluations)

Objective functions available

The objective functions currently available in hydroeval to evaluate the fit between observed and simulated streamflow time series are as follows:

Moreover, some objective functions can be calculated in a bounded version following Mathevet et al. (2006):

  • Bounded Nash-Sutcliffe Efficiency (nse_c2m)

  • Bounded Original Kling-Gupta Efficiency (kge_c2m)

  • Bounded Modified Kling-Gupta Efficiency (kgeprime_c2m)

  • Bounded Non-Parametric Kling-Gupta Efficiency (kgenp_c2m)

Finally, the evaluator can take an optional argument transform. This argument allows to apply a transformation on both the observed and the simulated streamflow time series prior the calculation of the objective function. The possible transformations are as follows:

  • Inverted flows (using transform=’inv’)

  • Square Root-transformed flows (using transform=’sqrt’)

  • Natural Logarithm-transformed flows (using transform=’log’)

Acknowledgement

Early versions of this tool were developed with the financial support of Ireland’s Environmental Protection Agency (Grant Number 2014-W-LS-5).

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

hydroeval-0.1.0.tar.gz (21.6 kB view details)

Uploaded Source

Built Distribution

hydroeval-0.1.0-py3-none-any.whl (22.7 kB view details)

Uploaded Python 3

File details

Details for the file hydroeval-0.1.0.tar.gz.

File metadata

  • Download URL: hydroeval-0.1.0.tar.gz
  • Upload date:
  • Size: 21.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.4.1 importlib_metadata/4.0.1 pkginfo/1.6.1 requests/2.23.0 requests-toolbelt/0.9.1 tqdm/4.54.1 CPython/3.7.7

File hashes

Hashes for hydroeval-0.1.0.tar.gz
Algorithm Hash digest
SHA256 1a6c0ceb5fac3cb2641a8f954ef7224337add9b9dc65b236775f56d7c868f913
MD5 bd2e21a54655d5e18482ed7a3f0959f4
BLAKE2b-256 2587ab0cbe03145e5dd8d4b1c019c498f971d5233cc85f2e0e2d50bad3020594

See more details on using hashes here.

File details

Details for the file hydroeval-0.1.0-py3-none-any.whl.

File metadata

  • Download URL: hydroeval-0.1.0-py3-none-any.whl
  • Upload date:
  • Size: 22.7 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.4.1 importlib_metadata/4.0.1 pkginfo/1.6.1 requests/2.23.0 requests-toolbelt/0.9.1 tqdm/4.54.1 CPython/3.7.7

File hashes

Hashes for hydroeval-0.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 522eca99468a0f2a7670232837a459cdde847d69a4c6bface98856e2e57123f5
MD5 57ee84be892765f13c90bd20dad7e900
BLAKE2b-256 4ada79c0aa3fc7ddea675a8006beb6c0824ae3430727e0f5141838161d0bfdda

See more details on using hashes here.

Supported by

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