# Repository: https://gitlab.com/quantify-os/quantify-scheduler
# Licensed according to the LICENCE file on the main branch
from typing import Any, Dict
from qcodes.instrument import InstrumentChannel
from qcodes.instrument.base import InstrumentBase
from quantify_core.utilities import deprecated
from qcodes.instrument.parameter import (
InstrumentRefParameter,
ManualParameter,
Parameter,
)
from qcodes.utils import validators
from quantify_scheduler.backends.circuit_to_device import (
DeviceCompilationConfig,
OperationCompilationConfig,
)
from quantify_scheduler.helpers.validators import Numbers
from quantify_scheduler.device_under_test.device_element import DeviceElement
from quantify_scheduler.operations import (
pulse_factories,
pulse_library,
measurement_factories,
)
[docs]class Ports(InstrumentChannel):
"""
Submodule containing the ports.
"""
def __init__(self, parent: InstrumentBase, name: str, **kwargs: Any) -> None:
super().__init__(parent=parent, name=name)
[docs] self.microwave = Parameter(
"microwave",
instrument=self,
initial_cache_value=kwargs.get("microwave", f"{parent.name}:mw"),
set_cmd=False,
)
"""Name of the element's microwave port."""
[docs] self.flux = Parameter(
"flux",
instrument=self,
initial_cache_value=kwargs.get("flux", f"{parent.name}:fl"),
set_cmd=False,
)
"""Name of the element's flux port."""
[docs] self.readout = Parameter(
"readout",
instrument=self,
initial_cache_value=kwargs.get("readout", f"{parent.name}:res"),
set_cmd=False,
)
"""Name of the element's readout port."""
[docs]class ClocksFrequencies(InstrumentChannel):
"""
Submodule containing the clock frequencies specifying the transitions to address.
"""
def __init__(self, parent: InstrumentBase, name: str, **kwargs: Any) -> None:
super().__init__(parent=parent, name=name)
[docs] self.f01 = ManualParameter(
"f01",
instrument=self,
label="Qubit frequency",
unit="Hz",
initial_value=kwargs.get("f01", float("nan")),
vals=Numbers(min_value=0, max_value=1e12, allow_nan=True),
)
"""Frequency of the 01 clock"""
[docs] self.f12 = ManualParameter(
"f12",
instrument=self,
label="Frequency of the |1>-|2> transition",
unit="Hz",
initial_value=kwargs.get("f12", float("nan")),
vals=Numbers(min_value=0, max_value=1e12, allow_nan=True),
)
"""Frequency of the 12 clock"""
[docs] self.readout = ManualParameter(
"readout",
instrument=self,
label="Readout frequency",
unit="Hz",
initial_value=kwargs.get("readout", float("nan")),
vals=Numbers(min_value=0, max_value=1e12, allow_nan=True),
)
"""Frequency of the ro clock. """
[docs]class IdlingReset(InstrumentChannel):
"""
Submodule containing parameters for doing a reset by idling.
"""
def __init__(self, parent: InstrumentBase, name: str, **kwargs: Any) -> None:
super().__init__(parent=parent, name=name)
[docs] self.duration = ManualParameter(
"duration",
instrument=self,
initial_value=kwargs.get("duration", 200e-6),
unit="s",
vals=validators.Numbers(min_value=0, max_value=1),
)
"""Duration of the passive qubit reset (initialization by relaxation)."""
[docs]class RxyDRAG(InstrumentChannel):
"""
Submodule containing parameters for performing an Rxy operation
using a DRAG pulse.
"""
def __init__(self, parent: InstrumentBase, name: str, **kwargs: Any) -> None:
super().__init__(parent=parent, name=name)
[docs] self.amp180 = ManualParameter(
"amp180",
instrument=self,
label=r"$\pi-pulse amplitude$",
initial_value=kwargs.get("amp180", float("nan")),
unit="V",
vals=Numbers(min_value=-10, max_value=10, allow_nan=True),
)
r"""Amplitude required to perform a $\pi$ pulse."""
[docs] self.motzoi = ManualParameter(
"motzoi",
instrument=self,
initial_value=kwargs.get("motzoi", 0),
unit="",
vals=validators.Numbers(min_value=-1, max_value=1),
)
"""Ratio between the Gaussian Derivative (D) and Gaussian (G)
components of the DRAG pulse."""
[docs] self.duration = ManualParameter(
"duration",
instrument=self,
initial_value=kwargs.get("duration", 20e-9),
unit="s",
vals=validators.Numbers(min_value=0, max_value=1),
)
"""Duration of the control pulse."""
[docs]class DispersiveMeasurement(InstrumentChannel):
"""
Submodule containing parameters to perform a measurement using
:func:`~quantify_scheduler.operations.measurement_factories.dispersive_measurement`
"""
def __init__(self, parent: InstrumentBase, name: str, **kwargs: Any) -> None:
super().__init__(parent=parent, name=name)
pulse_types = validators.Enum("SquarePulse")
[docs] self.pulse_type = ManualParameter(
"pulse_type",
instrument=self,
initial_value=kwargs.get("pulse_type", "SquarePulse"),
vals=pulse_types,
)
"""Envelope function that defines the shape of the readout pulse prior to
modulation."""
[docs] self.pulse_amp = ManualParameter(
"pulse_amp",
instrument=self,
initial_value=kwargs.get("pulse_amp", 0.25),
unit="V",
vals=validators.Numbers(min_value=0, max_value=2),
)
"""Amplitude of the readout pulse."""
[docs] self.pulse_duration = ManualParameter(
"pulse_duration",
instrument=self,
initial_value=kwargs.get("pulse_duration", 300e-9),
unit="s",
vals=validators.Numbers(min_value=0, max_value=1),
)
"""Duration of the readout pulse."""
[docs] self.acq_channel = ManualParameter(
"acq_channel",
instrument=self,
initial_value=kwargs.get("acq_channel", 0),
unit="#",
vals=validators.Ints(min_value=0),
)
"""Acquisition channel of to this device element."""
[docs] self.acq_delay = ManualParameter(
"acq_delay",
instrument=self,
initial_value=kwargs.get("acq_delay", 0), # float("nan"),
unit="s",
# in principle the values should be a few 100 ns but the validator is here
# only to protect against silly typos that lead to out of memory errors.
vals=validators.Numbers(min_value=0, max_value=100e-6),
)
"""Delay between the start of the readout pulse and the start of
the acquisition. Note that some hardware backends do not support
starting a pulse and the acquisition in the same clock cycle making 0
delay an invalid value."""
[docs] self.integration_time = ManualParameter(
"integration_time",
instrument=self,
initial_value=kwargs.get("integration_time", 1e-6),
unit="s",
# in principle the values should be a few us but the validator is here
# only to protect against silly typos that lead to out of memory errors.
vals=validators.Numbers(min_value=0, max_value=100e-6),
)
"""Integration time for the readout acquisition."""
[docs] self.reset_clock_phase = ManualParameter(
"reset_clock_phase",
instrument=self,
initial_value=kwargs.get("reset_clock_phase", True),
vals=validators.Bool(),
)
"""The phase of the measurement clock will be reset by the
control hardware at the start of each measurement if
``reset_clock_phase=True``."""
ro_acq_weight_type_validator = validators.Enum("SSB")
self.acq_weight_type = ManualParameter(
"acq_weight_type",
instrument=self,
initial_value=kwargs.get("acq_weight_type", "SSB"),
vals=ro_acq_weight_type_validator,
)
[docs]class BasicTransmonElement(DeviceElement):
"""
A device element representing a single fixed-frequency transmon qubit coupled to a
readout resonator.
"""
def __init__(self, name: str, **kwargs):
"""
Parameters
----------
name
The name of the transmon element.
kwargs
Can be used to pass submodule initialization data by using submodule name
as keyword and as argument a dictionary containing the submodule parameter
names and their value.
"""
submodules_to_add = {
"reset": IdlingReset,
"rxy": RxyDRAG,
"measure": DispersiveMeasurement,
"ports": Ports,
"clock_freqs": ClocksFrequencies,
}
submodule_data = {
sub_name: kwargs.pop(sub_name, {}) for sub_name in submodules_to_add.keys()
}
super().__init__(name, **kwargs)
for sub_name, sub_class in submodules_to_add.items():
self.add_submodule(
sub_name,
sub_class(
parent=self, name=sub_name, **submodule_data.get(sub_name, {})
),
)
[docs] self.reset: IdlingReset
"""Submodule :class:`~.IdlingReset`."""
"""Submodule :class:`~.RxyDRAG`."""
[docs] self.measure: DispersiveMeasurement
"""Submodule :class:`~.DispersiveMeasurement`."""
"""Submodule :class:`~.Ports`."""
[docs] self.clock_freqs: ClocksFrequencies
"""Submodule :class:`~.ClocksFrequencies`."""
def __getstate__(self):
"""
Serializes `BasicTransmonElement` by obtaining relevant information from
:func:`~Instrument.snapshot()`. The relevant information consists of the name
of the transmon element and a dictionary for each submodule containing its
parameter names and corresponding values.
"""
snapshot = self.snapshot()
data = {"name": snapshot["name"]}
for submodule_name, submodule_data in snapshot["submodules"].items():
parameter_dict = {}
for parameter_name, parameter_data in submodule_data["parameters"].items():
parameter_dict[parameter_name] = parameter_data["value"]
data[submodule_name] = parameter_dict
state = {
"deserialization_type": self.__class__.__name__,
"mode": "__init__",
"data": data,
}
return state
[docs] def _generate_config(self) -> Dict[str, Dict[str, OperationCompilationConfig]]:
"""
Generates part of the device configuration specific to a single qubit.
This method is intended to be used when this object is part of a
device object containing multiple elements.
"""
qubit_config = {
f"{self.name}": {
"reset": OperationCompilationConfig(
factory_func=pulse_library.IdlePulse,
factory_kwargs={
"duration": self.reset.duration(),
},
),
# example of a pulse with a parametrized mapping, using a factory
"Rxy": OperationCompilationConfig(
factory_func=pulse_factories.rxy_drag_pulse,
factory_kwargs={
"amp180": self.rxy.amp180(),
"motzoi": self.rxy.motzoi(),
"port": self.ports.microwave(),
"clock": f"{self.name}.01",
"duration": self.rxy.duration(),
},
gate_info_factory_kwargs=[
"theta",
"phi",
], # the keys from the gate info to pass to the factory function
),
# the measurement also has a parametrized mapping, and uses a
# factory function.
"measure": OperationCompilationConfig(
factory_func=measurement_factories.dispersive_measurement,
factory_kwargs={
"port": self.ports.readout(),
"clock": f"{self.name}.ro",
"pulse_type": self.measure.pulse_type(),
"pulse_amp": self.measure.pulse_amp(),
"pulse_duration": self.measure.pulse_duration(),
"acq_delay": self.measure.acq_delay(),
"acq_duration": self.measure.integration_time(),
"acq_channel": self.measure.acq_channel(),
"acq_protocol_default": "SSBIntegrationComplex",
"reset_clock_phase": self.measure.reset_clock_phase(),
},
gate_info_factory_kwargs=["acq_index", "bin_mode", "acq_protocol"],
),
}
}
return qubit_config
[docs] def generate_device_config(self) -> DeviceCompilationConfig:
"""
Generates a valid device config for the quantify-scheduler making use of the
:func:`~.circuit_to_device.compile_circuit_to_device` function.
This enables the settings of this qubit to be used in isolation.
.. note:
This config is only valid for single qubit experiments.
"""
cfg_dict = {
"backend": "quantify_scheduler.backends"
".circuit_to_device.compile_circuit_to_device",
"elements": self._generate_config(),
"clocks": {
f"{self.name}.01": self.clock_freqs.f01(),
f"{self.name}.12": self.clock_freqs.f12(),
f"{self.name}.ro": self.clock_freqs.readout(),
},
"edges": {},
}
dev_cfg = DeviceCompilationConfig.parse_obj(cfg_dict)
return dev_cfg
@deprecated(
"0.8",
"Consider replacing with BasicTransmonElement or implementing a custom device "
"element.",
)
[docs]class TransmonElement(DeviceElement):
"""
A device element representing a single transmon coupled to a
readout resonator.
This object can be used to generate configuration files compatible with the
:func:`~quantify_scheduler.compilation.add_pulse_information_transmon` function.
"""
def __init__(self, name: str, **kwargs):
"""
Initializes the parent class and adds
:class:`~qcodes.instrument.parameter.Parameter` s /
:class:`~qcodes.instrument.parameter.ManualParameter` s /
:class:`~qcodes.instrument.parameter.InstrumentRefParameter` s to it.
The list of all parameters and their latest (cached) value can be listed as
follows:
.. jupyter-execute::
import warnings
warnings.filterwarnings("ignore", category=FutureWarning)
from quantify_scheduler.device_under_test import transmon_element
q0 = transmon_element.TransmonElement("q0")
q0.print_readable_snapshot()
Parameters
-----------
name:
The name of the transmon element.
"""
super().__init__(name, **kwargs)
# pylint: disable=fixme
# TODO: create DeviceElement parent class and make instrument_coordinator
# a parameter of that class, see issue quantify-scheduler#148
self.add_parameter(
"instrument_coordinator",
initial_value=None,
parameter_class=InstrumentRefParameter,
vals=validators.Strings(),
)
self._add_device_parameters()
[docs] def _add_device_parameters(self):
self.add_parameter(
"init_duration",
docstring="""Duration of the passive qubit reset
(initialization by relaxation).""",
initial_value=200e-6,
unit="s",
parameter_class=ManualParameter,
vals=validators.Numbers(min_value=0, max_value=1),
)
self.add_parameter(
"mw_amp180",
docstring=r"""Amplitude of the $\pi$ pulse
(considering a pulse duration of `mw_pulse_duration`).""",
label=r"$\pi-pulse amplitude$",
initial_value=float("nan"),
unit="V",
parameter_class=ManualParameter,
vals=Numbers(min_value=-10, max_value=10, allow_nan=True),
)
self.add_parameter(
"mw_motzoi",
docstring="""Ratio between the Gaussian Derivative (D) and Gaussian (G)
components of the DRAG pulse.""",
initial_value=0,
unit="",
parameter_class=ManualParameter,
vals=validators.Numbers(min_value=-1, max_value=1),
)
self.add_parameter(
"mw_pulse_duration",
docstring=(
"Duration of the pulses applied on the transmon's microwave port."
),
initial_value=20e-9,
unit="s",
parameter_class=ManualParameter,
vals=validators.Numbers(min_value=0, max_value=1),
)
self.add_parameter(
"mw_ef_amp180",
docstring=(
"Amplitude of the pulse necessary to drive the |1>-|2> "
"transition (considering a pulse duration of `mw_pulse_duration`)."
),
unit="V",
initial_value=float("nan"),
parameter_class=ManualParameter,
vals=Numbers(min_value=-10, max_value=10, allow_nan=True),
)
self.add_parameter(
"mw_port",
docstring=r"Name of the transmon's microwave port.",
initial_cache_value=f"{self.name}:mw",
parameter_class=Parameter,
set_cmd=False,
)
self.add_parameter(
"fl_port",
docstring=r"Name of the transmon's flux port.",
initial_cache_value=f"{self.name}:fl",
parameter_class=Parameter,
set_cmd=False,
)
self.add_parameter(
"ro_port",
docstring=r"Name of the transmon's readout resonator port.",
initial_cache_value=f"{self.name}:res",
parameter_class=Parameter,
set_cmd=False,
)
self.add_parameter(
"mw_01_clock",
docstring=r"Name of the clock corresponding to the qubit frequency.",
initial_cache_value=f"{self.name}.01",
parameter_class=Parameter,
set_cmd=False,
)
self.add_parameter(
"mw_12_clock",
docstring=(
"Name of the clock corresponding to the |1>-|2> transition "
"frequency."
),
initial_cache_value=f"{self.name}.12",
parameter_class=Parameter,
set_cmd=False,
)
self.add_parameter(
"ro_clock",
docstring=r"Name of the readout resonator clock.",
initial_cache_value=f"{self.name}.ro",
parameter_class=Parameter,
set_cmd=False,
)
self.add_parameter(
"freq_01",
label="Qubit frequency",
unit="Hz",
parameter_class=ManualParameter,
initial_value=float("nan"),
vals=Numbers(min_value=0, max_value=1e12, allow_nan=True),
)
self.add_parameter(
"freq_12",
label="Frequency of the |1>-|2> transition",
unit="Hz",
initial_value=float("nan"),
parameter_class=ManualParameter,
vals=Numbers(min_value=0, max_value=1e12, allow_nan=True),
)
self.add_parameter(
"ro_freq",
docstring="Frequency of the pulse sent to the readout resonator.",
label="Readout frequency",
unit="Hz",
parameter_class=ManualParameter,
initial_value=float("nan"),
vals=Numbers(min_value=0, max_value=1e12, allow_nan=True),
)
self.add_parameter(
"ro_pulse_amp",
docstring="Amplitude of the readout pulse.",
initial_value=0.5,
unit="V",
parameter_class=ManualParameter,
vals=validators.Numbers(min_value=-10, max_value=10),
)
self.add_parameter(
"ro_pulse_duration",
docstring="Duration of the readout pulse.",
initial_value=300e-9,
unit="s",
parameter_class=ManualParameter,
vals=validators.Numbers(min_value=0, max_value=1),
)
pulse_types = validators.Enum("SquarePulse")
self.add_parameter(
"ro_pulse_type",
docstring=(
"Envelope function that defines the shape of "
"the readout pulse prior to modulation."
),
initial_value="SquarePulse",
parameter_class=ManualParameter,
vals=pulse_types,
)
self.add_parameter(
"ro_pulse_delay",
docstring="Delay before the execution of the readout pulse.",
label="Readout pulse delay",
initial_value=300e-9,
unit="s",
parameter_class=ManualParameter,
vals=validators.Numbers(min_value=-1, max_value=1),
)
self.add_parameter(
"ro_acq_channel",
docstring="Channel corresponding to this qubit.",
initial_value=0,
unit="#",
parameter_class=ManualParameter,
vals=validators.Ints(min_value=0),
)
self.add_parameter(
"ro_acq_delay",
docstring="Delay between the readout pulse and acquisition.",
initial_value=0,
unit="s",
parameter_class=ManualParameter,
vals=validators.Numbers(min_value=-1, max_value=1),
)
self.add_parameter(
"ro_acq_integration_time",
docstring="Integration time for the readout acquisition.",
initial_value=1e-6,
unit="s",
parameter_class=ManualParameter,
vals=validators.Numbers(min_value=0, max_value=1),
)
self.add_parameter(
"spec_pulse_duration",
docstring="Duration of the qubit spectroscopy pulse.",
initial_value=8e-6,
unit="s",
parameter_class=ManualParameter,
vals=validators.Numbers(min_value=0, max_value=1),
)
self.add_parameter(
"spec_pulse_frequency",
docstring="Frequency of the qubit spectroscopy pulse.",
initial_value=float("nan"),
unit="Hz",
parameter_class=ManualParameter,
vals=Numbers(min_value=0, max_value=1e12, allow_nan=True),
)
self.add_parameter(
"spec_pulse_amp",
docstring="Amplitude of the qubit spectroscopy pulse.",
initial_value=0.5,
unit="V",
parameter_class=ManualParameter,
vals=validators.Numbers(min_value=0, max_value=1e12),
)
self.add_parameter(
"spec_pulse_clock",
initial_cache_value=f"{self.name}.01",
parameter_class=Parameter,
set_cmd=False,
)
acquisition_validator = validators.Enum("SSBIntegrationComplex", "Trace")
self.add_parameter(
"acquisition",
docstring=(
"Acquisition mode. Can take either the 'Trace' value, which "
"yields a time trace of the data, or 'SSBIntegrationComplex', "
"which yields integrated single-sideband demodulated "
"data."
),
initial_value="SSBIntegrationComplex",
parameter_class=ManualParameter,
vals=acquisition_validator,
)
ro_acq_weight_type_validator = validators.Enum("SSB")
self.add_parameter(
"ro_acq_weight_type",
initial_value="SSB",
parameter_class=ManualParameter,
vals=ro_acq_weight_type_validator,
)
[docs] def generate_config(self) -> Dict[str, Dict[str, OperationCompilationConfig]]:
"""
Generates part of the device configuration specific to a single qubit.
This method is intended to be used when this object is part of a
device object containing multiple elements.
"""
qubit_config = {
f"{self.name}": {
"reset": OperationCompilationConfig(
factory_func=pulse_library.IdlePulse,
factory_kwargs={
"duration": self.init_duration(),
},
),
# example of a pulse with a parametrized mapping, using a factory
"Rxy": OperationCompilationConfig(
factory_func=pulse_factories.rxy_drag_pulse,
factory_kwargs={
"amp180": self.mw_amp180(),
"motzoi": self.mw_motzoi(),
"port": self.mw_port(),
"clock": self.mw_01_clock(),
"duration": self.mw_pulse_duration(),
},
gate_info_factory_kwargs=[
"theta",
"phi",
], # the keys from the gate info to pass to the factory function
),
# the measurement also has a parametrized mapping, and uses a
# factory function.
"measure": OperationCompilationConfig(
factory_func=measurement_factories.dispersive_measurement,
factory_kwargs={
"port": self.ro_port(),
"clock": self.ro_clock(),
"pulse_type": self.ro_pulse_type(),
"pulse_amp": self.ro_pulse_amp(),
"pulse_duration": self.ro_pulse_duration(),
"acq_delay": self.ro_acq_delay(),
"acq_duration": self.ro_acq_integration_time(),
"acq_channel": self.ro_acq_channel(),
"acq_protocol_default": "SSBIntegrationComplex",
},
gate_info_factory_kwargs=["acq_index", "bin_mode", "acq_protocol"],
),
}
}
return qubit_config
[docs] def generate_device_config(self) -> DeviceCompilationConfig:
"""
Generates a valid device config for the quantify-scheduler making use of the
:func:`~.circuit_to_device.compile_circuit_to_device` function.
This enables the settings of this qubit to be used in isolation.
.. note:
This config is only valid for single qubit experiments.
"""
cfg_dict = {
"backend": "quantify_scheduler.backends"
".circuit_to_device.compile_circuit_to_device",
"elements": self.generate_config(),
"clocks": {
self.mw_01_clock(): self.freq_01(),
self.mw_12_clock(): self.freq_12(),
self.ro_clock(): self.ro_freq(),
},
"edges": {},
}
dev_cfg = DeviceCompilationConfig.parse_obj(cfg_dict)
return dev_cfg