QCM-QRM API#

The QCM/QRM module is responsible for adding the parameters to a single module of a Cluster using add_qcodes_params() and QcmQrm respectively. The resulting parameters are module type dependent and are described at the bottom of this page. Each module also adds the parameters for 6 sequencers, the parameters of which are described in Sequencer API.

class qblox_instruments.qcodes_drivers.qcm_qrm.QcmQrm(parent: Instrument, name: str, slot_idx: int)[source]#

Bases: InstrumentChannel

This class represents a QCM/QRM module. It combines all module specific parameters and functions into a single QCoDes InstrumentChannel.

__init__(parent: Instrument, name: str, slot_idx: int)[source]#

Creates a QCM/QRM module class and adds all relevant parameters for the module.

Parameters:

  • parent (Instrument) – The QCoDeS class to which this module belongs.

  • name (str) – Name of this module channel

  • slot_idx (int) – The index of this module in the parent instrument, representing which module is controlled by this class.

property slot_idx: int#

Get slot index.

Returns:

Slot index

Return type:

int

property module_type: InstrumentType#

Get module type (e.g. QRM, QCM).

Returns:

Module type

Return type:

InstrumentType

Raises:

KeyError – Module is not available.

property is_qcm_type: bool#

Return if module is of type QCM.

Returns:

True if module is of type QCM.

Return type:

bool

Raises:

KeyError – Module is not available.

property is_qrm_type: bool#

Return if module is of type QRM.

Returns:

True if module is of type QRM.

Return type:

bool

Raises:

KeyError – Module is not available.

property is_rf_type: bool#

Return if module is of type QCM-RF or QRM-RF.

Returns:

True if module is of type QCM-RF or QRM-RF.

Return type:

bool

Raises:

KeyError – Module is not available.

property sequencers: List#

Get list of sequencers submodules.

Returns:

List of sequencer submodules.

Return type:

list

qblox_instruments.qcodes_drivers.qcm_qrm.add_qcodes_params(parent: Instrument | QcmQrm, num_seq: int) → None[source]#

Add all QCoDeS parameters for a single QCM/QRM module.

Parameters:

  • parent (Union[Instrument, QcmQrm]) – Parent object to which the parameters need to be added.

  • num_seq (int) – Number of sequencers to add as submodules.

qblox_instruments.qcodes_drivers.qcm_qrm.invalidate_qcodes_parameter_cache(parent: Instrument | QcmQrm, sequencer: int | None = None) → None[source]#

Marks the cache of all QCoDeS parameters in the module as invalid, including in any sequencer submodules the module might have. Optionally, a sequencer can be specified. This will invalidate the cache of that sequencer only in stead of all parameters.

Parameters:

  • parent (Union[Instrument, QcmQrm]) – Parent module object for which to invalidate the QCoDeS parameters.

  • sequencer (Optional[int]) – Sequencer index of sequencer for which to invalidate the QCoDeS parameters.

qblox_instruments.qcodes_drivers.qcm_qrm.get_item(parent: Instrument | QcmQrm, key: str) → InstrumentChannel | Parameter | Callable[[Any], Any][source]#

Get submodule or parameter using string based lookup.

Parameters:

  • parent (Union[Instrument, QcmQrm]) – Parent module object to search.

  • key (str) – submodule, parameter or function to retrieve.

Returns:

Submodule, parameter or function.

Return type:

Union[InstrumentChannel, Parameter, Callable[[Any], Any]]

Raises:

KeyError – Submodule, parameter or function does not exist.

Note

On this page, QRM, QCM, QRM_RF, QCM_RF refer to instances of QcmQrm of the respective module type.

Cluster QCoDeS parameters#

QCoDeS parameters generated by QcmQrm.

Cluster QCM parameters#

QCM.present()#

Sets/gets module present status for slot {} in the Cluster.

Properties:

  • value: Boolean

QCM.out0_offset()#

Sets/gets output 0 offset

Properties:

  • unit: V

  • value: Numbers -2.5<=v<=2.5

QCM.out1_offset()#

Sets/gets output 1 offset.

Properties:

  • unit: V

  • value: Numbers -2.5<=v<=2.5

QCM.out2_offset()#

Sets/gets output 2 offset.

Properties:

  • unit: V

  • value: Numbers -2.5<=v<=2.5

QCM.out3_offset()#

Sets/gets output 3 offset.

Properties:

  • unit: V

  • value: Numbers -2.5<=v<=2.5

QCM.marker0_inv_en()#

Sets/gets output 0 marker invert enable

Properties:

  • value: Boolean

QCM.marker1_inv_en()#

Sets/gets output 1 marker invert enable

Properties:

  • value: Boolean

QCM.marker2_inv_en()#

Sets/gets output 2 marker invert enable

Properties:

  • value: Boolean

QCM.marker3_inv_en()#

Sets/gets output 3 marker invert enable

Properties:

  • value: Boolean

arm_sequencer(sequencer: int | None = None) → None

Important: This method calls arm_sequencer using functools.partial to set the slot index. The following docstring is of Cluster.arm_sequencer: Prepare the indexed sequencer to start by putting it in the armed state. If no sequencer index is given, all sequencers are armed. Any sequencer that was already running is stopped and rearmed. If an invalid sequencer index is given, an error is set in system error.

Parameters:

sequencer (Optional[int]) – Sequencer index.

Raises:

RuntimeError – An error is reported in system error and debug <= 1. All errors are read from system error and listed in the exception.

connect_sequencer(sequencer: int, *connections: str) → None

Important: This method calls connect_sequencer using functools.partial to set the slot index. The following docstring is of Cluster.connect_sequencer: Makes new connections between the indexed sequencer and some inputs and/or outputs. This will fail if a requested connection already existed, or if the connection could not be made due to a conflict with an existing connection (hardware constraints). In such a case, the channel map will not be affected.

Parameters:

  • slot (int) – Slot index

  • sequencer (int) – Sequencer index

  • *connections (str) – Zero or more connections to make, each specified using a string. The string should have the format <direction><channel> or <direction><I-channel>_<Q-channel>. <direction> must be in to make a connection between an input and the acquisition path, out to make a connection from the waveform generator to an output, or io to do both. The channels must be integer channel indices. If only one channel is specified, the sequencer operates in real mode; if two channels are specified, it operates in complex mode.

Raises:

  • RuntimeError – If the connection command could not be completed due to a conflict.

  • ValueError – If parsing of a connection fails.

delete_acquisition_data(sequencer: int, name: str = '', all: bool = False) → None

Important: This method calls delete_acquisition_data using functools.partial to set the slot index. The following docstring is of Cluster.delete_acquisition_data: Delete data from an acquisition specified by name in the acquisition list of indexed sequencer or delete data in all acquisitions if all is True.

Parameters:

  • sequencer (int) – Sequencer index.

  • name (str) – Weight name

Raises:

NotImplementedError – Functionality not available on this module.

delete_dummy_binned_acquisition_data(sequencer: int | None = None, acq_index_name: str | None = None)

Important: This method calls delete_dummy_binned_acquisition_data using functools.partial to set the slot index. The following docstring is of Cluster.delete_dummy_binned_acquisition_data: Delete all dummy binned acquisition data for the dummy.

Parameters:

  • slot_idx (int) – Slot of the hardware you want to set the data to on a cluster.

  • sequencer (Optional[int]) – Sequencer.

  • acq_index_name (Optional[str]) – Acquisition index name.

delete_dummy_scope_acquisition_data(sequencer: int | None)

Important: This method calls delete_dummy_scope_acquisition_data using functools.partial to set the slot index. The following docstring is of Cluster.delete_dummy_scope_acquisition_data: Delete dummy scope acquisition data for the dummy.

Parameters:

  • slot_idx (int) – Slot of the hardware you want to set the data to on a cluster.

  • sequencer (Union[int, None]) – Sequencer.

disconnect_inputs() → None

Important: This method calls disconnect_inputs using functools.partial to set the slot index. The following docstring is of Cluster.disconnect_inputs: Disconnects all inputs from the acquisition paths of the sequencers.

Parameters:

slot (int) – Slot index

disconnect_outputs() → None

Important: This method calls disconnect_outputs using functools.partial to set the slot index. The following docstring is of Cluster.disconnect_outputs: Disconnects all outputs from the waveform generator paths of the sequencers.

