Student or educator? Sign up with your school email and get 6 months of Pro free.
CoChat

The DOI matches its Crossref record; 20 of the 22 references it cites were found in a registry or an index; none of the 7 sources its claims cite is checked for support yet.

Hydrostats: A Python Package for Characterizing Errors between Observed and Predicted Time Series

Open access

Abstract

Hydrologists use a number of tools to compare model results to observed flows. These include tools to pre-process the data, data frames to store and access data, visualization and plotting routines, error metrics for single realizations, and ensemble metrics for stochastic realizations to calibrate and evaluate hydrologic models. We present an open-source Python package to help characterize predicted and observed hydrologic time series data called hydrostats which has three main capabilities: Data storage and retrieval based on the Python Data Analysis Library (pandas), visualization and plotting routines using Matplotlib, and a metrics library that currently contains routines to compute over 70 different error metrics and routines for ensemble forecast skill scores. Hydrostats data storage and retrieval functions allow hydrologists to easily compare all, or portions of, a time series. For example, it makes it easy to compare observed and modeled data only during April over a 30-year period. The package includes literature references, explanations, examples, and source code. In this note, we introduce the hydrostats package, provide short examples of the various capabilities, and provide some background on programming issues and practices. The hydrostats package provides a range of tools to make characterizing and analyzing model data easy and efficient. The electronic supplement provides working hydrostats examples.

Overview

CoChat Summary

TL;DR

Hydrostats is an open-source Python package that helps hydrologists store, subset, visualize, and quantify errors between observed and predicted time series, bundling a metrics library (HydroErr) with over 70 error metrics plus ensemble forecast skill scores. The paper is a software note introducing the package's modules and demonstrating its capabilities and code-optimization choices.

Key findings

  • Hydrostats provides three main capabilities: data storage/retrieval built on pandas, visualization/plotting routines using Matplotlib, and a metrics library containing routines for over 70 error metrics plus ensemble forecast skill scores.
  • The package comprises five modules: analyze, data, ens_metrics, metrics, and visual; the metrics module wraps the separately available HydroErr library.
  • In a worked example, a single KGE(2012) call returned 0.8767535070958952, and a table of six metrics (MAE, r², ACC, NSE, KGE(2012), SA) over the full record and four seasons showed similar but seasonally varying values (e.g., full-record MAE 1157.67, r² 0.91, ACC 0.95, NSE 0.87, KGE 0.87, SA 0.15).
  • Benchmarking the Mielke-Berry R metric (which requires a double summation) on a vector of length 1000 gave average times of 181 × 10⁻³ ± 9.13 × 10⁻³ s (Python), 120 × 10⁻³ ± 8.86 × 10⁻³ s (numpy), and 254 × 10⁻⁶ ± 7.03 × 10⁻⁶ s (numba) — speedups of ~1.5× and ~700× respectively; at length 10,000, times were 16.6, 11.3, and 24.7 × 10⁻³ s (~1.5× and ~675×).

Methods

  • Design: a software package description with example code and figures, not an empirical model-evaluation study; the authors state it is "not a discussion of model calibration, error metrics, or analysis methods."
  • Data/sample: illustrative examples use two .csv files of predicted and observed flow merged into a pandas DataFrame, with a seasonal subset (1 April–31 July, 1 January 1986–31 December 1992) and daily averages/standard deviations; ensemble examples use a synthetic forecast of 52 realizations over 15 time steps.
  • Main analysis: demonstration of module functions (merge_data, seasonal_period, daily_average, daily_std_error, make_table, ens_crps) and a runtime benchmark of three implementations (Python double loop, numpy vectorization, numba compilation) of the Mielke-Berry R metric using timeit, benchmarked on 7.7 GB RAM and an Intel Core i5-4590 CPU @ 3.30 GHz × 4.

Limitations

  • Stated: the authors chose not to implement numba versions in the library because the large speedup only occurs for double loops (only a few metrics require them), and requiring numba would add a dependency; documentation instead gives directions for users to modify code to use numba.
  • Stated: for shorter vectors (less than 1000) the time difference between implementations may not be significant.
  • Evident from the text: the paper is a software note with illustrative examples rather than a validation study — the reported metric values (e.g., KGE 0.8767, the seasonal metric table) come from example data and are not presented as substantive hydrologic findings; the ensemble CRPS example uses synthetic random data.

Model-written summary. Check it against the paper before relying on it.

Integrity signals

Registry

Crossref · 10.3390/hydrology5040066

Cites

20 of 20 references verified0 citation errors · 0 not checkable

Statistics

Nothing to recompute.

Figures

