compare_pair#

hydromodpy.compare_pair(sim_a, sim_b, *, workspace=None)[source]#

Compare two simulations by id or result object.

Return type:

Parameters:

sim_a (Any)
sim_b (Any)
workspace (Any)

Parameters#

sim_a, sim_b: Simulation ids or objects accepted by the comparison runtime.
workspace: Optional workspace used to resolve simulation ids.

Returns#

pandas.DataFrame: Side-by-side comparison table.

Raises#

hydromodpy.results.errors.RunNotFoundError: If either simulation id cannot be resolved in the workspace.

Examples#

>>> import hydromodpy as hmp
>>> table = hmp.compare_pair(
...     "ab12cd34", "ef56gh78", workspace="~/hmp_workspace"
... )  

See Also#

hydromodpy.analysis.comparison: Comparison package used by this helper.

param sim_a:
type sim_a:: Any
param sim_b:
type sim_b:: Any
param workspace:
type workspace:: Any