hydromodpy.core.config_kit.profile

Hierarchical visibility profiles for Pydantic config fields.

A field is visible when field_profile <= requested_profile. Lower value ⇒ more broadly visible.

Usage:

from hydromodpy.core.config_kit.profile import Profile

class FlowConfig(HydroModelBase):
    k_aquifer: Annotated[HydraulicConductivity, Profile.USER] = Field(...)
    solver_inner_tol: Annotated[float, Profile.DEV] = Field(default=1e-6, ...)
    pcg_relaxation: Annotated[float, Profile.EXPERT] = Field(default=0.97, ...)

Module attributes

ProfileName

String form of Profile used by CLI/TOML facing APIs.

Classes

Profile(value[, names, module, qualname, ...])

Visibility profile for a configuration field.