Skip to content

comparison

fusdb.plotting.comparison

Grouped-bar comparison of scalar metrics across cases.

Generalises the operational-limit utilisation bars in the profile-optimisation example and is reusable for any per-case scalar comparison (e.g. comparing the same metrics across several reactors).

plot_metric_comparison

plot_metric_comparison(cases: Mapping[str, Mapping[str, float]], *, ax: Axes | None = None, reference: float | None = None, annotate: bool = True, ylabel: str | None = None, title: str | None = None, **bar_kw: Any) -> Axes

Compare scalar metrics across named cases as grouped bars.

Parameters:

Name Type Description Default
cases Mapping[str, Mapping[str, float]]

Mapping of case label -> {metric: value}. The union of metric names (first-seen order) defines the x groups.

required
reference float | None

Optional horizontal reference line (e.g. 1.0 for limits).

None
annotate bool

When True, label each bar with its value.

True
ylabel str | None

Optional y-axis label.

None
title str | None

Optional axis title.

None
**bar_kw Any

Forwarded to Axes.bar.

{}

Returns:

Type Description
Axes

The axis the bars were drawn on.