bloc.boulder_plugins

Boulder plugins for Bloc.

This package contains Bloc-specific plugins for Boulder, including output pane plugins.

Submodules

• bloc.boulder_plugins.register
• bloc.boulder_plugins.resdict_summary_builder
• bloc.boulder_plugins.schemas

Classes

ResDictSummaryBuilder

Summary builder that prefers external res_dic results.

Functions

register_plugins(plugins)

Boulder entry-point hook (boulder.plugins group in pyproject.toml).

Package Contents

bloc.boulder_plugins.register_plugins(plugins)

Boulder entry-point hook (boulder.plugins group in pyproject.toml).

Called by the boulder CLI / GUI plugin discovery system. Registers both solver-local plugins and process-global UI singletons.

Parameters:

plugins – BoulderPlugins instance provided by Boulder’s discovery machinery.

class bloc.boulder_plugins.ResDictSummaryBuilder

Bases: boulder.summary_builder.SummaryBuilder

Summary builder that prefers external res_dic results.

If no external results are available, it provides a basic summary from the running simulation.

property builder_id: str

Unique identifier for this summary builder.

property name: str

Human-readable name for this summary builder.

is_compatible(context)

Check if this builder is compatible with the given simulation context.

Args:

context: Current context information

Return type:

True if the builder can process this simulation, False otherwise

build_summary(context)

Build summary data from the simulation context.

Args:

context: Current context information

Returns:

• List of summary entries, each containing

• - reactor (reactor name (optional))

• - quantity (quantity name)

• - label (display label)

• - value (numeric value or string)

• - unit (unit string (optional))