aquakin.ScenarioComparison

class aquakin.ScenarioComparison(scenario_names, input_names, output_names, inputs, outputs)

Bases: object

Result of compare_scenarios(): KPIs per named scenario.

Variables:

• scenario_names (list[str]) – The scenarios, row order of outputs / inputs.

• output_names (input_names,) – Names of the input and output columns.

• inputs (np.ndarray) – (n_scenarios, d) input vector used for each scenario.

• outputs (np.ndarray) – (n_scenarios, m) outputs.

Parameters:

• scenario_names (list[str])

• input_names (list[str])

• output_names (list[str])

• inputs (ndarray)

• outputs (ndarray)

__init__(scenario_names, input_names, output_names, inputs, outputs)

Parameters:

• scenario_names (list[str])

• input_names (list[str])

• output_names (list[str])

• inputs (ndarray)

• outputs (ndarray)

Return type:

None

Methods

__init__(scenario_names, input_names, ...)
best(output, *[, minimize])	The scenario name with the lowest (or highest) value of output.
output_named(name)	The output name across scenarios, shape (n_scenarios,).
table()	A human-readable KPI table, one row per scenario.

Attributes

scenario_names
input_names
output_names
inputs
outputs

output_named(name)

The output name across scenarios, shape (n_scenarios,).

Parameters:

name (str)

Return type:

ndarray

best(output, *, minimize=True)

The scenario name with the lowest (or highest) value of output.

Parameters:

• output (str)

• minimize (bool)

Return type:

str

table()

A human-readable KPI table, one row per scenario.

Return type:

str