boulder-opal-scale-up-sdk 1.0.3__py3-none-any.whl → 1.0.5__py3-none-any.whl

boulderopalscaleupsdk/experiments/readout_classifier_calibration.py

@@ -1,28 +1,50 @@
+# Copyright 2025 Q-CTRL. All rights reserved.
+#
+# Licensed under the Q-CTRL Terms of service (the "License"). Unauthorized
+# copying or use of this file, via any medium, is strictly prohibited.
+# Proprietary and confidential. You may not use this file except in compliance
+# with the License. You may obtain a copy of the License at
+#
+#    https://q-ctrl.com/terms
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS. See the
+# License for the specific language.
+
+from typing import Literal
+
 from pydantic import PrivateAttr
 
-from .common import ConstantWaveform, Experiment
+from .common import Experiment
+from .waveforms import ConstantWaveform
 
 
 class ReadoutClassifierCalibration(Experiment):
     """
     Parameters for running calibration of readout classifier for a transmon.
 
-    Parameters
+    Attributes
     ----------
     transmon : str
-        The reference for the transmon to target in the experiment.
+        The reference for the transmon to target.
     recycle_delay_ns : int
-        The delay time between consecutive shots of the experiment, in nanoseconds.
+        The delay between consecutive shots, in nanoseconds. Defaults to 200,000 ns.
     shot_count : int, optional
-        The number of shots to be taken in the experiment.
-        Defaults to 5000.
+        The number of shots to take. Defaults to 5,000.
     measure_waveform : ConstantWaveform or None, optional
         The waveform to use for the measurement pulse.
-        If not provided, the measurement defcal will be used.
+        Defaults to the measurement defcal.
+    run_mixer_calibration: bool
+        Whether to run mixer calibrations before running a program. Defaults to False.
+    update : "auto" or "off" or "prompt", optional
+        How the device should be updated after an experiment run. Defaults to auto.
     """
 
     _experiment_name: str = PrivateAttr("readout_classifier_calibration")
+
     transmon: str
-    recycle_delay_ns: int
+    recycle_delay_ns: int = 200_000
     shot_count: int = 5000
     measure_waveform: ConstantWaveform | None = None
+    run_mixer_calibration: bool = False
+    update: Literal["auto", "off", "prompt"] = "auto"

boulderopalscaleupsdk/experiments/resonator_spectroscopy.py

@@ -11,43 +11,43 @@
 # distributed under the License is distributed on an "AS IS" BASIS. See the
 # License for the specific language.
 
+from typing import Literal
+
 from pydantic import PrivateAttr
 
 from .common import (
-    ConstantWaveform,
     CWSIterable,
     Experiment,
     HypIterable,
     LinspaceIterable,
     RangeIterable,
 )
-
-DEFAULT_DURATION_NS = 2000  # ns
-DEFAULT_RECYCLE_DELAY_NS = 1000  # ns
-DEFAULT_SHOT_COUNT = 100
+from .waveforms import ConstantWaveform
 
 
 class ResonatorSpectroscopy(Experiment):
     """
     Parameters for running a resonator spectroscopy experiment.
 
-    Parameters
+    Attributes
     ----------
     resonator : str
-        The reference for the resonator to target in the experiment.
-    frequencies : list[int] or LinspaceIterable or RangeIterable or CWSIterable
+        The reference for the resonator to target.
+    frequencies : list[int] or LinspaceIterable or RangeIterable or CWSIterable \
                   or HypIterable or None, optional
-        The frequencies at which to scan.
-        If None, frequencies around the readout frequency will be used.
-    recycle_delay_ns :int, optional
-        The delay time between consecutive shots of the experiment, in nanoseconds.
-        Defaults to 1000 ns.
+        The frequencies at which to scan, in Hz.
+        Defaults to a scan around the readout frequency.
+    recycle_delay_ns : int, optional
+        The delay between consecutive shots, in nanoseconds. Defaults to 1,000 ns.
     shot_count : int, optional
-        The number of shots to be taken in the experiment.
-        Defaults to 100.
+        The number of shots to take. Defaults to 100.
     measure_waveform : ConstantWaveform or None, optional
         The waveform to use for the measurement pulse.
-        If not provided, the measurement defcal will be used.
+        Defaults to the measurement defcal.
+    run_mixer_calibration: bool
+        Whether to run mixer calibrations before running a program. Defaults to False.
+    update : "auto" or "off" or "prompt", optional
+        How the device should be updated after an experiment run. Defaults to auto.
     """
 
     _experiment_name: str = PrivateAttr("resonator_spectroscopy")
