SynHydro

SynHydro is a Python library for generating synthetic hydrologic timeseries using a unified, scikit-learn-style API. All generators share a common fit() and generate() workflow, and the library includes validation, drought analysis, plotting, and ensemble data management tools.

Installation

pip install synhydro

To install a specific tagged release directly from GitHub instead:

pip install git+https://github.com/TrevorJA/SynHydro.git@v0.1.0

Quick example

import synhydro

Q_daily = synhydro.load_example_data()
Q_monthly = Q_daily.resample("MS").sum()

gen = synhydro.KirschGenerator()
gen.fit(Q_monthly)
ensemble = gen.generate(n_realizations=50, n_years=30, seed=42)

Supported generators

Generators are classified into three bins by the mathematical character of their generative mechanism: parametric (sample from a fitted probability model), hybrid (combine a parametric structure with a non-parametric resampling step), and non-parametric (resample the historical record directly). See the Algorithms page for full descriptions.

Supported disaggregators

Pre-built pipelines (KirschNowakPipeline, ThomasFieringNowakPipeline) chain generation and disaggregation in a single interface.

Contributing

SynHydro is under active development, and contributions are welcome. For bug reports, feature requests, or discussion of new methods, please open an issue or pull request on GitHub. See CONTRIBUTING.md for guidelines on adding new generators and the project's development practices.

Documentation

Full documentation including tutorials, algorithm descriptions, and API reference is available at the project website.

Citing SynHydro

The DOI badge and the version DOI below are filled in after the first release is archived on Zenodo. If you use SynHydro in your research, please cite it as:

Amestoy, T. (2026). SynHydro: Synthetic hydrologic timeseries generation
in Python (Version 0.1.0) [Computer software]. Zenodo.
https://doi.org/10.5281/zenodo.YYYYYYY

@software{amestoy_synhydro_2026,
  author    = {Amestoy, Trevor},
  title     = {{SynHydro}: Synthetic hydrologic timeseries generation in Python},
  version   = {0.1.0},
  year      = {2026},
  publisher = {Zenodo},
  doi       = {10.5281/zenodo.YYYYYYY},
  url       = {https://github.com/TrevorJA/SynHydro}
}