hydromodpy.results#

Result storage for HydroModPy simulations (DuckDB + Zarr).

Hydrological metrics live in hydromodpy.core.metrics (canonical location for nse, rmse, mae, kge, log_nse, bias, pbias, correlation).

Modules

array_fingerprint

Input provenance fingerprinting for simulation reproducibility.

catalog

Catalog facade for the results layer.

contracts

Strong-typed return contracts for Run field/raster/mesh accessors.

derived

Pure-function derivations of secondary fields from primary outputs.

errors

Typed exceptions for the results / reader layer.

export

FAIR export formats for HydroModPy simulations.

exporters

field_registry

Canonical field registry for HydroModPy simulation outputs.

geographic_cache

Workspace-level content-addressable geographic cache.

geoparquet_io

Compatibility re-export for shared GeoParquet I/O helpers.

grid

Scalar spatial metadata for a simulation: cell size, shape, extent.

html_helpers

Small HTML helpers shared by calibration and analysis report builders.

importers

Importers symmetric to hydromodpy.results.exporters.

lazy_loaders

Lazy loaders for the per-simulation Parquet and Zarr stores.

parquet_io

Atomic pyarrow Parquet writer with canonical V1 options forced.

parquet_schemas

PyArrow schemas for every per-simulation Parquet view.

reading

Variable read dispatch shared by hmp.read and Catalog.read.

run

Single-simulation view on the results catalog.

run_array

Array / xarray provider bound to a single Run.

run_environment

Capture host environment metadata for the runs_environment table.

run_geographic

Geographic and mesh accessors for hydromodpy.results.run.Run.

run_hydrographic

Hydrographic-network accessors for hydromodpy.results.run.Run.

run_timeseries

Tabular and time-aligned accessors for hydromodpy.results.run.Run.

simulation_group

Multi-simulation view on the results catalog.

spatial_index

Point-in-cell lookup on unstructured meshes via Shapely STRtree.

storage_contract

Shared result-storage layout contract.

storage_diagnostics

Diagnostics for the workspace result-storage layout.

time_alignment

Time alignment helpers for observed and simulated series.

timeseries_downsample

LTTB downsampling for dense time series stored in the catalog.

views

Lazy catchment-scale views computed on demand from a Run.

virtual_fields

On-the-fly derived fields computed from stored primary variables.

zarr_store

Zarr v2 per-simulation store (CF-1.11 + ACDD-1.3 + UGRID-1.0).