API Reference

This page mirrors the hydromodpy package layout. Each bullet below links to the dedicated API section where classes, functions, and modules are documented.

Module overview

• hydromodpy.watershed – watershed extraction, basin descriptors (geography, geology, hydraulics, climate, hydrography, etc.), and the main hydromodpy.watershed_root.Watershed object.

• hydromodpy.modeling – preprocessing / processing / post-processing helpers for MODFLOW, MODPATH, surface mass-transfer routing, MT3DMS transport, and time-series utilities.

• hydromodpy.display – visualisation routines for descriptors and simulation results plus VTU/VTK exporters.

• hydromodpy.pyhelp – coupling layer with the HELP land-surface model, NetCDF conversion tools, rainfall–runoff post-processing, and CLI entry points.

• hydromodpy.tools – shared toolbox for filesystem helpers, raster reprojection, geomorphology metrics, ERA5 ingestion, and plot presets.

Key entry points

• hydromodpy.watershed_root.Watershed – main object orchestrating every example (accessible via hydromodpy.watershed_root).

Detailed documentation

• hydromodpy.watershed
  • Class overview
• hydromodpy.modeling
  • Class overview
• hydromodpy.display
  • Overview
• hydromodpy.pyhelp
  • Overview
• hydromodpy.tools
  • Toolbox overview