quantify_scheduler.instrument_coordinator.components.base

Module containing the InstrumentCoordinator interface.

Module Contents

Classes

InstrumentCoordinatorComponentBase

The InstrumentCoordinator component abstract interface.

Functions

instrument_to_component_name(→ str)

Gives the name of the instrument coordinator component.

instrument_to_component_name(instrument_name: str) → str

Gives the name of the instrument coordinator component.

Parameters

instrument_name – The name of the instrument.

Returns

The name of the instrument coordinator component.

class InstrumentCoordinatorComponentBase(instrument: qcodes.instrument.base.InstrumentBase, **kwargs: Any)

Bases: qcodes.instrument.base.Instrument

The InstrumentCoordinator component abstract interface.

_no_gc_instances :Dict[str, InstrumentCoordinatorComponentBase]

close() → None

Makes sure the instances reference is released so that garbage collector can claim the object

property instrument → qcodes.instrument.base.InstrumentBase

Returns the instrument referenced by instrument_ref.

property is_running → bool

Returns if the InstrumentCoordinator component is running.

The property is_running is evaluated each time it is accessed. Example:

while my_instrument_coordinator_component.is_running:
    print('running')

Returns

The components’ running state.

abstract start() → None

Starts the InstrumentCoordinator Component.

abstract stop() → None

Stops the InstrumentCoordinator Component.

abstract prepare(options: Any) → None

Initializes the InstrumentCoordinator Component with parameters.

abstract retrieve_acquisition() → Any

Gets and returns acquisition data.

abstract wait_done(timeout_sec: int = 10) → None

Waits until the InstrumentCoordinator component has stopped running or until it has exceeded the amount of time to run.

The maximum amount of time, in seconds, before it times out is set via the timeout_sec parameter.

Parameters

timeout_sec – The maximum amount of time in seconds before a timeout.