Skip to main content

HydroEval: An Evaluator for Stream Flow Time Series

Project description

License: GPL v3 PyPI Version

HydroEval - An open-source evaluator for stream flow time series in Python

HydroEval is an open-source evaluator for stream flow time series in Python. It is licensed under GNU GPL-3.0 (see licence file provided). The purpose of this evaluator is to compare observed and simulated hydrographs using one or more objective functions. HydroEval is designed to calculate all objective functions in a vectorised way (using numpy, and therefore C code in the background) which makes for very efficient computation of the objective functions.

How to Install

HydroEval is available on PyPI, so you can simply use pip and the name of the package:

python -m pip install hydroeval

You can also use pip and a link to the GitHub repository directly:

python -m pip install git+https://github.com/ThibHlln/hydroeval.git

Alternatively, you can download the source code (i.e. the GitHub repository) and, from the downloaded directory itself, run the command:

python setup.py install

How to Use

A tutorial in the form of a Jupyter notebook is available to get started with the usage of HydroEval's API. The input files required for the tutorial are all provided in the examples/ folder.

Objective Functions Available

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

Moreover, KGE and NSE can be calculated in a bounded version following Mathevet et al. (2008):

  • Bounded Nash-Sutcliffe Efficiency (nse_c2m)
  • Bounded Original Kling-Gupta Efficiency (kge_c2m)
  • Bounded Modified Kling-Gupta Efficiency (kgeprime_c2m)

Finally, any of the objective functions can take an optimal argument transform. This argument allows to apply a transformation on both the observed and the simulated stream flow 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')

Dependencies

HydroEval requires the popular Python package numpy to be installed on the Python implementation where hydroeval is installed.

Version History

  • 0.0.2 [29 Nov 2018]: General improvements
    • Re-defines axis=0 as default array orientation
    • Adds non-parametric version of KGE
    • Corrects mistake in bounded original and modified KGE
  • 0.0.1 [26 Oct 2018]: First version of HydroEval

Acknowledgment

This tool was 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.

Files for hydroeval, version 0.0.2
Filename, size File type Python version Upload date Hashes
Filename, size hydroeval-0.0.2-py2-none-any.whl (20.2 kB) File type Wheel Python version py2 Upload date Hashes View hashes
Filename, size hydroeval-0.0.2-py3-none-any.whl (20.2 kB) File type Wheel Python version py3 Upload date Hashes View hashes
Filename, size hydroeval-0.0.2.tar.gz (5.5 kB) File type Source Python version None Upload date Hashes View hashes

Supported by

Elastic Elastic Search Pingdom Pingdom Monitoring Google Google BigQuery Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN DigiCert DigiCert EV certificate StatusPage StatusPage Status page