Parameters:

slot (int) – Slot index

get_acquisition_state(sequencer: int, timeout: int = 0, timeout_poll_res: float = 0.02) → bool

Important: This method calls get_acquisition_state using functools.partial to set the slot index. The following docstring is of Cluster.get_acquisition_state: Return acquisition binning completion state of the indexed sequencer. If an invalid sequencer is given, an error is set in system error. If the timeout is set to zero, the function returns the state immediately. If a positive non-zero timeout is set, the function blocks until the acquisition binning completes. If the acquisition hasn’t completed before the timeout expires, a TimeoutError is thrown. Note that when sequencer state checking is enabled, the sequencer state is checked using get_sequencer_state with the selected timeout period first and then the acquisition state is checked with the same timeout period. This means that the total timeout period is two times the set timeout period.

Parameters:

  • sequencer (int) – Sequencer index.

  • timeout (int) – Timeout in minutes.

  • timeout_poll_res (float) – Timeout polling resolution in seconds.

  • check_seq_state (bool) – Check if sequencer is done before checking acquisition state.

Returns:

Indicates the acquisition binning completion state (False = uncompleted, True = completed).

Return type:

bool

Raises:
get_acquisitions(sequencer: int) → Dict

Important: This method calls get_acquisitions using functools.partial to set the slot index. The following docstring is of Cluster.get_acquisitions: Get all acquisitions in acquisition lists of indexed sequencer. The acquisition scope and bin data is normalized to a range of -1.0 to 1.0 taking both the bit widths of the processing path and average count into considaration. For the binned integration results, the integration length is not handled during normalization and therefore these values have to be divided by their respective integration lenghts. The returned dictionary is structured as follows:

  • name: acquisition name

    • index: acquisition index used by the sequencer Q1ASM program to refer to the acquisition.

    • acquisition: acquisition dictionary

      • scope: Scope data

        • path0: input path 0

          • data: acquisition samples in a range of 1.0 to -1.0.

          • out-of-range: out-of-range indication for the entire acquisition (False = in-range, True = out-of-range).

          • avg_cnt: number of averages.

        • path1: input path 1

          • data: acquisition samples in a range of 1.0 to -1.0.

          • out-of-range: out-of-range indication for the entire acquisition (False = in-range, True = out-of-range).

          • avg_cnt: number of averages.

      • bins: bin data

        • integration: integration data

          • path_0: input path 0 integration result bin list

          • path_1: input path 1 integration result bin list

        • threshold: threshold result bin list

        • valid: list of valid indications per bin

        • avg_cnt: list of number of averages per bin

Parameters:

sequencer (int) – Sequencer index.

Returns:

Dictionary with acquisitions.

Return type:

dict

Raises:

NotImplementedError – Functionality not available on this module.

get_assembler_log() → str

Important: This method calls get_assembler_log using functools.partial to set the slot index. The following docstring is of Cluster.get_assembler_log: Get assembler log.

Parameters:

slot (int) – slot index.

Returns:

Assembler log.

Return type:

str

Raises:

  • Exception – Invalid input parameter type.

  • Exception – An error is reported in system error and debug <= 1. All errors are read from system error and listed in the exception.

get_assembler_status() → bool

Important: This method calls get_assembler_status using functools.partial to set the slot index. The following docstring is of Cluster.get_assembler_status: Get assembler status. Refer to the assembler log to get more information regarding the assembler result.

Parameters:

slot (int) – slot index.

Returns:

Assembler status (False = failed, True = success).

Return type:

bool

Raises:

  • Exception – Invalid input parameter type.

  • Exception – An error is reported in system error and debug <= 1. All errors are read from system error and listed in the exception.

get_sequencer_state(sequencer: int, timeout: int = 0, timeout_poll_res: float = 0.02) → qblox_instruments.native.generic_func.SequencerState

Important: This method calls get_sequencer_state using functools.partial to set the slot index. The following docstring is of Cluster.get_sequencer_state: Get the sequencer state. If an invalid sequencer index is given, an error is set in system error. If the timeout is set to zero, the function returns the state immediately. If a positive non-zero timeout is set, the function blocks until the sequencer completes. If the sequencer hasn’t stopped before the timeout expires, a TimeoutError is thrown.

Parameters:

  • sequencer (int) – Sequencer index.

  • timeout (int) – Timeout in minutes.

  • timeout_poll_res (float) – Timeout polling resolution in seconds.

Returns:

Tuple containing sequencer status and corresponding flags.

Return type:

SequencerState

Raises:

TimeoutError – Timeout

get_waveforms(sequencer: int) → Dict

Important: This method calls get_waveforms using functools.partial to set the slot index. The following docstring is of Cluster.get_waveforms: Get all waveforms and weigths in the AWG waveform list of indexed sequencer. The returned dictionary is structured as follows:

  • name: waveform name.

    • data: waveform samples in a range of 1.0 to -1.0.

    • index: waveform index used by the sequencer Q1ASM program to refer

      to the waveform.

Parameters:

sequencer (int) – Sequencer index.

Returns:

Dictionary with waveforms.

Return type:

dict

get_weights(sequencer: int) → Dict

Important: This method calls get_weights using functools.partial to set the slot index. The following docstring is of Cluster.get_weights: Get all weigths in the acquisition weight lists of indexed sequencer. The returned dictionary is structured as follows:

-name : weight name.

  • data: weight samples in a range of 1.0 to -1.0.

  • index: weight index used by the sequencer Q1ASM program to refer

    to the weight.

Parameters:

sequencer (int) – Sequencer index.

Returns:

Dictionary with weights.

Return type:

dict

Raises:

NotImplementedError – Functionality not available on this module.

property is_qcm_type(self) → bool#

Return if module is of type QCM.

Returns:

True if module is of type QCM.

Return type:

bool

Raises:

KeyError – Module is not available.

property is_qrm_type(self) → bool#

Return if module is of type QRM.

Returns:

True if module is of type QRM.

Return type:

bool

Raises:

KeyError – Module is not available.

property is_rf_type(self) → bool#

Return if module is of type QCM-RF or QRM-RF.

Returns:

True if module is of type QCM-RF or QRM-RF.

Return type:

bool

Raises:

KeyError – Module is not available.

property module_type(self) → qblox_instruments.types.InstrumentType#

Get module type (e.g. QRM, QCM).

Returns:

Module type

Return type:

InstrumentType

Raises:

KeyError – Module is not available.

property sequencers(self) → List#

Get list of sequencers submodules.

Returns:

List of sequencer submodules.

Return type:

list

set_dummy_binned_acquisition_data(sequencer: int, acq_index_name: str, data: Iterable[qblox_instruments.ieee488_2.dummy_transport.DummyBinnedAcquisitionData | None])

Important: This method calls set_dummy_binned_acquisition_data using functools.partial to set the slot index. The following docstring is of Cluster.set_dummy_binned_acquisition_data: Set dummy binned acquisition data for the dummy.

Parameters:

  • slot_idx (int) – Slot of the hardware you want to set the data to on a cluster.

  • sequencer (int) – Sequencer.

  • acq_index_name (str) – Acquisition index name.

  • data (Iterable[Union[DummyBinnedAcquisitionData, None]]) – Dummy data for the binned acquisition. An iterable of all the bin values.

set_dummy_scope_acquisition_data(sequencer: int | None, data: qblox_instruments.ieee488_2.dummy_transport.DummyScopeAcquisitionData)

Important: This method calls set_dummy_scope_acquisition_data using functools.partial to set the slot index. The following docstring is of Cluster.set_dummy_scope_acquisition_data: Set dummy scope acquisition data for the dummy.

Parameters:

  • slot_idx (int) – Slot of the hardware you want to set the data to on a cluster.

  • sequencer (Union[int, None]) – Sequencer.

  • data (DummyScopeAcquisitionData) – Dummy data for the scope acquisition.

property slot_idx(self) → int#

Get slot index.

Returns:

Slot index

Return type:

int

start_sequencer(sequencer: int | None = None) → None

Important: This method calls start_sequencer using functools.partial to set the slot index. The following docstring is of Cluster.start_sequencer: Start the indexed sequencer, thereby putting it in the running state. If an invalid sequencer index is given or the indexed sequencer was not yet armed, an error is set in system error. If no sequencer index is given, all armed sequencers are started and any sequencer not in the armed state is ignored. However, if no sequencer index is given and no sequencers are armed, and error is set in system error.

