Object-oriented patterns#
HydroModPy ships two complementary surfaces:
A functional facade – top-level verbs under
hydromodpy._api(hmp.run,hmp.report,hmp.open) that take a TOML path or a config object and return a result.An object-oriented facade –
hydromodpy.project.Projectfor setup-once, run-many workflows plus accessor objects for the input cache, the run catalog and the persisted artefact store.
This chapter documents the object surface: how Project is built,
how its state is encapsulated, how to navigate runs and data, and how the
catalog opened via hmp.open exposes runs and results.
For the verb surface, see Python API.
See Also#
hydromodpy.project.Project– public facade.hydromodpy.project.state.ProjectState– typed runtime container.hydromodpy.results.catalog.SimulationCatalog– workspace catalog.