quantify_scheduler.instrument_coordinator.components.generic

Module containing a Generic InstrumentCoordinator Component.

Module Contents

Classes

GenericInstrumentCoordinatorComponent

A Generic class which can be used for interaction with the InstrumentCoordinator.

Attributes

logger
DEFAULT_NAME

logger

DEFAULT_NAME = 'generic'

class GenericInstrumentCoordinatorComponent(instrument_reference: Union[str, qcodes.instrument.base.InstrumentBase] = DEFAULT_NAME)

Bases: quantify_scheduler.instrument_coordinator.components.base.InstrumentCoordinatorComponentBase

A Generic class which can be used for interaction with the InstrumentCoordinator.

The GenericInstrumentCoordinatorComponent should be able to accept any type of qcodes instrument. The component is meant to serve as an interface for simple access to instruments such as the local oscillator, or current source which needs to only set parameters. For now this component is not being used in any of the hardware backends’ compilation step. This will be fixed in the next official release.

Instantiates the InstrumentCoordinatorComponentBase base class.

abstract property instrument

Overwrite the instrument method. There is no instrument for the GenericInstrumentCoordinatorComponent class.

property is_running: bool

The is_running state refers to a state whether an instrument is capable of running in a program. Not to be confused with the on/off state of an instrument.

_no_gc_instances: Dict[str, quantify_scheduler.instrument_coordinator.components.base.InstrumentCoordinatorComponentBase]

start() → None

Starts the InstrumentCoordinator Component.

stop() → None

Stops the InstrumentCoordinator Component.

prepare(params_config: Dict[str, Any]) → None

params_config has keys which should correspond to parameter names of the instrument and the corresponding values to be set. Always ensure that the key to the params_config is in the format ‘instrument_name.parameter_name’ For example,

params_config = {
                 "lo_mw_q0.frequency": 6e9,
                 "lo_mw_q0.power": 13, "lo_mw_q0.status": True,
                 "lo_ro_q0.frequency": 8.3e9, "lo_ro_q0.power": 16,
                 "lo_ro_q0.status": True,
                 "lo_spec_q0.status": False,
                }

_set_params_to_devices(params_config) → None

This function sets the parameters in the params_config dict to the generic devices set in the hardware_config. The bool force_set_parameters is used to change the lazy_set behaviour.

retrieve_acquisition() → Any

Gets and returns acquisition data.

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.