Parameters:

sequencer (Optional[int]) – Sequencer index.

Raises:

RuntimeError – An error is reported in system error and debug <= 1. All errors are read from system error and listed in the exception.

stop_sequencer(sequencer: int | None = None) → None

Important: This method calls stop_sequencer using functools.partial to set the slot index. The following docstring is of Cluster.stop_sequencer: Stop the indexed sequencer, thereby putting it in the stopped state. If an invalid sequencer index is given, an error is set in system error. If no sequencer index is given, all sequencers are stopped.

Parameters:

sequencer (Optional[int]) – Sequencer index.

Raises:

RuntimeError – An error is reported in system error and debug <= 1. All errors are read from system error and listed in the exception.

store_scope_acquisition(sequencer: int, name: str) → None

Important: This method calls store_scope_acquisition using functools.partial to set the slot index. The following docstring is of Cluster.store_scope_acquisition: After an acquisition has completed, store the scope acquisition results in the acquisition specified by name of the indexed sequencers. If an invalid sequencer index is given an error is set in system error. To get access to the acquisition results, the sequencer will be stopped when calling this function.

Parameters:

  • sequencer (int) – Sequencer index.

  • name (str) – Acquisition name.

Raises:

NotImplementedError – Functionality not available on this module.

Cluster QCM-RF parameters#

QCM_RF.present()#

Sets/gets module present status for slot {} in the Cluster.

Properties:

  • value: Boolean

QCM_RF.out0_lo_freq()#

Sets/gets the local oscillator frequency for output 0.

Properties:

  • unit: Hz

  • value: Numbers 2000000000.0<=v<=18000000000.0

QCM_RF.out1_lo_freq()#

Sets/gets the local oscillator frequency for output 1.

Properties:

  • unit: Hz

  • value: Numbers 2000000000.0<=v<=18000000000.0

QCM_RF.out0_lo_en()#

Sets/gets the local oscillator enable for output 0.

Properties:

  • value: Boolean

QCM_RF.out1_lo_en()#

Sets/gets the local oscillator enable for output 1.

Properties:

  • value: Boolean

QCM_RF.out0_att()#

Sets/gets output attenuation in a range of 0dB to 60dB with a resolution of 2dB per step.

Properties:

  • unit: dB

  • value: Ints 0<=v<=60, Multiples of 2

QCM_RF.out1_att()#

Sets/gets output attenuation in a range of 0dB to 60dB with a resolution of 2dB per step.

Properties:

  • unit: dB

  • value: Ints 0<=v<=60, Multiples of 2

QCM_RF.out0_offset_path0()#

Sets/gets output 0 offset for path 0.

Properties:

  • unit: mV

  • value: Numbers -84.0<=v<=73.0

QCM_RF.out0_offset_path1()#

Sets/gets output 0 offset for path 1.

Properties:

  • unit: mV

  • value: Numbers -84.0<=v<=73.0

QCM_RF.out1_offset_path0()#

Sets/gets output 1 offset for path 0.

Properties:

  • unit: mV

  • value: Numbers -84.0<=v<=73.0

QCM_RF.out1_offset_path1()#

Sets/gets output 1 offset for path 1.

Properties:

  • unit: mV

  • value: Numbers -84.0<=v<=73.0

QCM_RF.marker0_inv_en()#

Sets/gets output 0 marker invert enable

Properties:

  • value: Boolean

QCM_RF.marker1_inv_en()#

Sets/gets output 1 marker invert enable

Properties:

  • value: Boolean

arm_sequencer(sequencer: int | None = None) → None

Important: This method calls arm_sequencer using functools.partial to set the slot index. The following docstring is of Cluster.arm_sequencer: Prepare the indexed sequencer to start by putting it in the armed state. If no sequencer index is given, all sequencers are armed. Any sequencer that was already running is stopped and rearmed. If an invalid sequencer index is given, an error is set in system error.

Parameters:

sequencer (Optional[int]) – Sequencer index.

Raises:

RuntimeError – An error is reported in system error and debug <= 1. All errors are read from system error and listed in the exception.

connect_sequencer(sequencer: int, *connections: str) → None

Important: This method calls connect_sequencer using functools.partial to set the slot index. The following docstring is of Cluster.connect_sequencer: Makes new connections between the indexed sequencer and some inputs and/or outputs. This will fail if a requested connection already existed, or if the connection could not be made due to a conflict with an existing connection (hardware constraints). In such a case, the channel map will not be affected.

Parameters:

  • slot (int) – Slot index

  • sequencer (int) – Sequencer index

  • *connections (str) – Zero or more connections to make, each specified using a string. The string should have the format <direction><channel> or <direction><I-channel>_<Q-channel>. <direction> must be in to make a connection between an input and the acquisition path, out to make a connection from the waveform generator to an output, or io to do both. The channels must be integer channel indices. If only one channel is specified, the sequencer operates in real mode; if two channels are specified, it operates in complex mode.

Raises:

  • RuntimeError – If the connection command could not be completed due to a conflict.

  • ValueError – If parsing of a connection fails.

delete_acquisition_data(sequencer: int, name: str = '', all: bool = False) → None

Important: This method calls delete_acquisition_data using functools.partial to set the slot index. The following docstring is of Cluster.delete_acquisition_data: Delete data from an acquisition specified by name in the acquisition list of indexed sequencer or delete data in all acquisitions if all is True.

Parameters:

  • sequencer (int) – Sequencer index.

  • name (str) – Weight name

Raises:

NotImplementedError – Functionality not available on this module.

delete_dummy_binned_acquisition_data(sequencer: int | None = None, acq_index_name: str | None = None)

Important: This method calls delete_dummy_binned_acquisition_data using functools.partial to set the slot index. The following docstring is of Cluster.delete_dummy_binned_acquisition_data: Delete all dummy binned acquisition data for the dummy.

Parameters:

  • slot_idx (int) – Slot of the hardware you want to set the data to on a cluster.

  • sequencer (Optional[int]) – Sequencer.

  • acq_index_name (Optional[str]) – Acquisition index name.

delete_dummy_scope_acquisition_data(sequencer: int | None)

Important: This method calls delete_dummy_scope_acquisition_data using functools.partial to set the slot index. The following docstring is of Cluster.delete_dummy_scope_acquisition_data: Delete dummy scope acquisition data for the dummy.

Parameters:

  • slot_idx (int) – Slot of the hardware you want to set the data to on a cluster.

  • sequencer (Union[int, None]) – Sequencer.

disconnect_inputs() → None

Important: This method calls disconnect_inputs using functools.partial to set the slot index. The following docstring is of Cluster.disconnect_inputs: Disconnects all inputs from the acquisition paths of the sequencers.

Parameters:

slot (int) – Slot index

disconnect_outputs() → None

Important: This method calls disconnect_outputs using functools.partial to set the slot index. The following docstring is of Cluster.disconnect_outputs: Disconnects all outputs from the waveform generator paths of the sequencers.

Parameters:

slot (int) – Slot index

get_acquisition_state(sequencer: int, timeout: int = 0, timeout_poll_res: float = 0.02) → bool

Important: This method calls get_acquisition_state using functools.partial to set the slot index. The following docstring is of Cluster.get_acquisition_state: Return acquisition binning completion state of the indexed sequencer. If an invalid sequencer is given, an error is set in system error. If the timeout is set to zero, the function returns the state immediately. If a positive non-zero timeout is set, the function blocks until the acquisition binning completes. If the acquisition hasn’t completed before the timeout expires, a TimeoutError is thrown. Note that when sequencer state checking is enabled, the sequencer state is checked using get_sequencer_state with the selected timeout period first and then the acquisition state is checked with the same timeout period. This means that the total timeout period is two times the set timeout period.

Parameters:

  • sequencer (int) – Sequencer index.

  • timeout (int) – Timeout in minutes.

  • timeout_poll_res (float) – Timeout polling resolution in seconds.

  • check_seq_state (bool) – Check if sequencer is done before checking acquisition state.

Returns:

Indicates the acquisition binning completion state (False = uncompleted, True = completed).

Return type:

bool

