runmanager.remote.Client

class runmanager.remote.Client(host=None, port=None, timeout=None)

Bases: ZMQClient

A ZMQClient for communication with runmanager

__init__(host=None, port=None, timeout=None)

Methods

__init__([host, port, timeout])
abort()	Trigger abort compilation/submission
clear_interrupt()	Clear our internal Interruptor object so that future get*()/push*() calls can proceed as normal.
engage()	Trigger shot compilation/submission
error_in_globals()	True if any tab of an active group contains error(s)
get_globals([raw])	Return all active globals as a dict of the form: {'<global_name>': value}.
get_labscript_file()	Get the path of the current experiment script
get_run_shots()	Get boolean state of 'Run shot(s)' checkbox
get_shot_output_folder()	Get the current shot output folder
get_shuffle()	Get boolean state of 'Shuffle' checkbox
get_version()	Return the version of runmanager the server is running in
get_view_shots()	Get boolean state of 'View shot(s)' checkbox
instance()
interrupt([reason])	Interrupt any current and future get*()/push*() calls, causing them to raise Interrupted(reason) until clear_interrupt() is called.
is_output_folder_default()	True if shot output folder is not the default path
n_shots()	Get the number of prospective shots from pressing 'Engage'
request(command, *args, **kwargs)
reset_shot_output_folder()	Reset the shot output folder to the default path
say_hello()	Ping the runmanager server for a response
set_globals(globals[, raw])	For a dict of the form {'<global_name>': value}, set the given globals to the given values.
set_labscript_file(value)	Set the current experiment script
set_run_shots(value)	Set boolean state of 'Run shot(s)' checkbox
set_shot_output_folder(value)	Set the shot output folder
set_shuffle(value)	Set boolean state of 'Shuffle' checkbox
set_view_shots(value)	Set boolean state of 'View shot(s)' checkbox

abort()

Trigger abort compilation/submission

engage()

Trigger shot compilation/submission

error_in_globals()

True if any tab of an active group contains error(s)

get_globals(raw=False)

Return all active globals as a dict of the form: {‘<global_name>’: value}. If raw=True, then the global values are returned as their string representations, as stored in the runmanager GUI and globals HDF5 file, otherwise they are evaluated as python objects and then returned.

get_labscript_file()

Get the path of the current experiment script

get_run_shots()

Get boolean state of ‘Run shot(s)’ checkbox

get_shot_output_folder()

Get the current shot output folder

get_shuffle()

Get boolean state of ‘Shuffle’ checkbox

get_version()

Return the version of runmanager the server is running in

get_view_shots()

Get boolean state of ‘View shot(s)’ checkbox

is_output_folder_default()

True if shot output folder is not the default path

n_shots()

Get the number of prospective shots from pressing ‘Engage’

request(command, *args, **kwargs)

reset_shot_output_folder()

Reset the shot output folder to the default path

say_hello()

Ping the runmanager server for a response

set_globals(globals, raw=False)

For a dict of the form {‘<global_name>’: value}, set the given globals to the given values. If raw=True, then global values will be treated as the string representations of Python objects rather than the objects themselves, and written directly to the HDF5 file and runmanager GUI without calling repr() on them first.

set_labscript_file(value)

Set the current experiment script

set_run_shots(value)

Set boolean state of ‘Run shot(s)’ checkbox

set_shot_output_folder(value)

Set the shot output folder

set_shuffle(value)

Set boolean state of ‘Shuffle’ checkbox

set_view_shots(value)

Set boolean state of ‘View shot(s)’ checkbox