bloc.boulder_plugins#

Boulder plugins for Bloc.

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

Submodules#

Classes#

ResDictSummaryBuilder

Summary builder that prefers external res_dic results.

SpatialOutputPanePlugin

Plugin for creating spatial distributions of reactor properties.

Functions#

register_plugins(plugins)

Register all Boulder plugins from Bloc.

Package Contents#

bloc.boulder_plugins.register_plugins(plugins)#

Register all Boulder plugins from Bloc.

This is the main entry point called by Boulder’s plugin discovery system. It registers both reactor builders and output pane plugins.

Args:

plugins: BoulderPlugins instance to register plugins with

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))

class bloc.boulder_plugins.SpatialOutputPanePlugin#

Bases: boulder.output_pane_plugins.OutputPanePlugin

Plugin for creating spatial distributions of reactor properties.

property plugin_id: str#

Unique identifier for this plugin.

property tab_label: str#

Label to display on the tab.

property tab_icon: str | None#

Optional icon for the tab (Bootstrap icon class).

property requires_selection: bool#

Whether this plugin requires a reactor/element to be selected.

property supported_element_types: List[str]#

List of element types this plugin supports.

is_available(context)#

Check if spatial analysis is available for the selected reactor.

create_content_data(context)#

Create JSON-serializable content for the spatial output pane.

Returns a grid with two plotly items (temperature + species).

get_callbacks()#

Return list of callbacks this plugin needs.

Returns:

List of tuples: (outputs, inputs, callback_function).

Return type:

list

on_simulation_update(context)#

Handle simulation data update.

Parameters:

context – Updated context information.

Returns:

Optional dictionary of updates to apply to components.

Return type:

dict or None