Skip to main content

hydro_suite/
lib.rs

1//! `hydro-suite` — umbrella crate for the multi-model hydrology platform.
2//!
3//! One dependency gives you the full suite:
4//! - [`hydro_core`]: `HydroModel`/`DynHydroModel` traits, forcing, evaluation metrics
5//!   (NSE/KGE/CRPS + GB/T 22482 qualification).
6//! - [`hydro_xinanjiang`], [`hydro_topmodel`], [`hydro_swat`], [`hydro_apicont`]: models.
7//! - [`hydro_calib`]: DDS + SCE-UA calibration.
8//! - [`hydro_platform`]: scenario orchestration, comparison, ensemble stats.
9//!
10//! Use `hydro_suite::*` for the common items, or reach into a member crate
11//! (e.g. `hydro_suite::hydro_xinanjiang::*`) for the full API.
12
13pub use hydro_core;
14pub use hydro_xinanjiang;
15pub use hydro_topmodel;
16pub use hydro_swat;
17pub use hydro_apicont;
18pub use hydro_calib;
19pub use hydro_platform;
20
21// Top-level convenience re-exports of the most-used items.
22pub use hydro_core::{BasinInfo, DynHydroModel, Forcing, HydroModel, ModelType, Outlet};
23pub use hydro_calib::{CalibResult, Method, Objective, ParamSpec, SceConfig, calibrate};
24pub use hydro_platform::{
25    ComparisonResult, EnsembleStats, ModelResult, Scenario, create_model, ensemble_probabilistic,
26    ensemble_rank_histogram, ensemble_stats, event_uh_forecast, run_model_default, run_scenario,
27    scs_unit_hydrograph,
28};
29pub use hydro_xinanjiang::XinanjiangParams;
30pub use hydro_topmodel::TopmodelParams;
31pub use hydro_swat::SwatParams;
32pub use hydro_apicont::ApicontParams;