waveform_editor.gui.shape_editor.coil_currents.CoilCurrents¶

class waveform_editor.gui.shape_editor.coil_currents.CoilCurrents(main_gui, **params)¶

Bases: Viewer

__init__(main_gui, **params)¶

Methods

__init__(main_gui, **params)
create_ui(pf_active)	Create the UI for each coil in the provided pf_active IDS.
fill_pf_active(pf_active)	Update the coil currents of the provided pf_active IDS.
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.
sync_ui_with_pf_active(pf_active)	Synchronize UI with the current values from the pf_active IDS.
update_fixed_coils_in_xml(xml_params)	Update XML parameters indicating which coils are fixed based on UI checkboxes.

Attributes

COIL_NAME
CURRENT
FIX_CURRENT
PREV_CURRENT
coils
export_time
name
param

create_ui(pf_active)¶

Create the UI for each coil in the provided pf_active IDS.

Parameters:

pf_active¶

pf_active IDS containing coils with current values.

fill_pf_active(pf_active)¶

Update the coil currents of the provided pf_active IDS. Only coils with their fix checkbox checked are updated. Also stores current values as previous_current before the NICE run.

Parameters:

pf_active¶

pf_active IDS to update the coil currents for.

servable(title: str | None = None, location: bool | Location = True, area: str = 'main', target: str | None = None) → Viewable¶

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.

Parameters¶

titlestr

A string title to give the Document (if served as an app)

locationboolean or panel.io.location.Location

Whether to create a Location component to observe and set the URL location.

area: str (deprecated)

The area of a template to add the component too. Only has an effect if pn.config.template has been set.

target: str

Target area to write to. If a template has been configured on pn.config.template this refers to the target area in the template while in pyodide this refers to the ID of the DOM node to write to.

Returns¶

The Panel object itself

show(title: str | None = None, port: int = 0, address: str | None = None, websocket_origin: str | None = None, threaded: bool = False, verbose: bool = True, open: bool = True, location: bool | Location = True, **kwargs) → threading.Thread | Server¶

Starts a Bokeh server and displays the Viewable in a new tab.

Parameters¶

titlestr | None

A string title to give the Document (if served as an app)

port: int (optional, default=0)

Allows specifying a specific port

addressstr

The address the server should listen on for HTTP requests.

websocket_origin: str or list(str) (optional)

A list of hosts that can connect to the websocket. This is typically required when embedding a server app in an external web site. If None, "localhost" is used.

threaded: boolean (optional, default=False)

Whether to launch the Server on a separate thread, allowing interactive use.

verbose: boolean (optional, default=True)

Whether to print the address and port

openboolean (optional, default=True)

Whether to open the server in a new browser tab

locationboolean or panel.io.location.Location

Whether to create a Location component to observe and set the URL location.

Returns¶

server: bokeh.server.Server or panel.io.server.StoppableThread

Returns the Bokeh server instance or the thread the server was launched on (if threaded=True)

sync_ui_with_pf_active(pf_active)¶

Synchronize UI with the current values from the pf_active IDS.

Parameters:

pf_active¶

pf_active IDS for which the coil currents are used.

update_fixed_coils_in_xml(xml_params: Element)¶

Update XML parameters indicating which coils are fixed based on UI checkboxes.

Parameters:

xml_params: Element¶

XML representing configuration parameters, which are updated in-place.