hydromodpy.results.simulation_group#

Multi-simulation view on the results catalog.

What#

Iterable, filterable view over a list of sim_id resolved against a single SimulationCatalog. Builds pivoted parameters and metrics frames, ranks runs (best, worst, sort_by), compares scalar metrics across simulations (compare), exports tabular bundles (to_dataframe, to_csv), stacks field arrays lazily into an xarray.DataArray (to_xarray, dask-backed), and narrows the set with filter(**criteria).

Why#

Calibration ensembles, gallery sweeps, and ad hoc cohorts share the same ā€œlist of runsā€ abstraction. Centralising it here keeps the per-run loop logic (sort, pivot, compare) in one place rather than duplicated across notebooks.

Public API#

  • SimulationGroup: returned by SimulationCatalog.find and similar multi-result entry points. Iteration yields Run instances; indexing, len(), and HTML repr are supported.

Cross-refs#

  • hydromodpy.results.catalog.SimulationCatalog is the upstream owner.

  • hydromodpy.results.run.Run is the unit element of the group.

  • to_xarray opens each per-sim Zarr lazily (dask-backed concat).

Classes

SimulationGroup(sim_ids,Ā catalog)

Collection view over several simulations from one catalog.
On this page