User reference
This page is the entry point to detailed configuration, characteristic, output, CLI, and Python API guidance. It replaces the former combined reference's long-form sections while deliberately retaining its path and important anchors for existing links.
Start with a topic
| Topic | Reference |
|---|---|
| Input, component, and output TOML | Configuration reference |
| Seasonal calendar window | Timing |
| Flow thresholds and ranges | Magnitude |
| Relative change between observations | Rate of change |
| Consecutive qualifying observations | Duration |
| Qualifying timesteps and water years in windows | Frequency |
Exact run flags and error codes |
Command-line reference |
| Output files | Output guide |
| Scenario-grid plots | Plotting guide |
| Python evaluation and result columns | Python API |
For the concepts shared across characteristics, see scientific foundations and evaluation order and interpretation.
Configuration overview
Each TOML file describes the input time series, one or more components, and optional output settings. Begin with the configuration reference or the first evaluation.
Time-series options
See input time-series settings. Input columns, dates, and working-folder behavior are described in preparing data.
Characteristic parameters
Each characteristic has its own page with purpose, parameter types, defaults, units, and worked results: timing, magnitude, rate of change, duration, and frequency.
Timing
See the timing reference.
Magnitude
See the magnitude reference.
Duration
See the duration reference.
Rate of change
See the rate-of-change reference.
Frequency
See the frequency reference for un-nested, intra-annual, and interannual patterns.
Component options
See component settings and evaluation order.
Python evaluation and result columns
See Python evaluation and result columns.
Outputs and command line
Output options
See output settings and output files.
The former reference sections for TOML/CLI precedence and the
[output.metric] and [output.plot] tables now live in the
configuration reference and
command-line reference.
Response-surface plots
See the plotting guide for scenario-grid requirements
and configuration. The --plot and related flags are listed in the
command-line reference.
Parser error codes
See parser error codes.
Plot error codes
See plot error codes.
The former programmatic error-details section is now in the Python API reference.