Raises:
get_acquisitions(sequencer: int) → Dict

Important: This method calls get_acquisitions using functools.partial to set the slot index. The following docstring is of Cluster.get_acquisitions: Get all acquisitions in acquisition lists of indexed sequencer. The acquisition scope and bin data is normalized to a range of -1.0 to 1.0 taking both the bit widths of the processing path and average count into considaration. For the binned integration results, the integration length is not handled during normalization and therefore these values have to be divided by their respective integration lenghts. The returned dictionary is structured as follows:

  • name: acquisition name

    • index: acquisition index used by the sequencer Q1ASM program to refer to the acquisition.

    • acquisition: acquisition dictionary

      • scope: Scope data

        • path0: input path 0

          • data: acquisition samples in a range of 1.0 to -1.0.

          • out-of-range: out-of-range indication for the entire acquisition (False = in-range, True = out-of-range).

          • avg_cnt: number of averages.

        • path1: input path 1

          • data: acquisition samples in a range of 1.0 to -1.0.

          • out-of-range: out-of-range indication for the entire acquisition (False = in-range, True = out-of-range).

          • avg_cnt: number of averages.

      • bins: bin data

        • integration: integration data

          • path_0: input path 0 integration result bin list

          • path_1: input path 1 integration result bin list

        • threshold: threshold result bin list

        • valid: list of valid indications per bin

        • avg_cnt: list of number of averages per bin

Parameters:

sequencer (int) – Sequencer index.

Returns:

Dictionary with acquisitions.

Return type:

dict

Raises:

NotImplementedError – Functionality not available on this module.

get_assembler_log() → str

Important: This method calls get_assembler_log using functools.partial to set the slot index. The following docstring is of Cluster.get_assembler_log: Get assembler log.

Parameters:

slot (int) – slot index.

Returns:

Assembler log.

Return type:

str

Raises:

  • Exception – Invalid input parameter type.

  • Exception – An error is reported in system error and debug <= 1. All errors are read from system error and listed in the exception.

get_assembler_status() → bool

Important: This method calls get_assembler_status using functools.partial to set the slot index. The following docstring is of Cluster.get_assembler_status: Get assembler status. Refer to the assembler log to get more information regarding the assembler result.

Parameters:

slot (int) – slot index.

Returns:

Assembler status (False = failed, True = success).

Return type:

bool

Raises:

  • Exception – Invalid input parameter type.

  • Exception – An error is reported in system error and debug <= 1. All errors are read from system error and listed in the exception.

get_sequencer_state(sequencer: int, timeout: int = 0, timeout_poll_res: float = 0.02) → qblox_instruments.native.generic_func.SequencerState

Important: This method calls get_sequencer_state using functools.partial to set the slot index. The following docstring is of Cluster.get_sequencer_state: Get the sequencer state. If an invalid sequencer index is given, an error is set in system error. If the timeout is set to zero, the function returns the state immediately. If a positive non-zero timeout is set, the function blocks until the sequencer completes. If the sequencer hasn’t stopped before the timeout expires, a TimeoutError is thrown.

Parameters:

  • sequencer (int) – Sequencer index.

  • timeout (int) – Timeout in minutes.

  • timeout_poll_res (float) – Timeout polling resolution in seconds.

Returns:

Tuple containing sequencer status and corresponding flags.

Return type:

SequencerState

Raises:

TimeoutError – Timeout

get_waveforms(sequencer: int) → Dict

Important: This method calls get_waveforms using functools.partial to set the slot index. The following docstring is of Cluster.get_waveforms: Get all waveforms and weigths in the AWG waveform list of indexed sequencer. The returned dictionary is structured as follows:

  • name: waveform name.

    • data: waveform samples in a range of 1.0 to -1.0.

    • index: waveform index used by the sequencer Q1ASM program to refer

      to the waveform.

Parameters:

sequencer (int) – Sequencer index.

Returns:

Dictionary with waveforms.

Return type:

dict

get_weights(sequencer: int) → Dict

Important: This method calls get_weights using functools.partial to set the slot index. The following docstring is of Cluster.get_weights: Get all weigths in the acquisition weight lists of indexed sequencer. The returned dictionary is structured as follows:

-name : weight name.

  • data: weight samples in a range of 1.0 to -1.0.

  • index: weight index used by the sequencer Q1ASM program to refer

    to the weight.

Parameters:

sequencer (int) – Sequencer index.

Returns:

Dictionary with weights.

Return type:

dict

Raises:

NotImplementedError – Functionality not available on this module.

property is_qcm_type(self) → bool

Return if module is of type QCM.

Returns:

True if module is of type QCM.

Return type:

bool

Raises:

KeyError – Module is not available.

property is_qrm_type(self) → bool

Return if module is of type QRM.

Returns:

True if module is of type QRM.

Return type:

bool

Raises:

KeyError – Module is not available.

property is_rf_type(self) → bool

Return if module is of type QCM-RF or QRM-RF.

Returns:

True if module is of type QCM-RF or QRM-RF.

Return type:

bool

Raises:

KeyError – Module is not available.

property module_type(self) → qblox_instruments.types.InstrumentType

Get module type (e.g. QRM, QCM).

Returns:

Module type

Return type:

InstrumentType

Raises:

KeyError – Module is not available.

property sequencers(self) → List

Get list of sequencers submodules.

Returns:

List of sequencer submodules.

Return type:

list

set_dummy_binned_acquisition_data(sequencer: int, acq_index_name: str, data: Iterable[qblox_instruments.ieee488_2.dummy_transport.DummyBinnedAcquisitionData | None])

Important: This method calls set_dummy_binned_acquisition_data using functools.partial to set the slot index. The following docstring is of Cluster.set_dummy_binned_acquisition_data: Set dummy binned acquisition data for the dummy.

Parameters:

  • slot_idx (int) – Slot of the hardware you want to set the data to on a cluster.

  • sequencer (int) – Sequencer.

  • acq_index_name (str) – Acquisition index name.

  • data (Iterable[Union[DummyBinnedAcquisitionData, None]]) – Dummy data for the binned acquisition. An iterable of all the bin values.

set_dummy_scope_acquisition_data(sequencer: int | None, data: qblox_instruments.ieee488_2.dummy_transport.DummyScopeAcquisitionData)

Important: This method calls set_dummy_scope_acquisition_data using functools.partial to set the slot index. The following docstring is of Cluster.set_dummy_scope_acquisition_data: Set dummy scope acquisition data for the dummy.

Parameters:

  • slot_idx (int) – Slot of the hardware you want to set the data to on a cluster.

  • sequencer (Union[int, None]) – Sequencer.

  • data (DummyScopeAcquisitionData) – Dummy data for the scope acquisition.

property slot_idx(self) → int

Get slot index.

Returns:

Slot index

Return type:

int

start_sequencer(sequencer: int | None = None) → None

Important: This method calls start_sequencer using functools.partial to set the slot index. The following docstring is of Cluster.start_sequencer: Start the indexed sequencer, thereby putting it in the running state. If an invalid sequencer index is given or the indexed sequencer was not yet armed, an error is set in system error. If no sequencer index is given, all armed sequencers are started and any sequencer not in the armed state is ignored. However, if no sequencer index is given and no sequencers are armed, and error is set in system error.

Parameters:

sequencer (Optional[int]) – Sequencer index.

Raises:

RuntimeError – An error is reported in system error and debug <= 1. All errors are read from system error and listed in the exception.

stop_sequencer(sequencer: int | None = None) → None

Important: This method calls stop_sequencer using functools.partial to set the slot index. The following docstring is of Cluster.stop_sequencer: Stop the indexed sequencer, thereby putting it in the stopped state. If an invalid sequencer index is given, an error is set in system error. If no sequencer index is given, all sequencers are stopped.

Parameters:

sequencer (Optional[int]) – Sequencer index.

Raises:

RuntimeError – An error is reported in system error and debug <= 1. All errors are read from system error and listed in the exception.

store_scope_acquisition(sequencer: int, name: str) → None

Important: This method calls store_scope_acquisition using functools.partial to set the slot index. The following docstring is of Cluster.store_scope_acquisition: After an acquisition has completed, store the scope acquisition results in the acquisition specified by name of the indexed sequencers. If an invalid sequencer index is given an error is set in system error. To get access to the acquisition results, the sequencer will be stopped when calling this function.

