hmp.report#

Render the HTML report for a calibration session.

Signature#

hmp.report(session_id_or_prefix=None, *, workspace=None) -> Any

Reference#

hydromodpy.report(session_id_or_prefix=None, *, workspace=None)[source]

Render the HTML report for a calibration session.

session_id_or_prefix accepts a full UUID, a unique hex prefix, or None to fall back to the most recently started session. workspace defaults to the nearest ancestor of the current working directory containing catalog.duckdb.

Return type:

Any

Parameters:

session_id_or_prefix (Any)
workspace (Any)

Parameters#

session_id_or_prefix: Full session UUID, unique hex prefix, or None for the latest session.
workspace: Optional workspace directory.

Returns#

Any: Report rendering result.

Raises#

hydromodpy.results.errors.RunNotFoundError: If no calibration session matches session_id_or_prefix.
hydromodpy.core.exceptions.DisplayError: If the report template or one of its figures fails to render.

Examples#

>>> import hydromodpy as hmp
>>> hmp.report()  # latest session in the current workspace  
>>> hmp.report("ab12cd34", workspace="~/hmp_workspace")  

param session_id_or_prefix:
type session_id_or_prefix:: Any
param workspace:
type workspace:: Any

Example#

import hydromodpy as hmp

# Latest session in the nearest workspace
hmp.report()

# Explicit session and workspace
hmp.report("ab12cd34", workspace="~/hmp_workspace")