hydromodpy.results.field_registry#

Canonical field registry for HydroModPy simulation outputs.

A single source of truth that maps each public field name (used by figures, CLI exports and the Python API) to its Zarr storage path and a CF-1.11 metadata bundle (standard_name, long_name, units, cell_methods, coordinates, grid_mapping).

Downstream code (Zarr writers, xarray exporters, display modules) reads from this registry so that the same field is described identically no matter which layer produces or consumes it. Spec refs: architecture_cible/13_coherence_globale.md §1.3 and architecture_cible/04_storage_ideal.md §3.

The registry is intentionally small and explicit: when a new field is introduced, add it here so every layer picks up the CF metadata for free.

Functions

all_names()

Return the sorted list of registered public names.

all_zarr_paths()

Return the sorted list of registered Zarr paths.

cf_attrs(name)

Return a dict of CF-1.11 + UGRID-1.0 attributes for the given public name.

get(name)

Return the FieldDescriptor registered under name.

has(name)

Return True when name is registered.

Classes

FieldDescriptor(public_name, zarr_path, ...)

CF-1.11 compliant descriptor for a canonical HydroModPy field.