Expand description
hydro-suite — umbrella crate for the multi-model hydrology platform.
One dependency gives you the full suite:
hydro_core:HydroModel/DynHydroModeltraits, forcing, evaluation metrics (NSE/KGE/CRPS + GB/T 22482 qualification).hydro_xinanjiang,hydro_topmodel,hydro_swat,hydro_apicont: models.hydro_calib: DDS + SCE-UA calibration.hydro_platform: scenario orchestration, comparison, ensemble stats.
Use hydro_suite::* for the common items, or reach into a member crate
(e.g. hydro_suite::hydro_xinanjiang::*) for the full API.
Re-exports§
pub use hydro_core;pub use hydro_xinanjiang;pub use hydro_topmodel;pub use hydro_swat;pub use hydro_apicont;pub use hydro_calib;pub use hydro_platform;
Structs§
- Apicont
Params - API-CONT model parameters (3 scalars).
- Basin
Info - Static basin / sub-basin metadata shared across all models.
- Calib
Result - 率定结果(参数 JSON + 最优分数 + 评估次数 + 收敛历史)。
- Comparison
Result - Comparison output from running every model in a
Scenario. - Ensemble
Stats - Per-time-step ensemble statistics across all members of a
ComparisonResult. - Forcing
- Per-timestep meteorological forcing for a sub-basin or grid cell.
- Model
Result - A single model run result: discharge hydrograph + optional evaluation metrics.
- Outlet
- Outlet section descriptor.
- Param
Spec - 单个率定参数:JSON 字段名 + 区间(归一化
x∈[0,1]映射到[min,max])。 - SceConfig
- SCE-UA 配置(默认:complexes=5,每 complex m=2n+1 点,subcomplex q=n+1)。
- Scenario
- A forecast scenario: basin + forcing + selected models + optional observation + optional per-model parameter overrides.
- Swat
Params - SWAT+ LTE parameters — the lumped daily driver configuration consumed by
run_swat_lte_fullandSwatModel. - Topmodel
Params - TOPMODEL parameters: 11 scalar model parameters plus the basin TWI histogram, the optional channel-delay histogram, and the basin area used to convert mm/Δt to m³/s.
- Xinanjiang
Params - Xinanjiang model parameters (16 params + unit hydrograph + basin area).
Enums§
- Method
- 率定方法。
- Model
Type - Identifier for the four distributed hydrology models orchestrated by the platform crate.
- Objective
- 率定目标(皆“越大越好“;RMSE 取负)。
Traits§
- DynHydro
Model - Object-safe wrapper so the platform can hold
Vec<Box<dyn DynHydroModel>>for heterogeneous multi-model comparison. - Hydro
Model - The core trait every distributed hydrological model implements.
Functions§
- calibrate
- 模型率定入口。
make_model:每次调用返回一个全新默认模型(闭包内 create_model)。 - create_
model - Factory: create a boxed
DynHydroModelfrom aModelTypetag + a JSON params blob. - ensemble_
probabilistic - Ensemble probabilistic verification against an observed series at a
discharge
threshold. - ensemble_
rank_ histogram - Talagrand rank histogram (ensemble reliability) for the multi-model ensemble vs an observed series.
- ensemble_
stats - Compute per-time-step ensemble statistics across all members of
res. - event_
uh_ forecast - Event-based unit-hydrograph forecast: rainfall hyetograph
rain_mm(per time-step) convolved with a unit hydrographuh(a normalised kernel,Σ uh = 1) → outlet discharge hydrograph in m³/s. - run_
model_ default - Run a single model with default parameters and return its discharge hydrograph (m³/s, one entry per forcing step).
- run_
scenario - Run all selected models in
scenarioon the same forcing and collect hydrographs + (optional) evaluation metrics. - scs_
unit_ hydrograph - SCS-style dimensionless unit hydrograph, simplified to a triangular UH:
linear rise to the peak at index
peak_t, linear recession to zero at indexbase_t - 1, then normalised soΣ uh = 1.