hmp.compare_pair

Compare two simulations by id or result object.

Signature

hmp.compare_pair(sim_a, sim_b, *, workspace=None) -> pandas.DataFrame

Reference

hydromodpy.compare_pair(sim_a, sim_b, *, workspace=None)

Compare two simulations by id or result object.

Return type:

Any

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

Example

import hydromodpy as hmp

table = hmp.compare_pair("ab12cd34", "ef56gh78", workspace="~/hmp_workspace")

See Also

• hydromodpy.compare() – comparison workflow driven by a TOML config.

• hydromodpy.open() – open a workspace to resolve simulation ids.

• hydromodpy.analysis.comparison – comparison package.