@@ -56,6 +56,8 @@ class ResonatorSpectroscopy(Experiment):
     frequencies: list[int] | LinspaceIterable | RangeIterable | CWSIterable | HypIterable | None = (
         None
     )
-    recycle_delay_ns: int = DEFAULT_RECYCLE_DELAY_NS
-    shot_count: int = DEFAULT_SHOT_COUNT
+    recycle_delay_ns: int = 1_000
+    shot_count: int = 100
     measure_waveform: ConstantWaveform | None = None
+    run_mixer_calibration: bool = False
+    update: Literal["auto", "off", "prompt"] = "auto"

boulderopalscaleupsdk/experiments/resonator_spectroscopy_by_bias.py

@@ -11,20 +11,19 @@
 # distributed under the License is distributed on an "AS IS" BASIS. See the
 # License for the specific language.
 
+from typing import Literal
+
 from pydantic import PrivateAttr
 
 from .common import (
-    ConstantWaveform,
     CWSIterable,
     Experiment,
     HypIterable,
     LinspaceIterable,
     RangeIterable,
 )
+from .waveforms import ConstantWaveform
 
-DEFAULT_DURATION_NS = 2000
-DEFAULT_SHOT_COUNT = 100
-DEFAULT_RECYCLE_DELAY_NS = 10_000
 DEFAULT_BIASES = LinspaceIterable(start=-0.49, stop=0.49, count=21)
 
 
@@ -32,30 +31,32 @@ class ResonatorSpectroscopyByBias(Experiment):
     """
     Parameters for running a resonator spectroscopy by power experiment.
 
-    Parameters
+    Attributes
     ----------
     resonator : str
-        The reference for the resonator to target in the experiment.
+        The reference for the resonator to target.
     bias_transmons : list[str] or None, optional
         The references for the transmons to bias.
-        If None, it defaults to transmon coupled to the resonator.
-    frequencies : list[int] or LinspaceIterable or RangeIterable or CWSIterable
+        Defaults to transmon coupled to the resonator.
+    frequencies : list[int] or LinspaceIterable or RangeIterable or CWSIterable \
                   or HypIterable or None, optional
-        The frequencies at which to scan.
-        If None, frequencies around the readout frequency will be used.
-    biases : list[int] or LinspaceIterable or RangeIterable or CWSIterable
+        The frequencies at which to scan, in Hz.
+        Defaults to a scan around the readout frequency.
+    biases : list[int] or LinspaceIterable or RangeIterable or CWSIterable \
              or HypIterable, optional
-        The biases at which to scan.
-        If None, defaults to 21 points between -0.49 and 0.49.
+        The biases at which to scan, in Volts.
+        Defaults to 21 points between -0.49 and 0.49.
     recycle_delay_ns : int, optional
-        The delay time between consecutive shots of the experiment, in nanoseconds.
-        Defaults to 10000 ns.
+        The delay between consecutive shots, in nanoseconds. Defaults to 1,000 ns.
     shot_count : int, optional
-        The number of shots to be taken in the experiment.
-        Defaults to 100.
+        The number of shots to take. Defaults to 100.
     measure_waveform : ConstantWaveform or None, optional
         The waveform to use for the measurement pulse.
-        If not provided, the measurement defcal will be used.
+        Defaults to the measurement defcal.
+    run_mixer_calibration: bool
+        Whether to run mixer calibrations before running a program. Defaults to False.
+    update : "auto" or "off" or "prompt", optional
+        How the device should be updated after an experiment run. Defaults to auto.
     """
 
     _experiment_name: str = PrivateAttr("resonator_spectroscopy_by_bias")
@@ -68,6 +69,8 @@ class ResonatorSpectroscopyByBias(Experiment):
     biases: list[float] | LinspaceIterable | RangeIterable | CWSIterable | HypIterable = (
         DEFAULT_BIASES
     )
