reno.explorer.RunsList

class reno.explorer.RunsList(*, name)

Bases: Viewer

Collection of RunRows, tracks and allows choosing which previous runs to include in main view for current tab.

Methods

__init__(**params)
add_run(config, trace, observations)	Create a new RunRow with the passed configuration and data.
fire_on_selected_runs_changed(runs)	Trigger all registered callbacks for the selected_runs_changed event.
from_dict(data)	Deserialize into this instance every run found in the passed data dictionary.
get_selected_runs()	Collect all runrows that are set to display, returns a tuple with the name of the run, dictionary config for it, and the xarray dataset with the simulation data.
on_selected_runs_changed(callback)	Register a function to execute when the set of simulation runs selected to display is changed.
refresh_rows()	Update the layout to show all runrows.
servable([title, location, area, target])	Serves the object or adds it to the configured pn.state.template if in a panel serve context, writes to the DOM if in a pyodide context and returns the Panel object to allow it to display itself in a notebook context.
show([title, port, address, ...])	Starts a Bokeh server and displays the Viewable in a new tab.
to_dict()	Serialize all runs into a dictionary that can be saved to a file.

Attributes

name
param

__annotations__ = {}

__module__ = 'reno.explorer'

__panel__()

Subclasses should return a Panel component to be rendered.

add_run(config, trace, observations)

Create a new RunRow with the passed configuration and data.

Parameters:

trace (Dataset)

fire_on_selected_runs_changed(runs)

Trigger all registered callbacks for the selected_runs_changed event.

Parameters:

runs (list[tuple[str, dict, Dataset]])

from_dict(data)

Deserialize into this instance every run found in the passed data dictionary.

Parameters:

data (dict)

get_selected_runs()

Collect all runrows that are set to display, returns a tuple with the name of the run, dictionary config for it, and the xarray dataset with the simulation data.

Return type:

list[tuple[str, dict, Dataset]]

name = 'RunsList'

on_selected_runs_changed(callback)

Register a function to execute when the set of simulation runs selected to display is changed.

Callbacks should take a list of tuples where each tuple contains: * the string name of the run * the dictionary with the run config * an xarray dataset with the full trace/simulation data.

Parameters:

callback (Callable)

refresh_rows()

Update the layout to show all runrows.

to_dict()

Serialize all runs into a dictionary that can be saved to a file.

Return type:

dict