Parameters:

  • sequencer (int) – Sequencer index.

  • name (str) – Acquisition name.

Raises:

NotImplementedError – Functionality not available on this module.

Cluster QRM parameters#

QRM.present()#

Sets/gets module present status for slot {} in the Cluster.

Properties:

  • value: Boolean

QRM.in0_gain()#

Sets/gets input 0 gain in a range of -6dB to 26dB with a resolution of 1dB per step.

Properties:

  • unit: dB

  • value: Numbers -6<=v<=26

QRM.in1_gain()#

Sets/gets input 1 gain in a range of -6dB to 26dB with a resolution of 1dB per step.

Properties:

  • unit: dB

  • value: Numbers -6<=v<=26

QRM.in0_offset()#

Sets/gets input 0 offset in a range of -0.09V to 0.09V

Properties:

  • unit: V

  • value: Numbers -0.09<=v<=0.09

QRM.in1_offset()#

Sets/gets input 1 offset in a range of -0.09V to 0.09V

Properties:

  • unit: V

  • value: Numbers -0.09<=v<=0.09

QRM.out0_offset()#

Sets/gets output 0 offset

Properties:

  • unit: V

  • value: Numbers -0.5<=v<=0.5

QRM.out1_offset()#

Sets/gets output 1 offset.

Properties:

  • unit: V

  • value: Numbers -0.5<=v<=0.5

QRM.scope_acq_trigger_mode_path0()#

Sets/gets scope acquisition trigger mode for input path 0 (‘sequencer’ = triggered by sequencer, ‘level’ = triggered by input level).

Properties:

  • value: Enum: {‘level’, ‘sequencer’}

QRM.scope_acq_trigger_level_path0()#

Sets/gets scope acquisition trigger level when using input level trigger mode for input path 0.

Properties:

  • value: Numbers -1.0<=v<=1.0

QRM.scope_acq_avg_mode_en_path0()#

Sets/gets scope acquisition averaging mode enable for input path 0.

Properties:

  • value: Boolean

QRM.scope_acq_trigger_mode_path1()#

Sets/gets scope acquisition trigger mode for input path 1 (‘sequencer’ = triggered by sequencer, ‘level’ = triggered by input level).

Properties:

  • value: Enum: {‘level’, ‘sequencer’}

QRM.scope_acq_trigger_level_path1()#

Sets/gets scope acquisition trigger level when using input level trigger mode for input path 1.

Properties:

  • value: Numbers -1.0<=v<=1.0

QRM.scope_acq_avg_mode_en_path1()#

Sets/gets scope acquisition averaging mode enable for input path 1.

Properties:

  • value: Boolean

QRM.scope_acq_sequencer_select()#

Sets/gets sequencer select that specifies which sequencer triggers the scope acquisition when using sequencer trigger mode.

Properties:

  • value: Numbers 0<=v<=5

QRM.marker0_inv_en()#

Sets/gets output 0 marker invert enable

Properties:

  • value: Boolean

QRM.marker1_inv_en()#

Sets/gets output 1 marker invert enable

Properties:

  • value: Boolean

QRM.marker2_inv_en()#

Sets/gets output 2 marker invert enable

Properties:

  • value: Boolean

QRM.marker3_inv_en()#

Sets/gets output 3 marker invert enable

Properties:

  • value: Boolean

arm_sequencer(sequencer: int | None = None) → None

Important: This method calls arm_sequencer using functools.partial to set the slot index. The following docstring is of Cluster.arm_sequencer: Prepare the indexed sequencer to start by putting it in the armed state. If no sequencer index is given, all sequencers are armed. Any sequencer that was already running is stopped and rearmed. If an invalid sequencer index is given, an error is set in system error.

Parameters:

sequencer (Optional[int]) – Sequencer index.

Raises:

RuntimeError – An error is reported in system error and debug <= 1. All errors are read from system error and listed in the exception.

connect_sequencer(sequencer: int, *connections: str) → None

Important: This method calls connect_sequencer using functools.partial to set the slot index. The following docstring is of Cluster.connect_sequencer: Makes new connections between the indexed sequencer and some inputs and/or outputs. This will fail if a requested connection already existed, or if the connection could not be made due to a conflict with an existing connection (hardware constraints). In such a case, the channel map will not be affected.

Parameters:

  • slot (int) – Slot index

  • sequencer (int) – Sequencer index

  • *connections (str) – Zero or more connections to make, each specified using a string. The string should have the format <direction><channel> or <direction><I-channel>_<Q-channel>. <direction> must be in to make a connection between an input and the acquisition path, out to make a connection from the waveform generator to an output, or io to do both. The channels must be integer channel indices. If only one channel is specified, the sequencer operates in real mode; if two channels are specified, it operates in complex mode.

Raises:

  • RuntimeError – If the connection command could not be completed due to a conflict.

  • ValueError – If parsing of a connection fails.

delete_acquisition_data(sequencer: int, name: str = '', all: bool = False) → None

Important: This method calls delete_acquisition_data using functools.partial to set the slot index. The following docstring is of Cluster.delete_acquisition_data: Delete data from an acquisition specified by name in the acquisition list of indexed sequencer or delete data in all acquisitions if all is True.

Parameters:

  • sequencer (int) – Sequencer index.

  • name (str) – Weight name

Raises:

NotImplementedError – Functionality not available on this module.

delete_dummy_binned_acquisition_data(sequencer: int | None = None, acq_index_name: str | None = None)

Important: This method calls delete_dummy_binned_acquisition_data using functools.partial to set the slot index. The following docstring is of Cluster.delete_dummy_binned_acquisition_data: Delete all dummy binned acquisition data for the dummy.

Parameters:

  • slot_idx (int) – Slot of the hardware you want to set the data to on a cluster.

  • sequencer (Optional[int]) – Sequencer.

  • acq_index_name (Optional[str]) – Acquisition index name.

delete_dummy_scope_acquisition_data(sequencer: int | None)

Important: This method calls delete_dummy_scope_acquisition_data using functools.partial to set the slot index. The following docstring is of Cluster.delete_dummy_scope_acquisition_data: Delete dummy scope acquisition data for the dummy.

Parameters:

  • slot_idx (int) – Slot of the hardware you want to set the data to on a cluster.

  • sequencer (Union[int, None]) – Sequencer.

disconnect_inputs() → None

Important: This method calls disconnect_inputs using functools.partial to set the slot index. The following docstring is of Cluster.disconnect_inputs: Disconnects all inputs from the acquisition paths of the sequencers.

Parameters:

slot (int) – Slot index

disconnect_outputs() → None

Important: This method calls disconnect_outputs using functools.partial to set the slot index. The following docstring is of Cluster.disconnect_outputs: Disconnects all outputs from the waveform generator paths of the sequencers.

Parameters:

slot (int) – Slot index

get_acquisition_state(sequencer: int, timeout: int = 0, timeout_poll_res: float = 0.02) → bool

Important: This method calls get_acquisition_state using functools.partial to set the slot index. The following docstring is of Cluster.get_acquisition_state: Return acquisition binning completion state of the indexed sequencer. If an invalid sequencer is given, an error is set in system error. If the timeout is set to zero, the function returns the state immediately. If a positive non-zero timeout is set, the function blocks until the acquisition binning completes. If the acquisition hasn’t completed before the timeout expires, a TimeoutError is thrown. Note that when sequencer state checking is enabled, the sequencer state is checked using get_sequencer_state with the selected timeout period first and then the acquisition state is checked with the same timeout period. This means that the total timeout period is two times the set timeout period.

Parameters:

  • sequencer (int) – Sequencer index.

  • timeout (int) – Timeout in minutes.

  • timeout_poll_res (float) – Timeout polling resolution in seconds.

  • check_seq_state (bool) – Check if sequencer is done before checking acquisition state.

Returns:

Indicates the acquisition binning completion state (False = uncompleted, True = completed).

Return type:

bool

Raises:
get_acquisitions(sequencer: int) → Dict

