quantify_scheduler.backends.types.zhinst

Python dataclasses for quantify-scheduler json-schemas.

Module Contents

Classes

DeviceType	Enum of device types.
Output	The definition class for zhinst channel properties.
Device	The device definition class for zhinst devices.
CommandTableHeader	The CommandTable header definition.
CommandTableEntryValue	A CommandTable entry definition with a value.
CommandTableWaveform	The command table waveform properties.
CommandTableEntry	The definition of a single CommandTable entry.
CommandTable	The CommandTable definition for ZI HDAWG.
QasIntegrationMode	Operation mode of all weighted integration units.
QasResultMode	UHFQA QAS result mode.
QasResultSource	UHFQA QAS result source.
WaveformDestination	The waveform destination enum type.
InstrumentInfo	Instrument information record type.
Instruction	Sequence base instruction record type.
Acquisition	This instruction indicates that an acquisition is to be triggered in the UHFQA.
Wave	This instruction indicates that a waveform should be played.

class DeviceType

Bases: str, enum.Enum

Enum of device types.

Initialize self. See help(type(self)) for accurate signature.

HDAWG = 'HDAWG'

UHFQA = 'UHFQA'

UHFLI = 'UHFLI'

MFLI = 'MFLI'

PQSC = 'PQSC'

NONE = 'none'

class Output

Bases: dataclasses_json.DataClassJsonMixin

The definition class for zhinst channel properties.

This class maps to the zhinst backend JSON “channel” properties defined in the hardware mapping.

Parameters:

• port – The port resource.

• clock – The Clock resource.

• clock_frequency – The frequency for the clock resource (AKA RF/signal frequency).

• mode – The output mode type.

• modulation – The modulation settings.

• local_oscillator – The LocalOscillator name.

• gain1 – The output1 IQ modulation gain. Accepted value between -1 and + 1. (default = 1.0)

• gain2 – The output2 IQ modulation gain. Accepted value between -1 and + 1. (default = 1.0)

• trigger – The ZI Instrument input trigger. (default = None) Setting this will declare the device secondary

• markers – The ZI Instrument output triggers. (default = [])

• mixer_corrections – The output mixer corrections.

port: str

clock: str

mode: quantify_scheduler.enums.SignalModeType

modulation: quantify_scheduler.backends.types.common.Modulation

local_oscillator: str

clock_frequency: Optional[float]

gain1: int = 0

gain2: int = 0

trigger: Optional[int]

markers: List[Union[str, int]]

mixer_corrections: Optional[quantify_scheduler.backends.types.common.MixerCorrections]

class Device

Bases: dataclasses_json.DataClassJsonMixin

The device definition class for zhinst devices.

This class maps to the zhinst backend JSON “devices” properties defined in the hardware mapping.

Parameters:

• name – The QCodes Instrument name.

• type – The instrument model type. For example: ‘UHFQA’, ‘HDAWG4’, ‘HDAWG8’

• ref – The reference source type.

• channels – The list of channels. (auto generated)

• channel_0 – The first physical channel properties.

• channel_1 – The second physical channel properties.

• channel_2 – The third physical channel properties.

• channel_3 – The fourth physical channel properties.

• channelgrouping – The HDAWG channelgrouping property. (default = 0) corresponding to a single sequencer controlling a pair (2) awg outputs.

• clock_select –

  The clock rate divisor which will be used to get the instruments clock rate from the lookup dictionary in quantify_scheduler.backends.zhinst_backend.DEVICE_CLOCK_RATES.

  For information see zhinst User manuals, section /DEV…./AWGS/n/TIME Examples: base sampling rate (1.8 GHz) divided by 2^clock_select. (default = 0)

• mode – The Instruments operation mode. (default = enums.InstrumentOperationMode.OPERATING)

• device_type – The Zurich Instruments hardware type. (default = DeviceType.NONE) This field is automatically populated.

• sample_rate – The Instruments sampling clock rate. This field is automatically populated.

• n_channels – The number of physical channels of this ZI Instrument. This field is automatically populated.

name: str

type: str

ref: quantify_scheduler.enums.ReferenceSourceType

channels: List[Output]

channel_0: Output

channel_1: Optional[Output]

channel_2: Optional[Output]

channel_3: Optional[Output]

clock_select: Optional[int] = 0

channelgrouping: int = 0

mode: quantify_scheduler.enums.InstrumentOperationMode

device_type: DeviceType

sample_rate: Optional[int]

n_channels: int

class CommandTableHeader

Bases: dataclasses_json.DataClassJsonMixin

The CommandTable header definition.

version: str = '0.2'

partial: bool = False

class CommandTableEntryValue

Bases: dataclasses_json.DataClassJsonMixin

A CommandTable entry definition with a value.

value: int

class CommandTableWaveform

Bases: dataclasses_json.DataClassJsonMixin

The command table waveform properties.

index: int

length: int

class CommandTableEntry

Bases: dataclasses_json.DataClassJsonMixin

The definition of a single CommandTable entry.

index: int

waveform: CommandTableWaveform

class CommandTable

Bases: dataclasses_json.DataClassJsonMixin

The CommandTable definition for ZI HDAWG.

header: CommandTableHeader

table: List[CommandTableEntry]

class QasIntegrationMode

Bases: enum.Enum

Operation mode of all weighted integration units.

NORMAL: Normal mode. The integration weights are given by the user-programmed filter memory.

SPECTROSCOPY: Spectroscopy mode. The integration weights are generated by a digital oscillator. This mode offers enhanced frequency resolution.

NORMAL = 0

SPECTROSCOPY = 1

class QasResultMode

Bases: enum.Enum

UHFQA QAS result mode.

CYCLIC = 0

SEQUENTIAL = 1

class QasResultSource

Bases: enum.Enum

UHFQA QAS result source.

CROSSTALK = 0

THRESHOLD = 1

ROTATION = 3

CROSSTALK_CORRELATION = 4

THRESHOLD_CORRELATION = 5

INTEGRATION = 7

class WaveformDestination

Bases: enum.Enum

The waveform destination enum type.

CSV = 0

WAVEFORM_TABLE = 1

class InstrumentInfo

Instrument information record type.

sample_rate: int

num_samples_per_clock: int

granularity: int

mode: quantify_scheduler.enums.InstrumentOperationMode

sequencer_rate: float

class Instruction

Sequence base instruction record type.

waveform_id: str

abs_time: float

clock_cycle_start: int

duration: float

static default()

Returns a default Instruction instance.

Return type:

Instruction

class Acquisition

Bases: Instruction

This instruction indicates that an acquisition is to be triggered in the UHFQA. If a waveform_id is specified, this waveform will be used as the integration weight.

class Wave

Bases: Instruction

This instruction indicates that a waveform should be played.