Evaluate flow patterns with hydropattern

hydropattern evaluates hydrologic time series against conditions you configure. You supply observations in CSV or Excel and describe components in a TOML text file. The application produces timestep outcomes and component summary workbooks; scenario grids can also produce response-surface plots.

Start with installation, then complete the first evaluation using eight daily observations. The results guide explains each output column and the example's summary. You do not need to write Python.

Find an explanation

• Scientific foundations introduce the flow-regime dimensions, and evaluation order explains how characteristic outcomes form a component outcome. See unknown outcomes for uncertainty, denominators, event bounds, and plot eligibility.
• The glossary defines components, characteristics, qualifying timesteps, frequency windows, and scenarios.
• Preparing data, output files, and plotting cover common analysis tasks.
• Command-line usage explains commands, working folders, and output choices.
• The reference lists configuration fields and existing characteristic rules.
• Runnable examples cover seasonal thresholds, duration, frequency windows, multiple scenarios, and response-surface coverage.
• Upgrade guidance identifies completed breaking changes.
• The Python API is available for programmatic evaluation.

Scientific context

The natural flow regime describes hydrologic variation relevant to ecosystems. Functional flows connect that variation to environmental processes. See Poff et al. (1997) and Yarnell et al. (2020) for the original scientific foundations.

The examples illustrate software behavior. Their thresholds are not universal ecological criteria, and a configured component success is not evidence of ecological benefit.

The hydropattern documentation site is published on GitHub Pages.