Important: This method calls get_acquisitions using functools.partial to set the slot index. The following docstring is of Cluster.get_acquisitions: Get all acquisitions in acquisition lists of indexed sequencer. The acquisition scope and bin data is normalized to a range of -1.0 to 1.0 taking both the bit widths of the processing path and average count into considaration. For the binned integration results, the integration length is not handled during normalization and therefore these values have to be divided by their respective integration lenghts. The returned dictionary is structured as follows:

  • name: acquisition name

    • index: acquisition index used by the sequencer Q1ASM program to refer to the acquisition.

    • acquisition: acquisition dictionary

      • scope: Scope data

        • path0: input path 0

          • data: acquisition samples in a range of 1.0 to -1.0.

          • out-of-range: out-of-range indication for the entire acquisition (False = in-range, True = out-of-range).

          • avg_cnt: number of averages.

        • path1: input path 1

          • data: acquisition samples in a range of 1.0 to -1.0.

          • out-of-range: out-of-range indication for the entire acquisition (False = in-range, True = out-of-range).

          • avg_cnt: number of averages.

      • bins: bin data

        • integration: integration data

          • path_0: input path 0 integration result bin list

          • path_1: input path 1 integration result bin list

        • threshold: threshold result bin list

        • valid: list of valid indications per bin

        • avg_cnt: list of number of averages per bin

Parameters:

sequencer (int) – Sequencer index.

Returns:

Dictionary with acquisitions.

Return type:

dict

Raises:

NotImplementedError – Functionality not available on this module.

get_assembler_log() → str

Important: This method calls get_assembler_log using functools.partial to set the slot index. The following docstring is of Cluster.get_assembler_log: Get assembler log.

Parameters:

slot (int) – slot index.

Returns:

Assembler log.

Return type:

str

Raises:

  • Exception – Invalid input parameter type.

  • Exception – An error is reported in system error and debug <= 1. All errors are read from system error and listed in the exception.

get_assembler_status() → bool

Important: This method calls get_assembler_status using functools.partial to set the slot index. The following docstring is of Cluster.get_assembler_status: Get assembler status. Refer to the assembler log to get more information regarding the assembler result.

Parameters:

slot (int) – slot index.

Returns:

Assembler status (False = failed, True = success).

Return type:

bool

Raises:

  • Exception – Invalid input parameter type.

  • Exception – An error is reported in system error and debug <= 1. All errors are read from system error and listed in the exception.

get_sequencer_state(sequencer: int, timeout: int = 0, timeout_poll_res: float = 0.02) → qblox_instruments.native.generic_func.SequencerState

Important: This method calls get_sequencer_state using functools.partial to set the slot index. The following docstring is of Cluster.get_sequencer_state: Get the sequencer state. If an invalid sequencer index is given, an error is set in system error. If the timeout is set to zero, the function returns the state immediately. If a positive non-zero timeout is set, the function blocks until the sequencer completes. If the sequencer hasn’t stopped before the timeout expires, a TimeoutError is thrown.

Parameters:

  • sequencer (int) – Sequencer index.

  • timeout (int) – Timeout in minutes.

  • timeout_poll_res (float) – Timeout polling resolution in seconds.

Returns:

Tuple containing sequencer status and corresponding flags.

Return type:

SequencerState

Raises:

TimeoutError – Timeout

get_waveforms(sequencer: int) → Dict

Important: This method calls get_waveforms using functools.partial to set the slot index. The following docstring is of Cluster.get_waveforms: Get all waveforms and weigths in the AWG waveform list of indexed sequencer. The returned dictionary is structured as follows:

  • name: waveform name.

    • data: waveform samples in a range of 1.0 to -1.0.

    • index: waveform index used by the sequencer Q1ASM program to refer

      to the waveform.

Parameters:

sequencer (int) – Sequencer index.

Returns:

Dictionary with waveforms.

Return type:

dict

get_weights(sequencer: int) → Dict

Important: This method calls get_weights using functools.partial to set the slot index. The following docstring is of Cluster.get_weights: Get all weigths in the acquisition weight lists of indexed sequencer. The returned dictionary is structured as follows:

-name : weight name.

  • data: weight samples in a range of 1.0 to -1.0.

  • index: weight index used by the sequencer Q1ASM program to refer

    to the weight.

Parameters:

sequencer (int) – Sequencer index.

Returns:

Dictionary with weights.

Return type:

dict

Raises:

NotImplementedError – Functionality not available on this module.

property is_qcm_type(self) → bool

Return if module is of type QCM.

Returns:

True if module is of type QCM.

Return type:

bool

Raises:

KeyError – Module is not available.

property is_qrm_type(self) → bool

Return if module is of type QRM.

Returns:

True if module is of type QRM.

Return type:

bool

Raises:

KeyError – Module is not available.

property is_rf_type(self) → bool

Return if module is of type QCM-RF or QRM-RF.

Returns:

True if module is of type QCM-RF or QRM-RF.

Return type:

bool

Raises:

KeyError – Module is not available.

property module_type(self) → qblox_instruments.types.InstrumentType

Get module type (e.g. QRM, QCM).

Returns:

Module type

Return type:

InstrumentType

Raises:

KeyError – Module is not available.

property sequencers(self) → List

Get list of sequencers submodules.

Returns:

List of sequencer submodules.

Return type:

list

set_dummy_binned_acquisition_data(sequencer: int, acq_index_name: str, data: Iterable[qblox_instruments.ieee488_2.dummy_transport.DummyBinnedAcquisitionData | None])

Important: This method calls set_dummy_binned_acquisition_data using functools.partial to set the slot index. The following docstring is of Cluster.set_dummy_binned_acquisition_data: Set dummy binned acquisition data for the dummy.

Parameters:

  • slot_idx (int) – Slot of the hardware you want to set the data to on a cluster.

  • sequencer (int) – Sequencer.

  • acq_index_name (str) – Acquisition index name.

  • data (Iterable[Union[DummyBinnedAcquisitionData, None]]) – Dummy data for the binned acquisition. An iterable of all the bin values.

set_dummy_scope_acquisition_data(sequencer: int | None, data: qblox_instruments.ieee488_2.dummy_transport.DummyScopeAcquisitionData)

Important: This method calls set_dummy_scope_acquisition_data using functools.partial to set the slot index. The following docstring is of Cluster.set_dummy_scope_acquisition_data: Set dummy scope acquisition data for the dummy.

Parameters:

  • slot_idx (int) – Slot of the hardware you want to set the data to on a cluster.

  • sequencer (Union[int, None]) – Sequencer.

  • data (DummyScopeAcquisitionData) – Dummy data for the scope acquisition.

property slot_idx(self) → int

Get slot index.

Returns:

Slot index

Return type:

int

start_sequencer(sequencer: int | None = None) → None

Important: This method calls start_sequencer using functools.partial to set the slot index. The following docstring is of Cluster.start_sequencer: Start the indexed sequencer, thereby putting it in the running state. If an invalid sequencer index is given or the indexed sequencer was not yet armed, an error is set in system error. If no sequencer index is given, all armed sequencers are started and any sequencer not in the armed state is ignored. However, if no sequencer index is given and no sequencers are armed, and error is set in system error.

Parameters:

sequencer (Optional[int]) – Sequencer index.

Raises:

RuntimeError – An error is reported in system error and debug <= 1. All errors are read from system error and listed in the exception.

stop_sequencer(sequencer: int | None = None) → None

Important: This method calls stop_sequencer using functools.partial to set the slot index. The following docstring is of Cluster.stop_sequencer: Stop the indexed sequencer, thereby putting it in the stopped state. If an invalid sequencer index is given, an error is set in system error. If no sequencer index is given, all sequencers are stopped.

Parameters:

sequencer (Optional[int]) – Sequencer index.

Raises:

RuntimeError – An error is reported in system error and debug <= 1. All errors are read from system error and listed in the exception.

store_scope_acquisition(sequencer: int, name: str) → None

Important: This method calls store_scope_acquisition using functools.partial to set the slot index. The following docstring is of Cluster.store_scope_acquisition: After an acquisition has completed, store the scope acquisition results in the acquisition specified by name of the indexed sequencers. If an invalid sequencer index is given an error is set in system error. To get access to the acquisition results, the sequencer will be stopped when calling this function.

Parameters:

  • sequencer (int) – Sequencer index.

  • name (str) – Acquisition name.

Raises:

NotImplementedError – Functionality not available on this module.

Cluster QRM-RF parameters#

QRM_RF.present()#

