Skip to content

API Reference

Auto-generated API documentation from source code docstrings.

Public API

The following are exported from the top-level hydro_param package:

Module Index

Core

Module Description
config Pipeline configuration models and YAML loader
pipeline 5-stage pipeline orchestrator
sir Standardized Internal Representation normalization
dataset_registry Dataset registry schema and loader
data_access STAC COG, local GeoTIFF, terrain derivation
processing Zonal statistics via gdptools
batching Spatial batching via KD-tree bisection
manifest Pipeline manifest for incremental runs
units Unit conversion utilities (SI to PRMS imperial)
project Project scaffolding and root detection

Plugins

Module Description
plugins Plugin protocols, DerivationContext, and factory functions
derivations.pywatershed pywatershed parameter derivation (steps 1--14)
formatters.pywatershed pywatershed output formatter (NetCDF, CSV, control)
pywatershed_config pywatershed-specific configuration schema

Utilities

Module Description
cli Command-line interface (cyclopts)
solar Clear-sky solar radiation (Swift 1976 soltab)