.. Packaging Scientific Python documentation master file, created by
   sphinx-quickstart on Thu Jun 28 12:35:56 2018.
   You can adapt this file completely to your liking, but it should at least
   contain the root `toctree` directive.

Welcome to HydroBM's documentation!
==================================================

HydroBM is a shorthand for "Hydrologic Timeseries Benchmarks".
HydroBM is a Python package that provides a simple framework to create benchmark timeseries for hydrologic models.
Details about this benchmarking approach can be found in `Knoben (2024) <knoben-2024_>`_.

Extra features:

* Calculate various performance metrics for the benchmark simulations.
* Run a simple degree-day model for snow accumulation and melt simulation.


Contents:
=========
.. toctree::
   :maxdepth: 2

   installation
   usage
   ./example/example
   release-history


References
-------------------------
.. _knoben-2024:

Knoben, W. J. M. (2024). Setting expectations for hydrologic model performance with an ensemble of simple benchmarks. Hydrological Processes, 38(10), e15288. https://doi.org/10.1002/hyp.15288