Sets/gets module present status for slot {} in the Cluster.

Properties:

  • value: Boolean

QRM_RF.out0_in0_lo_freq()#

Sets/gets the local oscillator frequency for output 0 and input 0.

Properties:

  • unit: Hz

  • value: Numbers 2000000000.0<=v<=18000000000.0

QRM_RF.out0_in0_lo_en()#

Sets/gets the local oscillator enable for output 0 and input 0.

Properties:

  • value: Boolean

QRM_RF.in0_att()#

Sets/gets input attenuation in a range of 0dB to 30dB with a resolution of 2dB per step.

Properties:

  • unit: dB

  • value: Ints 0<=v<=30, Multiples of 2

QRM_RF.out0_att()#

Sets/gets output attenuation in a range of 0dB to 60dB with a resolution of 2dB per step.

Properties:

  • unit: dB

  • value: Ints 0<=v<=60, Multiples of 2

QRM_RF.in0_offset_path0()#

Sets/gets input 0 offset for path 0 in a range of -0.09V to 0.09V

Properties:

  • unit: V

  • value: Numbers -0.09<=v<=0.09

QRM_RF.in0_offset_path1()#

Sets/gets input 0 offset for path 1 in a range of -0.09V to 0.09V

Properties:

  • unit: V

  • value: Numbers -0.09<=v<=0.09

QRM_RF.out0_offset_path0()#

Sets/gets output 0 offset for path 0.

Properties:

  • unit: mV

  • value: Numbers -84.0<=v<=73.0

QRM_RF.out0_offset_path1()#

Sets/gets output 0 offset for path 1.

Properties:

  • unit: mV

  • value: Numbers -84.0<=v<=73.0

QRM_RF.scope_acq_trigger_mode_path0()#

Sets/gets scope acquisition trigger mode for input path 0 (‘sequencer’ = triggered by sequencer, ‘level’ = triggered by input level).

Properties:

  • value: Enum: {‘level’, ‘sequencer’}

QRM_RF.scope_acq_trigger_level_path0()#

Sets/gets scope acquisition trigger level when using input level trigger mode for input path 0.

Properties:

  • value: Numbers -1.0<=v<=1.0

QRM_RF.scope_acq_avg_mode_en_path0()#

Sets/gets scope acquisition averaging mode enable for input path 0.

Properties:

  • value: Boolean

QRM_RF.scope_acq_trigger_mode_path1()#

Sets/gets scope acquisition trigger mode for input path 1 (‘sequencer’ = triggered by sequencer, ‘level’ = triggered by input level).

Properties:

  • value: Enum: {‘level’, ‘sequencer’}

QRM_RF.scope_acq_trigger_level_path1()#

Sets/gets scope acquisition trigger level when using input level trigger mode for input path 1.

Properties:

  • value: Numbers -1.0<=v<=1.0

QRM_RF.scope_acq_avg_mode_en_path1()#

Sets/gets scope acquisition averaging mode enable for input path 1.

Properties:

  • value: Boolean

QRM_RF.scope_acq_sequencer_select()#

Sets/gets sequencer select that specifies which sequencer triggers the scope acquisition when using sequencer trigger mode.

Properties:

  • value: Numbers 0<=v<=5

QRM_RF.marker0_inv_en()#

Sets/gets output 0 marker invert enable

Properties:

  • value: Boolean

QRM_RF.marker1_inv_en()#

Sets/gets output 1 marker invert enable

Properties:

  • value: Boolean

arm_sequencer(sequencer: int | None = None) → None

Important: This method calls arm_sequencer using functools.partial to set the slot index. The following docstring is of Cluster.arm_sequencer: Prepare the indexed sequencer to start by putting it in the armed state. If no sequencer index is given, all sequencers are armed. Any sequencer that was already running is stopped and rearmed. If an invalid sequencer index is given, an error is set in system error.

Parameters:

sequencer (Optional[int]) – Sequencer index.

Raises:

RuntimeError – An error is reported in system error and debug <= 1. All errors are read from system error and listed in the exception.

connect_sequencer(sequencer: int, *connections: str) → None

Important: This method calls connect_sequencer using functools.partial to set the slot index. The following docstring is of Cluster.connect_sequencer: Makes new connections between the indexed sequencer and some inputs and/or outputs. This will fail if a requested connection already existed, or if the connection could not be made due to a conflict with an existing connection (hardware constraints). In such a case, the channel map will not be affected.

Parameters:

  • slot (int) – Slot index

  • sequencer (int) – Sequencer index

  • *connections (str) – Zero or more connections to make, each specified using a string. The string should have the format <direction><channel> or <direction><I-channel>_<Q-channel>. <direction> must be in to make a connection between an input and the acquisition path, out to make a connection from the waveform generator to an output, or io to do both. The channels must be integer channel indices. If only one channel is specified, the sequencer operates in real mode; if two channels are specified, it operates in complex mode.

Raises:

  • RuntimeError – If the connection command could not be completed due to a conflict.

  • ValueError – If parsing of a connection fails.

delete_acquisition_data(sequencer: int, name: str = '', all: bool = False) → None

Important: This method calls delete_acquisition_data using functools.partial to set the slot index. The following docstring is of Cluster.delete_acquisition_data: Delete data from an acquisition specified by name in the acquisition list of indexed sequencer or delete data in all acquisitions if all is True.

Parameters:

  • sequencer (int) – Sequencer index.

  • name (str) – Weight name

Raises:

NotImplementedError – Functionality not available on this module.

delete_dummy_binned_acquisition_data(sequencer: int | None = None, acq_index_name: str | None = None)

Important: This method calls delete_dummy_binned_acquisition_data using functools.partial to set the slot index. The following docstring is of Cluster.delete_dummy_binned_acquisition_data: Delete all dummy binned acquisition data for the dummy.

Parameters:

  • slot_idx (int) – Slot of the hardware you want to set the data to on a cluster.

  • sequencer (Optional[int]) – Sequencer.

  • acq_index_name (Optional[str]) – Acquisition index name.

delete_dummy_scope_acquisition_data(sequencer: int | None)

Important: This method calls delete_dummy_scope_acquisition_data using functools.partial to set the slot index. The following docstring is of Cluster.delete_dummy_scope_acquisition_data: Delete dummy scope acquisition data for the dummy.

Parameters:

  • slot_idx (int) – Slot of the hardware you want to set the data to on a cluster.

  • sequencer (Union[int, None]) – Sequencer.

disconnect_inputs() → None

Important: This method calls disconnect_inputs using functools.partial to set the slot index. The following docstring is of Cluster.disconnect_inputs: Disconnects all inputs from the acquisition paths of the sequencers.

Parameters:

slot (int) – Slot index

disconnect_outputs() → None

Important: This method calls disconnect_outputs using functools.partial to set the slot index. The following docstring is of Cluster.disconnect_outputs: Disconnects all outputs from the waveform generator paths of the sequencers.

Parameters:

slot (int) – Slot index

get_acquisition_state(sequencer: int, timeout: int = 0, timeout_poll_res: float = 0.02) → bool

Important: This method calls get_acquisition_state using functools.partial to set the slot index. The following docstring is of Cluster.get_acquisition_state: Return acquisition binning completion state of the indexed sequencer. If an invalid sequencer is given, an error is set in system error. If the timeout is set to zero, the function returns the state immediately. If a positive non-zero timeout is set, the function blocks until the acquisition binning completes. If the acquisition hasn’t completed before the timeout expires, a TimeoutError is thrown. Note that when sequencer state checking is enabled, the sequencer state is checked using get_sequencer_state with the selected timeout period first and then the acquisition state is checked with the same timeout period. This means that the total timeout period is two times the set timeout period.

Parameters:

  • sequencer (int) – Sequencer index.

  • timeout (int) – Timeout in minutes.

  • timeout_poll_res (float) – Timeout polling resolution in seconds.

  • check_seq_state (bool) – Check if sequencer is done before checking acquisition state.

Returns:

Indicates the acquisition binning completion state (False = uncompleted, True = completed).

Return type:

bool

Raises:
get_acquisitions(sequencer: int) → Dict

