energytrackr.plot.builtin_plots package

Submodules

energytrackr.plot.builtin_plots.bootstrap_comparison module

BootstrapComparison using BasePlot and mixins for cleaner composition.

class energytrackr.plot.builtin_plots.bootstrap_comparison.BootStats(counts: list[int], lefts: list[float], rights: list[float], low_ci: float, high_ci: float)

Bases: NamedTuple

Statistical summary for bootstrap CI histogram.

counts: list[int]

Alias for field number 0

high_ci: float

Alias for field number 4

lefts: list[float]

Alias for field number 1

low_ci: float

Alias for field number 3

rights: list[float]

Alias for field number 2

class energytrackr.plot.builtin_plots.bootstrap_comparison.BootstrapComparison

Bases: ComparisonBase

Interactive bootstrap CI histogram for Δ-median between two commits.

energytrackr.plot.builtin_plots.boxplot_comparison module

This module implements the BoxplotComparison plot for energytrackr.

BoxplotComparison using BasePlot and composable mixins for cleaner architecture, with notches, median-connecting line, and full/raw data sources restored.

class energytrackr.plot.builtin_plots.boxplot_comparison.BoxplotComparison

Bases: ComparisonBase

Interactive boxplot comparison for two selected commits.

• quartiles & whiskers

• notches around medians

• dashed line connecting medians

• full & raw data sources for dynamic JS callbacks

• tilted x-axis labels for readability

class energytrackr.plot.builtin_plots.boxplot_comparison.SingleStats(commit: str, quartiles: tuple[float, float, float], whiskers: tuple[float, float], notch: tuple[float, float])

Bases: object

Statistical summary for a commit: quartiles, whiskers, and notch bounds.

commit: str

notch: tuple[float, float]

quartiles: tuple[float, float, float]

whiskers: tuple[float, float]

energytrackr.plot.builtin_plots.change_point_comparison module

ChangePointComparison using BasePlot and mixins for cleaner composition.

class energytrackr.plot.builtin_plots.change_point_comparison.ChangePointComparison(**params: dict[str, Any])

Bases: FontMixin, HoverMixin, BasePlot, Configurable[ChangePointComparisonConfig]

Renders a median-trend plot with change-point detection overlays.

class energytrackr.plot.builtin_plots.change_point_comparison.ChangePointComparisonConfig(objects: list[str] = <factory>)

Bases: object

Configuration for the ChangePointComparison plot.

objects: list[str]

energytrackr.plot.builtin_plots.cusum_comparison module

CUSUMComparison using BasePlot and mixins with refactored stats dataclasses.

class energytrackr.plot.builtin_plots.cusum_comparison.CUSJStats(cusum_pos_j: ndarray[tuple[int, ...], dtype[float64]], cusum_neg_j: ndarray[tuple[int, ...], dtype[float64]], cusum_net_j: ndarray[tuple[int, ...], dtype[float64]], upper_j: float)

Bases: object

Joule-based CUSUM statistics.

cusum_neg_j: ndarray[tuple[int, ...], dtype[float64]]

cusum_net_j: ndarray[tuple[int, ...], dtype[float64]]

cusum_pos_j: ndarray[tuple[int, ...], dtype[float64]]

upper_j: float

class energytrackr.plot.builtin_plots.cusum_comparison.CUSPctStats(cusum_pos_pct: ndarray[tuple[int, ...], dtype[float64]], cusum_neg_pct: ndarray[tuple[int, ...], dtype[float64]], cusum_net_pct: ndarray[tuple[int, ...], dtype[float64]], upper_pct: float)

Bases: object

Percentage-based CUSUM statistics.

cusum_neg_pct: ndarray[tuple[int, ...], dtype[float64]]

cusum_net_pct: ndarray[tuple[int, ...], dtype[float64]]

cusum_pos_pct: ndarray[tuple[int, ...], dtype[float64]]

upper_pct: float

class energytrackr.plot.builtin_plots.cusum_comparison.CUSStats(medians: ndarray[tuple[int, ...], dtype[float64]], diffs: ndarray[tuple[int, ...], dtype[float64]], sigma: float, j: CUSJStats, pct: CUSPctStats)

Bases: object

All the series we need for CUSUM Comparison.

diffs: ndarray[tuple[int, ...], dtype[float64]]

j: CUSJStats

medians: ndarray[tuple[int, ...], dtype[float64]]

pct: CUSPctStats

sigma: float

class energytrackr.plot.builtin_plots.cusum_comparison.CUSUMComparison(**params: dict[str, Any])

Bases: FontMixin, HoverMixin, BasePlot, Configurable[CUSUMComparisonConfig]

Enhanced CUSUM chart with both original areas and net-difference shading.

class energytrackr.plot.builtin_plots.cusum_comparison.CUSUMComparisonConfig(objects: list[str] = <factory>)

Bases: object

Configuration for the CUSUMComparison plot.

objects: list[str]

energytrackr.plot.builtin_plots.ecdf_comparison module

ECDFComparison using BasePlot and mixins for cleaner composition.

class energytrackr.plot.builtin_plots.ecdf_comparison.ECDFComparison

Bases: ComparisonBase

Interactive ECDF comparison between two selected commits.

energytrackr.plot.builtin_plots.evolution_plot module

