qblox#
Python dataclasses for compilation to Qblox hardware.
Module Contents#
Classes#
Specifies a certain parameter with a fixed max and min in a certain unit. |
|
Specifies the fixed hardware properties needed in the backend. |
|
Data structure describing a pulse or acquisition and containing all the information |
|
Dataclass containing all the settings for a generic LO instrument. |
|
Shared settings between all the Qblox modules. |
|
Settings for a baseband module. |
|
Global settings for the module to be set in the InstrumentCoordinator component. |
|
Sequencer level settings. |
|
Base class for a Qblox hardware description. |
|
Information needed to specify an complex input/output in the |
|
Information needed to specify a real input/output in the |
|
Information needed to specify a digital (marker) output (for |
|
Provide the functionality of retrieving valid channel names by inheriting this class. |
|
Information needed to specify a QRM in the |
|
Information needed to specify a QCM in the |
|
Information needed to specify a QRM-RF in the |
|
Information needed to specify a QCM-RF in the |
|
Information needed to specify a Cluster in the |
|
Input gain settings for a real input connected to a port-clock combination. |
|
Configuration options for a sequencer. |
|
Datastructure containing the hardware options for each port-clock combination. |
Attributes#
Specifies a Cluster module and its instrument-specific settings. |
|
Specifies a piece of Qblox hardware and its instrument-specific settings. |
|
Input gain settings for a real input connected to a port-clock combination. |
|
Output attenuation setting for a port-clock combination. |
|
Input attenuation setting for a port-clock combination. |
- class BoundedParameter[source]#
Specifies a certain parameter with a fixed max and min in a certain unit.
- class StaticHardwareProperties[source]#
Specifies the fixed hardware properties needed in the backend.
- mixer_dc_offset_range: BoundedParameter[source]#
Specifies the range over which the dc offsets can be set that are used for mixer calibration.
- channel_name_to_connected_io_indices: Dict[str, Tuple[int] | Tuple[int, int]][source]#
Specifies the connected io indices per channel_name identifier.
- default_marker: int = 0[source]#
The default marker value to set at the beginning of programs. Important for RF instruments that use the set_mrk command to enable/disable the RF output.
- channel_name_to_digital_marker: Dict[str, int][source]#
A mapping from channel_name to digital marker setting. Specifies which marker bit needs to be set at start if the output (as a string ex. complex_output_0) contains a pulse.
- class OpInfo[source]#
Bases:
dataclasses_json.DataClassJsonMixin
Data structure describing a pulse or acquisition and containing all the information required to play it.
- property is_real_time_io_operation: bool[source]#
Returns
True
if the operation is a non-idle pulse (i.e., it has a waveform),False
otherwise.
- property is_offset_instruction: bool[source]#
Returns
True
if the operation describes a DC offset operation, corresponding to the Q1ASM instructionset_awg_offset
.
- property is_parameter_instruction: bool[source]#
Return
True
if the instruction is a parameter, like a voltage offset.From the Qblox documentation: “parameter operation instructions” are latched and only updated when the upd_param, play, acquire, acquire_weighed or acquire_ttl instructions are executed.
Please refer to https://qblox-qblox-instruments.readthedocs-hosted.com/en/main/cluster/q1_sequence_processor.html#q1-instructions for the full list of these instructions.
- property is_parameter_update: bool[source]#
Return
True
if the operation is a parameter update, corresponding to the Q1ASM instructionupd_param
.
- property is_loop: bool[source]#
Return
True
if the operation is a loop, corresponding to the Q1ASM instructionloop
.
- property is_return_stack: bool[source]#
Return
True
if the operation is a return stack, corresponding to the Q1ASM instructionreturn_stack
.
- class LOSettings[source]#
Bases:
dataclasses_json.DataClassJsonMixin
Dataclass containing all the settings for a generic LO instrument.
- classmethod from_mapping(mapping: Dict[str, Any]) LOSettings [source]#
Factory method for the LOSettings from a mapping dict. The required format is {“frequency”: {parameter_name: value}, “power”: {parameter_name: value}}. For convenience {“frequency”: value, “power”: value} is also allowed.
- Parameters:
mapping – The part of the mapping dict relevant for this instrument.
- Returns:
Instantiated LOSettings from the mapping dict.
- class BaseModuleSettings[source]#
Bases:
dataclasses_json.DataClassJsonMixin
Shared settings between all the Qblox modules.
- class BasebandModuleSettings[source]#
Bases:
BaseModuleSettings
Settings for a baseband module.
Class exists to ensure that the cluster baseband modules don’t need special treatment in the rest of the code.
- classmethod extract_settings_from_mapping(mapping: Dict[str, Any], **kwargs: dict | None) BasebandModuleSettings [source]#
Factory method that takes all the settings defined in the mapping and generates a
BasebandModuleSettings
object from it.- Parameters:
mapping – The mapping dict to extract the settings from
**kwargs – Additional keyword arguments passed to the constructor. Can be used to override parts of the mapping dict.
- class RFModuleSettings[source]#
Bases:
BaseModuleSettings
Global settings for the module to be set in the InstrumentCoordinator component. This is kept separate from the settings that can be set on a per sequencer basis, which are specified in
SequencerSettings
.- lo0_freq: float | None[source]#
The frequency of Output 0 (O0) LO. If left None, the parameter will not be set.
- lo1_freq: float | None[source]#
The frequency of Output 1 (O1) LO. If left None, the parameter will not be set.
- classmethod extract_settings_from_mapping(mapping: Dict[str, Any], **kwargs: dict | None) RFModuleSettings [source]#
Factory method that takes all the settings defined in the mapping and generates an
RFModuleSettings
object from it.- Parameters:
mapping – The mapping dict to extract the settings from
**kwargs – Additional keyword arguments passed to the constructor. Can be used to override parts of the mapping dict.
- class SequencerSettings[source]#
Bases:
dataclasses_json.DataClassJsonMixin
Sequencer level settings.
In the Qblox driver these settings are typically recognized by parameter names of the form
"{module}.sequencer{index}.{setting}"
(for allowed values see Cluster QCoDeS parameters). These settings are set once and will remain unchanged after, meaning that these correspond to the “slow” QCoDeS parameters and not settings that are changed dynamically by the sequencer.These settings are mostly defined in the hardware configuration under each port-clock key combination or in some cases through the device configuration (e.g. parameters related to thresholded acquisition).
- channel_name: str[source]#
Specifies the channel identifier of the hardware config (e.g. complex_output_0).
- connected_output_indices: Tuple[int] | Tuple[int, int] | None[source]#
Specifies the indices of the outputs this sequencer produces waveforms for.
- connected_input_indices: Tuple[int] | Tuple[int, int] | None[source]#
Specifies the indices of the inputs this sequencer collects data for.
- init_offset_awg_path_I: float = 0.0[source]#
Specifies what value the sequencer offset for AWG path_I will be reset to before the start of the experiment.
- init_offset_awg_path_Q: float = 0.0[source]#
Specifies what value the sequencer offset for AWG path_Q will be reset to before the start of the experiment.
- init_gain_awg_path_I: float = 1.0[source]#
Specifies what value the sequencer gain for AWG path_I will be reset to before the start of the experiment.
- init_gain_awg_path_Q: float = 1.0[source]#
Specifies what value the sequencer gain for AWG path_Q will be reset to before the start of the experiment.
- mixer_corr_phase_offset_degree: float = 0.0[source]#
The phase shift to apply between the I and Q channels, to correct for quadrature errors.
- mixer_corr_gain_ratio: float = 1.0[source]#
The gain ratio to apply in order to correct for imbalances between the I and Q paths of the mixer.
- integration_length_acq: int | None[source]#
Integration length for acquisitions. Must be a multiple of 4 ns.
- sequence: Dict[str, Any] | None[source]#
JSON compatible dictionary holding the waveforms and program for the sequencer.
- thresholded_acq_threshold: float | None[source]#
The sequencer discretization threshold for discretizing the phase rotation result.
- thresholded_acq_rotation: float | None[source]#
The sequencer integration result phase rotation in degrees.
- ttl_acq_input_select: int | None[source]#
Selects the input used to compare against the threshold value in the TTL trigger acquisition path.
- ttl_acq_threshold: float | None[source]#
Sets the threshold value with which to compare the input ADC values of the selected input path.
- ttl_acq_auto_bin_incr_en: bool | None[source]#
Selects if the bin index is automatically incremented when acquiring multiple triggers.
- thresholded_acq_trigger_address: int | None[source]#
Sets the feedback trigger address to be used by conditional playback.
- thresholded_acq_trigger_invert: bool = False[source]#
If you want to set a trigger when the acquisition result is 1, the parameter must be set to false and vice versa.
- classmethod initialize_from_config_dict(sequencer_cfg: Dict[str, Any], channel_name: str, connected_output_indices: Tuple[int] | Tuple[int, int] | None, connected_input_indices: Tuple[int] | Tuple[int, int] | None) SequencerSettings [source]#
Instantiates an instance of this class, with initial parameters determined from the sequencer configuration dictionary.
- Parameters:
sequencer_cfg (dict) – The sequencer configuration dict.
channel_name – Specifies the channel identifier of the hardware config (e.g. complex_output_0).
connected_output_indices – Specifies the indices of the outputs this sequencer produces waveforms for.
connected_input_indices – Specifies the indices of the inputs this sequencer collects data for.
- Returns:
A SequencerSettings instance with initial values.
- Return type:
- class QbloxBaseDescription(/, **data: Any)[source]#
Bases:
quantify_scheduler.backends.types.common.HardwareDescription
Base class for a Qblox hardware description.
- class ComplexChannelDescription(/, **data: Any)[source]#
Bases:
quantify_scheduler.structure.model.DataStructure
Information needed to specify an complex input/output in the
QbloxHardwareCompilationConfig
.- marker_debug_mode_enable: bool = False[source]#
Setting to send 4 ns trigger pulse on the marker located next to the I/O port along with each operation. The marker will be pulled high at the same time as the module starts playing or acquiring.
- class RealChannelDescription(/, **data: Any)[source]#
Bases:
quantify_scheduler.structure.model.DataStructure
Information needed to specify a real input/output in the
QbloxHardwareCompilationConfig
.
- class DigitalChannelDescription(/, **data: Any)[source]#
Bases:
quantify_scheduler.structure.model.DataStructure
Information needed to specify a digital (marker) output (for
MarkerPulse
) in theQbloxHardwareCompilationConfig
.This datastructure is currently empty, since no extra settings are needed/allowed for a digital output.
- class DescriptionAnnotationsGettersMixin[source]#
Provide the functionality of retrieving valid channel names by inheriting this class.
- class QRMDescription(/, **data: Any)[source]#
Bases:
quantify_scheduler.structure.model.DataStructure
,DescriptionAnnotationsGettersMixin
Information needed to specify a QRM in the
QbloxHardwareCompilationConfig
.- complex_output_0: ComplexChannelDescription | None[source]#
Description of the complex output channel on this QRM, corresponding to ports O1 and O2.
- complex_input_0: ComplexChannelDescription | None[source]#
Description of the complex input channel on this QRM, corresponding to ports I1 and I2.
- real_output_0: RealChannelDescription | None[source]#
Description of the real output channel on this QRM, corresponding to port O1.
- real_output_1: RealChannelDescription | None[source]#
Description of the real output channel on this QRM, corresponding to port O2.
- real_input_0: RealChannelDescription | None[source]#
Description of the real input channel on this QRM, corresponding to port I1.
- real_input_1: RealChannelDescription | None[source]#
Description of the real output channel on this QRM, corresponding to port I2.
- digital_output_0: DigitalChannelDescription | None[source]#
Description of the digital (marker) output channel on this QRM, corresponding to port M1.
- digital_output_1: DigitalChannelDescription | None[source]#
Description of the digital (marker) output channel on this QRM, corresponding to port M2.
- digital_output_2: DigitalChannelDescription | None[source]#
Description of the digital (marker) output channel on this QRM, corresponding to port M3.
- digital_output_3: DigitalChannelDescription | None[source]#
Description of the digital (marker) output channel on this QRM, corresponding to port M4.
- class QCMDescription(/, **data: Any)[source]#
Bases:
quantify_scheduler.structure.model.DataStructure
,DescriptionAnnotationsGettersMixin
Information needed to specify a QCM in the
QbloxHardwareCompilationConfig
.- complex_output_0: ComplexChannelDescription | None[source]#
Description of the complex output channel on this QRM, corresponding to ports O1 and O2.
- complex_output_1: ComplexChannelDescription | None[source]#
Description of the complex output channel on this QRM, corresponding to ports O3 and O4.
- real_output_0: RealChannelDescription | None[source]#
Description of the real output channel on this QRM, corresponding to port O1.
- real_output_1: RealChannelDescription | None[source]#
Description of the real output channel on this QRM, corresponding to port O2.
- real_output_2: RealChannelDescription | None[source]#
Description of the real output channel on this QRM, corresponding to port O3.
- real_output_3: RealChannelDescription | None[source]#
Description of the real output channel on this QRM, corresponding to port O4.
- digital_output_0: DigitalChannelDescription | None[source]#
Description of the digital (marker) output channel on this QRM, corresponding to port M1.
- digital_output_1: DigitalChannelDescription | None[source]#
Description of the digital (marker) output channel on this QRM, corresponding to port M2.
- digital_output_2: DigitalChannelDescription | None[source]#
Description of the digital (marker) output channel on this QRM, corresponding to port M3.
- digital_output_3: DigitalChannelDescription | None[source]#
Description of the digital (marker) output channel on this QRM, corresponding to port M4.
- class QRMRFDescription(/, **data: Any)[source]#
Bases:
quantify_scheduler.structure.model.DataStructure
,DescriptionAnnotationsGettersMixin
Information needed to specify a QRM-RF in the
QbloxHardwareCompilationConfig
.- complex_output_0: ComplexChannelDescription | None[source]#
Description of the complex output channel on this QRM, corresponding to port O1.
- complex_input_0: ComplexChannelDescription | None[source]#
Description of the complex input channel on this QRM, corresponding to port I1.
- digital_output_0: DigitalChannelDescription | None[source]#
Description of the digital (marker) output channel on this QRM, corresponding to port M1.
- digital_output_1: DigitalChannelDescription | None[source]#
Description of the digital (marker) output channel on this QRM, corresponding to port M2.
- class QCMRFDescription(/, **data: Any)[source]#
Bases:
quantify_scheduler.structure.model.DataStructure
,DescriptionAnnotationsGettersMixin
Information needed to specify a QCM-RF in the
QbloxHardwareCompilationConfig
.- complex_output_0: ComplexChannelDescription | None[source]#
Description of the complex output channel on this QRM, corresponding to port O1.
- complex_output_1: ComplexChannelDescription | None[source]#
Description of the complex output channel on this QRM, corresponding to port O2.
- digital_output_0: DigitalChannelDescription | None[source]#
Description of the digital (marker) output channel on this QRM, corresponding to port M1.
- digital_output_1: DigitalChannelDescription | None[source]#
Description of the digital (marker) output channel on this QRM, corresponding to port M2.
- ClusterModuleDescription[source]#
Specifies a Cluster module and its instrument-specific settings.
The supported instrument types are:
QRMDescription
,QCMDescription
,QRMRFDescription
,QCMRFDescription
,
- class ClusterDescription(/, **data: Any)[source]#
Bases:
QbloxBaseDescription
Information needed to specify a Cluster in the
CompilationConfig
.- instrument_type: Literal[Cluster][source]#
The instrument type, used to select this datastructure when parsing a
CompilationConfig
.
- QbloxHardwareDescription[source]#
Specifies a piece of Qblox hardware and its instrument-specific settings.
- RealInputGain[source]#
Input gain settings for a real input connected to a port-clock combination.
This gain value will be set on the QRM input ports that are connected to this port-clock combination.
Example
hardware_compilation_config.hardware_options.input_gain = { "q0:res-q0.ro": RealInputGain(2), }
- class ComplexInputGain(/, **data: Any)[source]#
Bases:
quantify_scheduler.structure.model.DataStructure
Input gain settings for a real input connected to a port-clock combination.
This gain value will be set on the QRM input ports that are connected to this port-clock combination.
Example
hardware_compilation_config.hardware_options.input_gain = { "q0:res-q0.ro": ComplexInputGain( gain_I=2, gain_Q=3 ), }
- OutputAttenuation[source]#
Output attenuation setting for a port-clock combination.
This attenuation value will be set on each control-hardware output port that is connected to this port-clock combination.
Example
hardware_compilation_config.hardware_options.output_att = { "q0:res-q0.ro": OutputAttenuation(10), }
- InputAttenuation[source]#
Input attenuation setting for a port-clock combination.
This attenuation value will be set on each control-hardware output port that is connected to this port-clock combination.
Example
hardware_compilation_config.hardware_options.input_att = { "q0:res-q0.ro": InputAttenuation(10), }
- class SequencerOptions(/, **data: Any)[source]#
Bases:
quantify_scheduler.structure.model.DataStructure
Configuration options for a sequencer.
For allowed values, also see Cluster QCoDeS parameters.
Example
hardware_compilation_config.hardware_options.sequencer_options = { "q0:res-q0.ro": { "init_offset_awg_path_I": 0.1, "init_offset_awg_path_Q": -0.1, "init_gain_awg_path_I": 0.9, "init_gain_awg_path_Q": 1.0, "ttl_acq_threshold": 0.5 "qasm_hook_func": foo } }
- init_offset_awg_path_I: float = 0.0[source]#
Specifies what value the sequencer offset for AWG path_I will be reset to before the start of the experiment.
- init_offset_awg_path_Q: float = 0.0[source]#
Specifies what value the sequencer offset for AWG path_Q will be reset to before the start of the experiment.
- init_gain_awg_path_I: float = 1.0[source]#
Specifies what value the sequencer gain for AWG path_I will be reset to before the start of the experiment.
- init_gain_awg_path_Q: float = 1.0[source]#
Specifies what value the sequencer gain for AWG path_Q will be reset to before the start of the experiment.
- ttl_acq_threshold: float | None[source]#
Threshold value with which to compare the input ADC values of the selected input path.
- class QbloxHardwareOptions(/, **data: Any)[source]#
Bases:
quantify_scheduler.backends.types.common.HardwareOptions
Datastructure containing the hardware options for each port-clock combination.
Example
Here, the HardwareOptions datastructure is created by parsing a dictionary containing the relevant information.
import pprint from quantify_scheduler.schemas.examples.utils import ( load_json_example_scheme )
from quantify_scheduler.backends.types.qblox import ( QbloxHardwareOptions ) qblox_hw_options_dict = load_json_example_scheme( "qblox_hardware_compilation_config.json")["hardware_options"] pprint.pprint(qblox_hw_options_dict)
{'distortion_corrections': {'q0:fl-cl0.baseband': {'clipping_values': [-2.5, 2.5], 'filter_func': 'scipy.signal.lfilter', 'input_var_name': 'x', 'kwargs': {'a': [1], 'b': [0, 0.25, 0.5]}}}, 'input_att': {'q0:res-q0.ro': 4, 'q5:res-q5.ro': 10}, 'input_gain': {'q4:res-q4.ro': {'gain_I': 2, 'gain_Q': 3}}, 'latency_corrections': {'q4:mw-q4.01': 8e-09, 'q5:mw-q5.01': 4e-09}, 'mixer_corrections': {'q4:mw-q4.01': {'amp_ratio': 0.9999, 'phase_error': -4.2}, 'q4:res-q4.ro': {'amp_ratio': 0.9997, 'dc_offset_i': -0.054, 'dc_offset_q': -0.034, 'phase_error': -4.0}}, 'modulation_frequencies': {'q0:mw-q0.01': {'interm_freq': 50000000.0, 'lo_freq': None}, 'q0:res-q0.ro': {'interm_freq': None, 'lo_freq': 7800000000.0}, 'q4:mw-q4.01': {'interm_freq': 200000000.0, 'lo_freq': None}, 'q4:res-q4.ro': {'interm_freq': None, 'lo_freq': 7200000000.0}, 'q5:mw-q5.01': {'interm_freq': 50000000.0, 'lo_freq': None}, 'q5:res-q5.ro': {'interm_freq': 50000000.0}, 'q6:mw-q6.01': {'lo_freq': 5000000000.0}}, 'output_att': {'q0:mw-q0.01': 4, 'q0:res-q0.ro': 12, 'q5:mw-q5.01': 4, 'q6:mw-q6.01': 6}, 'sequencer_options': {'qe0:optical_readout-qe0.ge0': {'ttl_acq_threshold': 0.5}}}
The dictionary can be parsed using the
model_validate
method.qblox_hw_options = QbloxHardwareOptions.model_validate(qblox_hw_options_dict) qblox_hw_options
QbloxHardwareOptions(latency_corrections={'q4:mw-q4.01': 8e-09, 'q5:mw-q5.01': 4e-09}, distortion_corrections={'q0:fl-cl0.baseband': DistortionCorrection(filter_func='scipy.signal.lfilter', input_var_name='x', kwargs={'b': [0, 0.25, 0.5], 'a': [1]}, clipping_values=[-2.5, 2.5], sampling_rate=1000000000.0)}, modulation_frequencies={'q0:res-q0.ro': ModulationFrequencies(interm_freq=None, lo_freq=7800000000.0), 'q0:mw-q0.01': ModulationFrequencies(interm_freq=50000000.0, lo_freq=None), 'q4:mw-q4.01': ModulationFrequencies(interm_freq=200000000.0, lo_freq=None), 'q4:res-q4.ro': ModulationFrequencies(interm_freq=None, lo_freq=7200000000.0), 'q5:mw-q5.01': ModulationFrequencies(interm_freq=50000000.0, lo_freq=None), 'q5:res-q5.ro': ModulationFrequencies(interm_freq=50000000.0, lo_freq=None), 'q6:mw-q6.01': ModulationFrequencies(interm_freq=None, lo_freq=5000000000.0)}, mixer_corrections={'q4:mw-q4.01': MixerCorrections(dc_offset_i=0.0, dc_offset_q=0.0, amp_ratio=0.9999, phase_error=-4.2), 'q4:res-q4.ro': MixerCorrections(dc_offset_i=-0.054, dc_offset_q=-0.034, amp_ratio=0.9997, phase_error=-4.0)}, input_gain={'q4:res-q4.ro': ComplexInputGain(gain_I=2, gain_Q=3)}, output_att={'q0:mw-q0.01': 4, 'q0:res-q0.ro': 12, 'q5:mw-q5.01': 4, 'q6:mw-q6.01': 6}, input_att={'q0:res-q0.ro': 4, 'q5:res-q5.ro': 10}, sequencer_options={'qe0:optical_readout-qe0.ge0': SequencerOptions(init_offset_awg_path_I=0.0, init_offset_awg_path_Q=0.0, init_gain_awg_path_I=1.0, init_gain_awg_path_Q=1.0, ttl_acq_threshold=0.5, qasm_hook_func=None)})
- input_gain: Dict[str, RealInputGain | ComplexInputGain] | None[source]#
Dictionary containing the input gain settings (values) that should be applied to the inputs that are connected to a certain port-clock combination (keys).
- output_att: Dict[str, OutputAttenuation] | None[source]#
Dictionary containing the attenuation settings (values) that should be applied to the outputs that are connected to a certain port-clock combination (keys).
- input_att: Dict[str, InputAttenuation] | None[source]#
Dictionary containing the attenuation settings (values) that should be applied to the inputs that are connected to a certain port-clock combination (keys).
- sequencer_options: Dict[str, SequencerOptions] | None[source]#
Dictionary containing the options (values) that should be set on the sequencer that is used for a certain port-clock combination (keys).