Important: This method calls get_acquisitions using functools.partial to set the slot index. The following docstring is of Cluster.get_acquisitions: Get all acquisitions in acquisition lists of indexed sequencer. The acquisition scope and bin data is normalized to a range of -1.0 to 1.0 taking both the bit widths of the processing path and average count into considaration. For the binned integration results, the integration length is not handled during normalization and therefore these values have to be divided by their respective integration lenghts. The returned dictionary is structured as follows:

  • name: acquisition name

    • index: acquisition index used by the sequencer Q1ASM program to refer to the acquisition.

    • acquisition: acquisition dictionary

      • scope: Scope data

        • path0: input path 0

          • data: acquisition samples in a range of 1.0 to -1.0.

          • out-of-range: out-of-range indication for the entire acquisition (False = in-range, True = out-of-range).

          • avg_cnt: number of averages.

        • path1: input path 1

          • data: acquisition samples in a range of 1.0 to -1.0.

          • out-of-range: out-of-range indication for the entire acquisition (False = in-range, True = out-of-range).

          • avg_cnt: number of averages.

      • bins: bin data

        • integration: integration data

          • path_0: input path 0 integration result bin list

          • path_1: input path 1 integration result bin list

        • threshold: threshold result bin list

        • valid: list of valid indications per bin

        • avg_cnt: list of number of averages per bin

Parameters:

sequencer (int) – Sequencer index.

Returns:

Dictionary with acquisitions.

Return type:

dict

Raises:

NotImplementedError – Functionality not available on this module.

get_assembler_log() → str

Important: This method calls get_assembler_log using functools.partial to set the slot index. The following docstring is of Cluster.get_assembler_log: Get assembler log.

Parameters:

slot (int) – slot index.

Returns:

Assembler log.

Return type:

str

Raises:

  • Exception – Invalid input parameter type.

  • Exception – An error is reported in system error and debug <= 1. All errors are read from system error and listed in the exception.

get_assembler_status() → bool

Important: This method calls get_assembler_status using functools.partial to set the slot index. The following docstring is of Cluster.get_assembler_status: Get assembler status. Refer to the assembler log to get more information regarding the assembler result.

Parameters:

slot (int) – slot index.

Returns:

Assembler status (False = failed, True = success).

Return type:

bool

Raises:

  • Exception – Invalid input parameter type.

  • Exception – An error is reported in system error and debug <= 1. All errors are read from system error and listed in the exception.

get_sequencer_state(sequencer: int, timeout: int = 0, timeout_poll_res: float = 0.02) → qblox_instruments.native.generic_func.SequencerState

Important: This method calls get_sequencer_state using functools.partial to set the slot index. The following docstring is of Cluster.get_sequencer_state: Get the sequencer state. If an invalid sequencer index is given, an error is set in system error. If the timeout is set to zero, the function returns the state immediately. If a positive non-zero timeout is set, the function blocks until the sequencer completes. If the sequencer hasn’t stopped before the timeout expires, a TimeoutError is thrown.

Parameters:

  • sequencer (int) – Sequencer index.

  • timeout (int) – Timeout in minutes.

  • timeout_poll_res (float) – Timeout polling resolution in seconds.

Returns:

Tuple containing sequencer status and corresponding flags.

Return type:

SequencerState

Raises:

TimeoutError – Timeout

get_waveforms(sequencer: int) → Dict

Important: This method calls get_waveforms using functools.partial to set the slot index. The following docstring is of Cluster.get_waveforms: Get all waveforms and weigths in the AWG waveform list of indexed sequencer. The returned dictionary is structured as follows:

  • name: waveform name.

    • data: waveform samples in a range of 1.0 to -1.0.

    • index: waveform index used by the sequencer Q1ASM program to refer

      to the waveform.

Parameters:

sequencer (int) – Sequencer index.

Returns:

Dictionary with waveforms.

Return type:

dict

get_weights(sequencer: int) → Dict

Important: This method calls get_weights using functools.partial to set the slot index. The following docstring is of Cluster.get_weights: Get all weigths in the acquisition weight lists of indexed sequencer. The returned dictionary is structured as follows:

-name : weight name.

  • data: weight samples in a range of 1.0 to -1.0.

  • index: weight index used by the sequencer Q1ASM program to refer

    to the weight.

Parameters:

sequencer (int) – Sequencer index.

Returns:

Dictionary with weights.

Return type:

dict

Raises:

NotImplementedError – Functionality not available on this module.

property is_qcm_type(self) → bool

Return if module is of type QCM.

Returns:

True if module is of type QCM.

Return type:

bool

Raises:

KeyError – Module is not available.

property is_qrm_type(self) → bool

Return if module is of type QRM.

Returns:

True if module is of type QRM.

Return type:

bool

Raises:

KeyError – Module is not available.

property is_rf_type(self) → bool

Return if module is of type QCM-RF or QRM-RF.

Returns:

True if module is of type QCM-RF or QRM-RF.

Return type:

bool

Raises:

KeyError – Module is not available.

property module_type(self) → qblox_instruments.types.InstrumentType

Get module type (e.g. QRM, QCM).

Returns:

Module type

Return type:

InstrumentType

Raises:

KeyError – Module is not available.

property sequencers(self) → List

Get list of sequencers submodules.

Returns:

List of sequencer submodules.

Return type:

list

set_dummy_binned_acquisition_data(sequencer: int, acq_index_name: str, data: Iterable[qblox_instruments.ieee488_2.dummy_transport.DummyBinnedAcquisitionData | None])

Important: This method calls set_dummy_binned_acquisition_data using functools.partial to set the slot index. The following docstring is of Cluster.set_dummy_binned_acquisition_data: Set dummy binned acquisition data for the dummy.

Parameters:

  • slot_idx (int) – Slot of the hardware you want to set the data to on a cluster.

  • sequencer (int) – Sequencer.

  • acq_index_name (str) – Acquisition index name.

  • data (Iterable[Union[DummyBinnedAcquisitionData, None]]) – Dummy data for the binned acquisition. An iterable of all the bin values.

set_dummy_scope_acquisition_data(sequencer: int | None, data: qblox_instruments.ieee488_2.dummy_transport.DummyScopeAcquisitionData)

Important: This method calls set_dummy_scope_acquisition_data using functools.partial to set the slot index. The following docstring is of Cluster.set_dummy_scope_acquisition_data: Set dummy scope acquisition data for the dummy.

Parameters:

  • slot_idx (int) – Slot of the hardware you want to set the data to on a cluster.

  • sequencer (Union[int, None]) – Sequencer.

  • data (DummyScopeAcquisitionData) – Dummy data for the scope acquisition.

property slot_idx(self) → int

Get slot index.

Returns:

Slot index

Return type:

int

start_sequencer(sequencer: int | None = None) → None

Important: This method calls start_sequencer using functools.partial to set the slot index. The following docstring is of Cluster.start_sequencer: Start the indexed sequencer, thereby putting it in the running state. If an invalid sequencer index is given or the indexed sequencer was not yet armed, an error is set in system error. If no sequencer index is given, all armed sequencers are started and any sequencer not in the armed state is ignored. However, if no sequencer index is given and no sequencers are armed, and error is set in system error.

Parameters:

sequencer (Optional[int]) – Sequencer index.

Raises:

RuntimeError – An error is reported in system error and debug <= 1. All errors are read from system error and listed in the exception.

stop_sequencer(sequencer: int | None = None) → None

Important: This method calls stop_sequencer using functools.partial to set the slot index. The following docstring is of Cluster.stop_sequencer: Stop the indexed sequencer, thereby putting it in the stopped state. If an invalid sequencer index is given, an error is set in system error. If no sequencer index is given, all sequencers are stopped.

Parameters:

sequencer (Optional[int]) – Sequencer index.

Raises:

RuntimeError – An error is reported in system error and debug <= 1. All errors are read from system error and listed in the exception.

store_scope_acquisition(sequencer: int, name: str) → None

Important: This method calls store_scope_acquisition using functools.partial to set the slot index. The following docstring is of Cluster.store_scope_acquisition: After an acquisition has completed, store the scope acquisition results in the acquisition specified by name of the indexed sequencers. If an invalid sequencer index is given an error is set in system error. To get access to the acquisition results, the sequencer will be stopped when calling this function.

Parameters:

  • sequencer (int) – Sequencer index.

  • name (str) – Acquisition name.

Raises:

NotImplementedError – Functionality not available on this module.