Skip to main content

Crate hydro_suite

Crate hydro_suite 

Source
Expand description

hydro-suite — umbrella crate for the multi-model hydrology platform.

One dependency gives you the full suite:

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§

ApicontParams
API-CONT model parameters (3 scalars).
BasinInfo
Static basin / sub-basin metadata shared across all models.
CalibResult
率定结果(参数 JSON + 最优分数 + 评估次数 + 收敛历史)。
ComparisonResult
Comparison output from running every model in a Scenario.
EnsembleStats
Per-time-step ensemble statistics across all members of a ComparisonResult.
Forcing
Per-timestep meteorological forcing for a sub-basin or grid cell.
ModelResult
A single model run result: discharge hydrograph + optional evaluation metrics.
Outlet
Outlet section descriptor.
ParamSpec
单个率定参数: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.
SwatParams
SWAT+ LTE parameters — the lumped daily driver configuration consumed by run_swat_lte_full and SwatModel.
TopmodelParams
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.
XinanjiangParams
Xinanjiang model parameters (16 params + unit hydrograph + basin area).

Enums§

Method
率定方法。
ModelType
Identifier for the four distributed hydrology models orchestrated by the platform crate.
Objective
率定目标(皆“越大越好“;RMSE 取负)。

Traits§

DynHydroModel
Object-safe wrapper so the platform can hold Vec<Box<dyn DynHydroModel>> for heterogeneous multi-model comparison.
HydroModel
The core trait every distributed hydrological model implements.

Functions§

calibrate
模型率定入口。make_model:每次调用返回一个全新默认模型(闭包内 create_model)。
create_model
Factory: create a boxed DynHydroModel from a ModelType tag + 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 hydrograph uh (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 scenario on 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 index base_t - 1, then normalised so Σ uh = 1.