EvolutionPlot module with commit-zoom selector and fixed y-axis.

class energytrackr.plot.builtin_plots.evolution_plot.EvolutionPlot(**params: dict[str, Any])

Bases: SingleCommitZoomMixin, FontMixin, BasePlot, Configurable[EvolutionPlotConfig]

Energy-per-commit evolution plot with commit zoom and fixed y-axis.

class energytrackr.plot.builtin_plots.evolution_plot.EvolutionPlotConfig(template: str = 'templates/base_plot.html', objects: list[str] = <factory>, zoom_window: int = 5)

Bases: object

Configuration for EvolutionPlot, including how wide the zoom box is.

objects: list[str]

template: str = 'templates/base_plot.html'

zoom_window: int = 5

energytrackr.plot.builtin_plots.mixins module

Reusable mixin classes for common plot behavior.

class energytrackr.plot.builtin_plots.mixins.ColorbarMixin

Bases: object

Adds a Viridis palette colorbar on the right.

class energytrackr.plot.builtin_plots.mixins.CommitSelectorsMixin

Bases: object

Adds two Autocomplete selectors for commit A/B with JS callback wiring.

class energytrackr.plot.builtin_plots.mixins.ComparisonBase

Bases: CommitSelectorsMixin, FontMixin, HoverMixin, BasePlot

Abstract base for any “compare-two commits” plot.

class energytrackr.plot.builtin_plots.mixins.FontMixin

Bases: object

Configures consistent fonts for axes and title.

class energytrackr.plot.builtin_plots.mixins.HoverMixin

Bases: object

Adds a hover tool to the first data renderer with custom tooltips.

class energytrackr.plot.builtin_plots.mixins.RangeToolMixin

Bases: object

Adds a drag-to-zoom minimap under the chart.

class energytrackr.plot.builtin_plots.mixins.SingleCommitZoomMixin

Bases: object

Adds an AutocompleteInput to zoom the x-range around one commit.

energytrackr.plot.builtin_plots.mixins.draw_additional_objects(objects: list[str], fig: figure, ctx: Context) → None

Draw additional plot objects on the figure.

Parameters:

• objects (list[str]) – List of object names to be drawn.

• fig (figure) – The Bokeh figure object.

• ctx (Context) – The context object containing the data and configuration.

energytrackr.plot.builtin_plots.mixins.get_labels_and_dists(ctx: Context) → tuple[list[str], list[ndarray]]

Extracts and returns the labels and corresponding distributions from the given context.

Parameters:

ctx (Context) – The context object containing statistical data and artefacts.

Returns:

A tuple containing a list of short hash labels and a list of distributions.

Return type:

tuple[list[str], list[np.ndarray]]

energytrackr.plot.builtin_plots.mixins.initial_commits(labels: Sequence[str]) → tuple[str, str]

Returns the first and last elements from a sequence of label strings.

Parameters:

labels (Sequence[str]) – A sequence of label strings.

Returns:

A tuple containing the first and last label from the input sequence.

Return type:

tuple[str, str]

energytrackr.plot.builtin_plots.mixins.make_selectors(labels: list[str], js_code_path: str | Path, cb_args: Mapping[str, Any]) → tuple[AutocompleteInput, AutocompleteInput]

Create two AutocompleteInput widgets wired to the same CustomJS callback.

Parameters:

• labels (list[str]) – List of labels to be used for the AutocompleteInput widgets.

• js_code_path (str | Path) – Path to the JavaScript code file for the CustomJS callback.

• cb_args (Mapping[str, Any]) – Additional arguments to be passed to the CustomJS callback.

Returns:

A tuple containing two AutocompleteInput widgets.

Return type:

tuple[AutocompleteInput, AutocompleteInput]

energytrackr.plot.builtin_plots.qq_comparison module

QQComparison using BasePlot and mixins for cleaner composition.

class energytrackr.plot.builtin_plots.qq_comparison.QQComparison

Bases: CommitSelectorsMixin, FontMixin, ColorbarMixin, HoverMixin, BasePlot

Interactive QQ-plot comparing two commits with percentile coloring and tooltips.

energytrackr.plot.builtin_plots.registry module

Registry for BasePlot subclasses, enabling automatic discovery of available plots.

energytrackr.plot.builtin_plots.registry.get_registered_plots() → dict[str, type[BasePlot]]

Return mapping of plot names to BasePlot subclasses.

Returns:

Mapping of plot names to BasePlot subclasses.

Return type:

dict[str, type[BasePlot]]

energytrackr.plot.builtin_plots.registry.register_plot(plot_cls: type[BasePlot]) → type[BasePlot]

Class decorator to register a BasePlot subclass.

Usage:

@register_plot
class MyPlot(BasePlot): ...

Registered under its class name.

Parameters:

plot_cls (type[BasePlot]) – A subclass of BasePlot

Returns:

The registered plot class.

Return type:

type[BasePlot]

Raises:

PlotAlreadyRegisteredError – If the plot class is already registered.

energytrackr.plot.builtin_plots.violin_comparison module

ViolinComparison using BasePlot and mixins for cleaner composition.

class energytrackr.plot.builtin_plots.violin_comparison.ViolinComparison

Bases: ComparisonBase

Interactive violin plot comparing two selected commits with hover tooltips.

Module contents

Builtin plots for energytrackr.