Image 1
CC-BY · From the PDF
Figure 7 Runtimes for three different implementations of the Mielke-Berry R metric, plotted with a logarithmic vertical axis. Benchmarks were performed using 7.7 GB of RAM and an Intel ® Core TM i54590 CPU @ 3.30 Ghz x 4. Figure 7. Runtimes for three different implementations of the Mielke-Berry R metric, plotted with a logarithmic vertical axis. Benchmarks were performed using 7.7 GB of RAM and an Intel ® Core TM i5-4590 CPU @ 3.30 Ghz x 4.
Figure 7 Runtimes for three different implementations of the Mielke-Berry R metric, plotted with a logarithmic vertical axis. Benchmarks were performed using 7.7 GB of RAM and an Intel ® Core TM i54590 CPU @ 3.30 Ghz x 4. Figure 7. Runtimes for three different implementations of the Mielke-Berry R metric, plotted with a logarithmic vertical axis. Benchmarks were performed using 7.7 GB of RAM and an Intel ® Core TM i5-4590 CPU @ 3.30 Ghz x 4.CC-BY · From the PDF

Verification

Claims the paper makes

0 Valid · 4 Not valid · 4 Not checked · 34 Own results and interpretations

2 more claims

Create a free account to see all 42 claims and to verify the 7 references still open.

See all claims — free account
  • Probably not a substantial claim. 24
  • It may state two separate claims as one. 20
  • The quote only partly states this claim. 2

Create a free account to see these claims.

Self-check

Percentages, sums and reported differences re-computed from the paper’s own numbers.

Each contradiction between two passages listed here was confirmed by an independent check.

4 of 4

Citations

Cites

Show all 22 references

Cited by

See all 85

Metadata

Authors
Roberts, W., Williams, G. P., Jackson, E., Nelson, E. J., & Ames, D. P.
Affiliations
Brigham Young University (US)
Corresponding author
Williams, Gustavious P.
Venue
Hydrology
Publisher
MDPI AG
Published
2018-12-02
Volume
5
Issue
4
Pages
66
ISSN
2306-5338 (ISSN-L)
OpenAlex
W2902790723
Cited by
85
References
22
Citations by year
2026: 8 · 2025: 11 · 2024: 13 · 2023: 18 · 2022: 13 · 2021: 10 · 2020: 8 · 2019: 4
Type
software paper
Language
en
Open access
Locations
  • Hydrology (publishedVersion, cc-by)
  • DOAJ (DOAJ: Directory of Open Access Journals) (submittedVersion)
Funders
SERVIR, NASA Applied Sciences Program (NNX16AN45G)
Topics
  • Physical Sciences › Environmental Science › Water Science and Technology › Hydrology and Watershed Management Studies
  • Physical Sciences › Environmental Science › Management, Monitoring, Policy and Law › Environmental Monitoring and Data Management
  • Physical Sciences › Computer Science › Software › Computational Physics and Python Applications
Keywords
Python library, hydrologic model evaluation, error metrics, hydrological model calibration, open source software, river discharge

About these checks

Registry, retraction, Cites and statistics results are computed, not judged, with one exception: a printed reference that no index lists is read once by a model before it counts as a citation error. Claims are extracted by a model and kept only when their quote appears verbatim in the text; each cited source is then checked, with a model’s help, for whether it says what the claim relies on. Those verdicts can be wrong — read the claim’s quote and the cited source before relying on one.

A language model drew the claims from the paper on 2026-11-18, under version 3 of the claim definition (model deepseek-v4.1-flash, prompt extract-v3).

A second model labelled each claim on 2026-11-18 (model jev-1.13-20260917, definition revision gold-guideline-v0.2).

Statistics and arithmetic are recomputed, not judged.

Confidence bands are shown only for fields calibrated on our annotated test set. None is calibrated yet, so no band is shown.

What counts as a claim ›How we measure confidence ›How we check this ›

Are you an author, or do you see a problem with this page? Request a review

How to cite

Cite CoChat for the checks on this page, and the paper for its own findings.

This page
CoChat. (2026). Citation check: Hydrostats: A Python Package for Characterizing Errors between Observed and Predicted Time Series. https://app.cochat.ai/papers/10.3390/hydrology5040066
The paper
Roberts, W., Williams, G. P., Jackson, E., Nelson, E. J., & Ames, D. P. (2018). Hydrostats: A Python Package for Characterizing Errors between Observed and Predicted Time Series. Hydrology. https://doi.org/10.3390/hydrology5040066

Data sources

Bibliographic data: Semantic Scholar, OpenAlex, Crossref.

Contains information from the Semantic Scholar Academic Graph Datasets, made available under the ODC Attribution License (ODC-BY 1.0).

Semantic Scholar’s data is described in: Kinney, R., et al. (2023). The Semantic Scholar Open Data Platform. arXiv:2301.10140.