bloc.boulder_plugins.spatial_output_pane

Spatial Output Pane Plugin for Boulder (React).

This plugin creates spatial distributions for reactors with length properties by converting length to residence time and running spatial simulations. Returns JSON-serializable data rendered by Boulder’s React frontend.

Classes

SpatialOutputPanePlugin

Plugin for creating spatial distributions of reactor properties.

Module Contents

class bloc.boulder_plugins.spatial_output_pane.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