NUPyLab Procedure

class nupylab.utilities.nupylab_procedure.NupylabProcedure

Bases: Procedure

Base Procedure for NUPyLab GUI procedures to subclass.

Subclass procedures must define DATA_COLUMNS and TABLE_PARAMETERS attributes, as well as a set_instruments method. Attributes X_AXIS, Y_AXIS, and INPUTS are expected but not strictly required.

Running this procedure or its subclasses calls startup, execute, and shutdown methods sequentially.

Attrs:

previous_procedure: Nupylab Procedure class from previous step. Maintains

previous instrument connections.

Initialize default data and instrument list.

TABLE_PARAMETERS: Dict[str, str] = {}

current_step = <IntegerParameter(name=Current Step,value=None,units=None,default=None)>

execute() → None

Loop through thread for each instrument and emit results.

property finished

Get whether all active instruments are finished measuring.

num_steps = <IntegerParameter(name=Number of Measurement Steps,value=None,units=None,default=None)>

property progress: float

Get procedure step progress, from 0-100. Overwrite in subclass.

record_time = <FloatParameter(name=Record Time,value=2.0,units=s,default=2.0)>

set_instruments() → None

Set instrument connections.

shutdown() → None

Shut down instruments if all steps have run or there was an error.

startup() → None

Connect and initialize instruments.