Welcome to diag-eff’s documentation!

diag-eff is a package for diagnostic evaluation of hydrologic simulations. It includes one main module de. The module provides functions for calculating model performance and for diagnostics.

How to cite

In case you use de in other software or scientific publications, please reference this package. It is published and has a DOI. It can be cited as:

Robin Schwemmle, Dominic Demand & Markus Weiler (2020). diag-eff 1.0: Diagnostic efficiency – specific evaluation of model performance. (Version v1.0). Zenodo. https://doi.org/10.5281/zenodo.4457898

Contents:

• Installation
  • PyPI
  • GitHub
  • Note
• Getting started
  • Diagnostic Efficiency
  • Diagnostic polar plot
• Tutorials
  • Proof of concept
    • Observed streamflow time series from CAMELS dataset
    • Generating artificial errors
    • References
  • Modelling example
    • Observed streamflow time series and simulated streamflow time series from CAMELS dataset
    • Plotting simulated streamflow time series and corresponding flow duration curves
    • Evaluation of model performance
    • Diagnostic polar plot
    • References
• Code Reference
  • de
    • Diagnostic Efficiency
    • Constant error term
    • Dynamic error term
    • Timing error term
    • Error contribution of high flows and low flows
    • Diagnostic Polar Plot
    • Diagnostic Polar Plot for multiple simulations
  • generate_errors
    • Constant error
    • Dynamic error
    • Timing error
  • kge
    • Kling-Gupta Efficiency
    • Bias term
    • Variability term
    • Correlation term
    • Polar Plot
  • nse
    • Nash-Sutcliffe Efficiency
• Changelog
  • Version 1.0