-    recycle_delay_ns: int = DEFAULT_RECYCLE_DELAY_NS
-    shot_count: int = DEFAULT_SHOT_COUNT
+    recycle_delay_ns: int = 1_000
+    shot_count: int = 100
     measure_waveform: ConstantWaveform | None = None
+    run_mixer_calibration: bool = False
+    update: Literal["auto", "off", "prompt"] = "auto"

boulderopalscaleupsdk/experiments/resonator_spectroscopy_by_power.py

@@ -11,6 +11,8 @@
 # distributed under the License is distributed on an "AS IS" BASIS. See the
 # License for the specific language.
 
+from typing import Literal
+
 from pydantic import PrivateAttr
 
 from .common import (
@@ -21,35 +23,32 @@ from .common import (
     RangeIterable,
 )
 
-DEFAULT_DURATION_NS = 2000  # ns
-DEFAULT_RECYCLE_DELAY_NS = 1000  # ns
-DEFAULT_SHOT_COUNT = 100
-
 
 class ResonatorSpectroscopyByPower(Experiment):
     """
     Parameters for running a resonator spectroscopy by power experiment.
 
-    Parameters
+    Attributes
     ----------
     resonator : str
-        The reference for the resonator to target in the experiment.
-    frequencies : list[int] or LinspaceIterable or RangeIterable or CWSIterable
+        The reference for the resonator to target.
+    frequencies : list[int] or LinspaceIterable or RangeIterable or CWSIterable \
                   or HypIterable or None, optional
-        The frequencies at which to scan.
-        If None, frequencies around the readout frequency will be used.
-    powers : list[int] or None, optional
-        The powers at which to scan the readout pulse.
+        The frequencies at which to scan, in Hz.
+        Defaults to a scan around the readout frequency.
+    powers_dbm : list[float] or None, optional
+        The powers at which to scan the readout pulse, in dBm.
         If None, a default power scan will be used.
     duration_ns : int, optional
-        The duration of the readout pulse, in nanoseconds.
-        Defaults to 2000 ns.
+        The duration of the readout pulse, in nanoseconds. Defaults to 2,000 ns.
     recycle_delay_ns : int, optional
-        The delay time between consecutive shots of the experiment, in nanoseconds.
-        Defaults to 1000 ns.
+        The delay between consecutive shots, in nanoseconds. Defaults to 1,000 ns.
     shot_count : int, optional
-        The number of shots to be taken in the experiment.
-        Defaults to 100.
+        The number of shots to take. Defaults to 100.
+    run_mixer_calibration: bool
+        Whether to run mixer calibrations before running a program. Defaults to False.
+    update : "auto" or "off" or "prompt", optional
+        How the device should be updated after an experiment run. Defaults to auto.
     """
 
     _experiment_name: str = PrivateAttr("resonator_spectroscopy_by_power")
@@ -58,7 +57,9 @@ class ResonatorSpectroscopyByPower(Experiment):
     frequencies: list[int] | LinspaceIterable | RangeIterable | CWSIterable | HypIterable | None = (
         None
     )
-    powers: list[float] | None = None
-    duration_ns: int = DEFAULT_DURATION_NS
-    recycle_delay_ns: int = DEFAULT_RECYCLE_DELAY_NS
-    shot_count: int = DEFAULT_SHOT_COUNT
+    powers_dbm: list[float] | None = None
+    duration_ns: int = 2_000
+    recycle_delay_ns: int = 1_000
+    shot_count: int = 100
+    run_mixer_calibration: bool = False
+    update: Literal["auto", "off", "prompt"] = "auto"

boulderopalscaleupsdk/experiments/t1.py

@@ -11,44 +11,38 @@
 # distributed under the License is distributed on an "AS IS" BASIS. See the
 # License for the specific language.
 
+from typing import Literal
+
 from pydantic import PrivateAttr
 
 from .common import Experiment, LogspaceIterable
 
-DEFAULT_RECYCLE_DELAY_NS = 200_000
-DEFAULT_SHOT_COUNT = 400
-DEFAULT_DURATION_NS = 2_000
-
 
 class T1(Experiment):
     """
     Parameters for running a T1 experiment.
 
-    Parameters
+    Attributes
     ----------
     transmon : str
-        The transmon to target in the experiment.
-    delays_ns : list[int] | RangeIterable
-        The delay time, in nanoseconds.
-    readout_amplitude : float, optional
-        The amplitude of the readout pulse.
-        If None, a default amplitude will be used.
-    duration_ns : int, optional
-        The duration of the readout pulse, in nanoseconds.
-        Defaults to 2000 ns.
+        The reference for the transmon to target.
+    delays_ns : LogspaceIterable
+        The delay times, in nanoseconds.
     recycle_delay_ns : int, optional
-        The delay time between consecutive shots of the experiment, in nanoseconds.
-        Defaults to 200_000 ns.
+        The delay between consecutive shots, in nanoseconds. Defaults to 200,000 ns.
     shot_count : int, optional
-        The number of shots to be taken in the experiment.
-        Defaults to 400.
+        The number of shots to take. Defaults to 400.
+    run_mixer_calibration: bool
+        Whether to run mixer calibrations before running a program. Defaults to False.
+    update : "auto" or "off" or "prompt", optional
+        How the device should be updated after an experiment run. Defaults to auto.
     """
 
     _experiment_name: str = PrivateAttr("t1")
 
     transmon: str
     delays_ns: LogspaceIterable
-    readout_amplitude: float
-    duration_ns: int = DEFAULT_DURATION_NS
-    recycle_delay_ns: int = DEFAULT_RECYCLE_DELAY_NS
-    shot_count: int = DEFAULT_SHOT_COUNT
+    recycle_delay_ns: int = 200_000
+    shot_count: int = 400
+    run_mixer_calibration: bool = False
+    update: Literal["auto", "off", "prompt"] = "auto"

boulderopalscaleupsdk/experiments/t2.py

@@ -11,38 +11,41 @@
 # distributed under the License is distributed on an "AS IS" BASIS. See the
 # License for the specific language.
 
+from typing import Literal
+
 from pydantic import PrivateAttr
 
 from .common import Experiment, RangeIterable
 
-DEFAULT_RECYCLE_DELAY_NS = 100_000
-DEFAULT_SHOT_COUNT = 400
-
 
 class T2(Experiment):
     """
-    Parameters for running a Ramsey experiment.
+    Parameters for running a T2 experiment.
 
     Parameters
     ----------
     transmon : str
-        The reference for the transmon to target in the experiment.
-    delays_ns : list[int] | RangeIterable
-        The delay time, in nanoseconds.
-    virtual_detuning : float
-        The difference between the drive signal frequency and the qubit frequency, in Hz.
+        The reference for the transmon to target.
+    delays_ns : list[int] or RangeIterable
+        The delay times, in nanoseconds.
+    oscillation_count : int, optional
+        The target number of oscillations to expect. Defaults to 10.
     recycle_delay_ns : int, optional
-        The delay time between consecutive shots of the experiment, in nanoseconds.
-        Defaults to 100_000 ns.
+        The delay between consecutive shots, in nanoseconds. Defaults to 200,000 ns.
     shot_count : int, optional
-        The number of shots to be taken in the experiment.
-        Defaults to 400.
+        The number of shots to take. Defaults to 400.
+    run_mixer_calibration: bool
+        Whether to run mixer calibrations before running a program. Defaults to False.
+    update : "auto" or "off" or "prompt", optional
+        How the device should be updated after an experiment run. Defaults to auto.
     """
 
     _experiment_name: str = PrivateAttr("t2")
 
     transmon: str
     delays_ns: list[int] | RangeIterable
-    virtual_detuning: float
-    recycle_delay_ns: int = DEFAULT_RECYCLE_DELAY_NS
-    shot_count: int = DEFAULT_SHOT_COUNT
+    oscillation_count: int = 10
+    recycle_delay_ns: int = 200_000
+    shot_count: int = 400
+    run_mixer_calibration: bool = False
+    update: Literal["auto", "off", "prompt"] = "auto"

boulderopalscaleupsdk/experiments/t2_echo.py

@@ -0,0 +1,51 @@
+# Copyright 2025 Q-CTRL. All rights reserved.
+#
+# Licensed under the Q-CTRL Terms of service (the "License"). Unauthorized
+# copying or use of this file, via any medium, is strictly prohibited.
+# Proprietary and confidential. You may not use this file except in compliance
+# with the License. You may obtain a copy of the License at
+#
+#    https://q-ctrl.com/terms
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS. See the
+# License for the specific language.
+
+from typing import Literal
+
+from pydantic import PrivateAttr
+
+from .common import Experiment, RangeIterable
+
+
+class T2Echo(Experiment):
+    """
+    Parameters for running a T2 echo experiment.
+
+    Attributes
+    ----------
+    transmon : str
+        The reference for the transmon to target.
+    delays_ns : list[int] or RangeIterable
+        The delay times, in nanoseconds.
+    oscillation_count : int, optional
+        The target number of oscillations to expect. Defaults to 10.
+    recycle_delay_ns : int, optional
+        The delay between consecutive shots, in nanoseconds. Defaults to 200,000 ns.
+    shot_count : int, optional
+        The number of shots to take. Defaults to 400.
+    run_mixer_calibration: bool
+        Whether to run mixer calibrations before running a program. Defaults to False.
+    update : "auto" or "off" or "prompt", optional
+        How the device should be updated after an experiment run. Defaults to auto.
+    """
+
+    _experiment_name: str = PrivateAttr("t2_echo")
+
+    transmon: str
+    delays_ns: list[int] | RangeIterable
+    oscillation_count: int = 10
+    recycle_delay_ns: int = 200_000
+    shot_count: int = 400
+    run_mixer_calibration: bool = False
+    update: Literal["auto", "off", "prompt"] = "auto"

boulderopalscaleupsdk/experiments/transmon_anharmonicity.py

@@ -11,52 +11,52 @@
 # distributed under the License is distributed on an "AS IS" BASIS. See the
 # License for the specific language.
 
+from typing import Literal
+
 from pydantic import PrivateAttr
 
 from .common import (
-    ConstantWaveform,
     CWSIterable,
     Experiment,
     HypIterable,
     LinspaceIterable,
     RangeIterable,
 )
+from .waveforms import ConstantWaveform
 
-DEFAULT_DURATION_NS = 2_000  # ns
 DEFAULT_RECYCLE_DELAY_NS = 1_000  # ns
-DEFAULT_SHOT_COUNT = 100
-DEFAULT_ANHARMONICITY_GUESS = -200e6  # Hz, typical anharmonicity for transmons
 
 
 class TransmonAnharmonicity(Experiment):
     """
-    Parameters for running a Qubit Anharmonicity experiment.
+    Parameters for running a transmon anharmonicity experiment.
 
-    Parameters
+    Attributes
     ----------
     transmon : str
-        The transmon that is the target of the experiment.
-    frequencies : list[int] or LinspaceIterable or RangeIterable or CWSIterable
+        The reference for the transmon to target.
+    frequencies : list[int] or LinspaceIterable or RangeIterable or CWSIterable \
                   or HypIterable or None, optional
-        The drive frequencies to be scanned in the experiment.
-        If None, a default scan will be used based on the transmon's frequency
-        and anharmonicity.
-    anharmonicity_guess_hz : float
-        The guessed anharmonicity of the qubit, in Hz. This is used to determine the
-        range of frequencies to scan if `frequencies` is not provided.
-        Defaults to -200 MHz.
+        The frequencies at which to scan, in Hz.
+        Defaults to a scan based on the transmon's frequency and anharmonicity.
+    anharmonicity : float, optional
+        The guessed anharmonicity of the transmon, in Hz.
+        Used to determine the scan frequencies if not provided. Defaults to -200 MHz.
     recycle_delay_ns : int, optional
-        The delay time between consecutive shots of the experiment, in nanoseconds.
-        Defaults to 1000 ns.
+        The delay between consecutive shots, in nanoseconds. Defaults to 10,000 ns.
     shot_count : int, optional
-        The number of shots to be taken in the experiment. Defaults to 100.
+        The number of shots to take. Defaults to 400.
     spectroscopy_waveform : ConstantWaveform or None, optional
         The waveform to use in the spectroscopy pulse.
-        If not provided, a waveform with a duration of 2000 ns
-        and an amplitude of 1.5 times the transmon's x_vp will be used.
+        Defaults to a constant waveform with a duration of 2,000 ns
+        and an amplitude of 1.5 times the transmon's x_vp.
     measure_waveform : ConstantWaveform or None, optional
         The waveform to use for the measurement pulse.
-        If not provided, the measurement defcal will be used.
+        Defaults to the measurement defcal.
+    run_mixer_calibration: bool
+        Whether to run mixer calibrations before running a program. Defaults to False.
+    update : "auto" or "off" or "prompt", optional
+        How the device should be updated after an experiment run. Defaults to auto.
     """
 
     _experiment_name: str = PrivateAttr("transmon_anharmonicity")
@@ -65,8 +65,10 @@ class TransmonAnharmonicity(Experiment):
     frequencies: list[int] | LinspaceIterable | RangeIterable | CWSIterable | HypIterable | None = (
         None
     )
-    anharmonicity_guess_hz: float = DEFAULT_ANHARMONICITY_GUESS
-    recycle_delay_ns: int = DEFAULT_RECYCLE_DELAY_NS
-    shot_count: int = DEFAULT_SHOT_COUNT
+    anharmonicity: float = -200e6
+    recycle_delay_ns: int = 10_000
+    shot_count: int = 400
     spectroscopy_waveform: ConstantWaveform | None = None
     measure_waveform: ConstantWaveform | None = None
+    run_mixer_calibration: bool = False
+    update: Literal["auto", "off", "prompt"] = "auto"

boulderopalscaleupsdk/experiments/transmon_spectroscopy.py

@@ -11,45 +11,45 @@
 # distributed under the License is distributed on an "AS IS" BASIS. See the
 # License for the specific language.
 
+from typing import Literal
+
 from pydantic import PrivateAttr
 
 from .common import (
-    ConstantWaveform,
     CWSIterable,
     Experiment,
     HypIterable,
     LinspaceIterable,
     RangeIterable,
 )
-
-DEFAULT_DURATION_NS = 2000  # ns
-DEFAULT_RECYCLE_DELAY_NS = 1000  # ns
-DEFAULT_SHOT_COUNT = 100
+from .waveforms import ConstantWaveform
 
 
 class TransmonSpectroscopy(Experiment):
     """
     Parameters for running a transmon spectroscopy experiment.
 
-    Parameters
+    Attributes
     ----------
     transmon : str
-        The reference for the transmon to target in the experiment.
-    frequencies : list[int] or LinspaceIterable or RangeIterable or CWSIterable
+        The reference for the transmon to target.
+    frequencies : list[int] or LinspaceIterable or RangeIterable or CWSIterable \
                   or HypIterable or None, optional
-        The frequencies at which to scan.
-        If None, frequencies around the readout frequency will be used.
+        The frequencies at which to scan, in Hz.
+        Default to a scan around the transmon frequency.
     recycle_delay_ns : int, optional
-        The delay time between consecutive shots of the experiment, in nanoseconds.
-        Defaults to 1000 ns.
+        The delay between consecutive shots, in nanoseconds. Defaults to 50,000 ns.
     shot_count : int, optional
-        The number of shots to be taken in the experiment.
-        Defaults to 100.
+        The number of shots to take. Defaults to 100.
     spectroscopy_waveform : ConstantWaveform
         The waveform to use in the spectroscopy pulse.
     measure_waveform : ConstantWaveform or None, optional
         The waveform to use for the measurement pulse.
-        If not provided, the measurement defcal will be used.
+        Defaults to the measurement defcal.
+    run_mixer_calibration: bool
+        Whether to run mixer calibrations before running a program. Defaults to False.
+    update : "auto" or "off" or "prompt", optional
+        How the device should be updated after an experiment run. Defaults to auto.
     """
 
     _experiment_name: str = PrivateAttr("transmon_spectroscopy")
@@ -58,7 +58,9 @@ class TransmonSpectroscopy(Experiment):
     frequencies: list[int] | LinspaceIterable | RangeIterable | CWSIterable | HypIterable | None = (
         None
     )
-    recycle_delay_ns: int = DEFAULT_RECYCLE_DELAY_NS
-    shot_count: int = DEFAULT_SHOT_COUNT
+    recycle_delay_ns: int = 50_000
+    shot_count: int = 400
     spectroscopy_waveform: ConstantWaveform
     measure_waveform: ConstantWaveform | None = None
+    run_mixer_calibration: bool = False
+    update: Literal["auto", "off", "prompt"] = "auto"