boulder-opal-scale-up-sdk 1.0.4__py3-none-any.whl → 1.0.6__py3-none-any.whl

boulderopalscaleupsdk/experiments/readout_optimization.py

@@ -0,0 +1,57 @@
+# 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 (
+    CWSIterable,
+    Experiment,
+    HypIterable,
+    LinspaceIterable,
+    RangeIterable,
+)
+
+
+class ReadoutOptimization(Experiment):
+    """
+    Parameters for optimizing the readout classifier.
+
+    Parameters
+    ----------
+    transmon : str
+        The reference for the transmon to target.
+    frequencies : list[int] or LinspaceIterable or RangeIterable or CWSIterable or HypIterable
+        The readout frequencies to sweep, in Hz.
+    amplitudes : list[float]
+        The readout amplitudes to sweep.
+    recycle_delay_ns : int
+        The delay between consecutive shots, in nanoseconds. Defaults to 200,000 ns.
+    shot_count : int, optional
+        The number of shots to take. Defaults to 5,000.
+    run_mixer_calibration: bool
+        Whether to run mixer calibrations before running a program. Defaults to False.
+    update : "auto" or "off", optional
+        How the device should be updated after an experiment run. Defaults to auto.
+    """
+
+    _experiment_name: str = PrivateAttr("readout_optimization")
+
+    transmon: str
+    frequencies: list[int] | LinspaceIterable | RangeIterable | CWSIterable | HypIterable
+    amplitudes: list[float]
+    recycle_delay_ns: int = 200_000
+    shot_count: int = 5000
+    run_mixer_calibration: bool = False
+    update: Literal["auto", "off"] = "auto"

boulderopalscaleupsdk/experiments/resonator_spectroscopy.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 (
@@ -22,19 +24,16 @@ from .common import (
 )
 from .waveforms import ConstantWaveform
 
-DEFAULT_RECYCLE_DELAY_NS = 1000  # ns
-DEFAULT_SHOT_COUNT = 100
-
 
 class ResonatorSpectroscopy(Experiment):
     """
     Parameters for running a resonator spectroscopy experiment.
 
-    Parameters
+    Attributes
     ----------
     resonator : str
         The reference for the resonator to target.
-    frequencies : list[int] or LinspaceIterable or RangeIterable or CWSIterable
+    frequencies : list[int] or LinspaceIterable or RangeIterable or CWSIterable \
                   or HypIterable or None, optional
         The frequencies at which to scan, in Hz.
         Defaults to a scan around the readout frequency.
@@ -47,6 +46,8 @@ class ResonatorSpectroscopy(Experiment):
         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")
@@ -55,7 +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,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 (
@@ -22,32 +24,28 @@ from .common import (
 )
 from .waveforms import ConstantWaveform
 
-DEFAULT_SHOT_COUNT = 100
-DEFAULT_RECYCLE_DELAY_NS = 10_000
-DEFAULT_BIASES = LinspaceIterable(start=-0.49, stop=0.49, count=21)
-
 
 class ResonatorSpectroscopyByBias(Experiment):
     """
     Parameters for running a resonator spectroscopy by power experiment.
 
-    Parameters
+    Attributes
     ----------
     resonator : str
         The reference for the resonator to target.
     bias_transmons : list[str] or None, optional
         The references for the transmons to bias.
         Defaults to transmon coupled to the resonator.
-    frequencies : list[int] or LinspaceIterable or RangeIterable or CWSIterable
+    frequencies : list[int] or LinspaceIterable or RangeIterable or CWSIterable \
                   or HypIterable or None, optional
         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
+    biases : list[int] or LinspaceIterable or RangeIterable or CWSIterable \
              or HypIterable, optional
         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 between consecutive shots, in nanoseconds. Defaults to 10,000 ns.
+        The delay between consecutive shots, in nanoseconds. Defaults to 1,000 ns.
     shot_count : int, optional
         The number of shots to take. Defaults to 100.
     measure_waveform : ConstantWaveform or None, optional
@@ -55,6 +53,8 @@ class ResonatorSpectroscopyByBias(Experiment):
         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")
@@ -65,9 +65,10 @@ class ResonatorSpectroscopyByBias(Experiment):
         None
     )
     biases: list[float] | LinspaceIterable | RangeIterable | CWSIterable | HypIterable = (
-        DEFAULT_BIASES
+        LinspaceIterable(start=-0.49, stop=0.49, count=21)
     )
-    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,20 +23,16 @@ 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.
-    frequencies : list[int] or LinspaceIterable or RangeIterable or CWSIterable
+    frequencies : list[int] or LinspaceIterable or RangeIterable or CWSIterable \
                   or HypIterable or None, optional
         The frequencies at which to scan, in Hz.
         Defaults to a scan around the readout frequency.
@@ -49,6 +47,8 @@ class ResonatorSpectroscopyByPower(Experiment):
         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 +58,8 @@ class ResonatorSpectroscopyByPower(Experiment):
         None
     )
     powers_dbm: list[float] | None = None
-    duration_ns: int = DEFAULT_DURATION_NS
-    recycle_delay_ns: int = DEFAULT_RECYCLE_DELAY_NS
-    shot_count: int = DEFAULT_SHOT_COUNT
+    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,19 +11,18 @@
 # 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
-
 
 class T1(Experiment):
     """
     Parameters for running a T1 experiment.
 
-    Parameters
+    Attributes
     ----------
     transmon : str
         The reference for the transmon to target.
@@ -35,12 +34,15 @@ class T1(Experiment):
         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
-    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,17 +11,16 @@
 # 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
     ----------
@@ -29,21 +28,24 @@ class T2(Experiment):
         The reference for the transmon to target.
     delays_ns : list[int] or RangeIterable
         The delay times, in nanoseconds.
-    virtual_detuning : float
-        The virtual detuning added between SX pulses, in Hz.
+    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 100,000 ns.
+        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")
 
     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

@@ -11,39 +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 T2Echo(Experiment):
     """
     Parameters for running a T2 echo experiment.
 
-    Parameters
+    Attributes
     ----------
     transmon : str
         The reference for the transmon to target.
     delays_ns : list[int] or RangeIterable
         The delay times, in nanoseconds.
-    virtual_detuning : float
-        The virtual detuning added between SX pulses, in Hz.
+    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 100,000 ns.
+        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
-    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/transmon_anharmonicity.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 (
@@ -22,20 +24,16 @@ from .common import (
 )
 from .waveforms import ConstantWaveform
 
-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 reference for the transmon to target.
-    frequencies : list[int] or LinspaceIterable or RangeIterable or CWSIterable
+    frequencies : list[int] or LinspaceIterable or RangeIterable or CWSIterable \
                   or HypIterable or None, optional
         The frequencies at which to scan, in Hz.
         Defaults to a scan based on the transmon's frequency and anharmonicity.
@@ -43,9 +41,9 @@ class TransmonAnharmonicity(Experiment):
         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 between consecutive shots, in nanoseconds. Defaults to 1,000 ns.
+        The delay between consecutive shots, in nanoseconds. Defaults to 10,000 ns.
     shot_count : int, optional
-        The number of shots to take. 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.
         Defaults to a constant waveform with a duration of 2,000 ns
@@ -55,6 +53,8 @@ class TransmonAnharmonicity(Experiment):
         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")
@@ -63,9 +63,10 @@ class TransmonAnharmonicity(Experiment):
     frequencies: list[int] | LinspaceIterable | RangeIterable | CWSIterable | HypIterable | None = (
         None
     )
-    anharmonicity: 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,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 (
@@ -22,24 +24,21 @@ from .common import (
 )
 from .waveforms import ConstantWaveform
 
-DEFAULT_RECYCLE_DELAY_NS = 1000  # ns
-DEFAULT_SHOT_COUNT = 100
-
 
 class TransmonSpectroscopy(Experiment):
     """
     Parameters for running a transmon spectroscopy experiment.
 
-    Parameters
+    Attributes
     ----------
     transmon : str
         The reference for the transmon to target.
-    frequencies : list[int] or LinspaceIterable or RangeIterable or CWSIterable
+    frequencies : list[int] or LinspaceIterable or RangeIterable or CWSIterable \
                   or HypIterable or None, optional
         The frequencies at which to scan, in Hz.
         Default to a scan around the transmon frequency.
     recycle_delay_ns : int, optional
-        The delay between consecutive shots, in nanoseconds. Defaults to 1,000 ns.
+        The delay between consecutive shots, in nanoseconds. Defaults to 50,000 ns.
     shot_count : int, optional
         The number of shots to take. Defaults to 100.
     spectroscopy_waveform : ConstantWaveform
@@ -49,6 +48,8 @@ class TransmonSpectroscopy(Experiment):
         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")
@@ -57,8 +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"

boulderopalscaleupsdk/experiments/voltage_bias_fine_tune.py

@@ -0,0 +1,58 @@
+# 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 VoltageBiasFineTune(Experiment):
+    """
+    Parameters for running voltage bias fine-tune experiment.
+
+    Attributes
+    ----------
+    transmon : str
+        The reference for the transmon to XY drive in the experiment.
+    delays_ns : list[int] or RangeIterable
+        The delay times, in nanoseconds.
+    flux_count : int
+        Number of flux bias points to sample around the current bias offset.
+    flux_delta : float
+        Flux difference between flux points, in units of the voltage period.
+    virtual_detuning : float
+        The difference between the drive signal frequency and the qubit frequency, in Hz.
+    bias_transmon : str or None, optional
+        The reference for the transmon to flux tune in the experiment.
+        Defaults to transmon.
+    recycle_delay_ns : int, optional
+        The delay time between consecutive shots of the experiment, in nanoseconds.
+        Defaults to 100_000 ns.
+    shot_count : int, optional
+        The number of shots to be taken in the experiment.
+        Defaults to 400.
+    """
+
+    _experiment_name: str = PrivateAttr("voltage_bias_fine_tune")
+
+    transmon: str
+    delays_ns: list[int] | RangeIterable
+    flux_count: int
+    flux_delta: float
+    virtual_detuning: float
+    bias_transmon: str | None = None
+    recycle_delay_ns: int = 100_000
+    shot_count: int = 400
+    update: Literal["auto", "off", "prompt"] = "auto"

boulderopalscaleupsdk/experiments/zz_ramsey.py

@@ -0,0 +1,59 @@
+# 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
+
+
+class ZZRamsey(Experiment):
+    """
+    Parameters for running a ZZ Ramsey experiment.
+
+    Attributes
+    ----------
+    control_transmon : str
+        The control transmon to target in the experiment.
+    target_transmon : str
+        The target transmon to pair with the control transmon.
+    max_delay_ns : int
+        The maximum delay time, in nanoseconds.
+    min_delay_ns : int
+        The minimum delay time, in nanoseconds.
+    delay_step_ns : int
+        The step for generating the list of delays, in nanoseconds.
+    virtual_detuning : float
+        The difference between the drive signal frequency and the qubit frequency, in Hz.
+    recycle_delay_ns : int, optional
+        The delay time between consecutive shots of the experiment, in nanoseconds.
+        Defaults to 10,000 ns.
+    shot_count : int, optional
+        The number of shots to be taken in the experiment.
+        Defaults to 400.
+    update : "auto" or "off" or "prompt", optional
+        How the device should be updated after an experiment run. Defaults to auto.
+    """
+
+    _experiment_name: str = PrivateAttr("zz_ramsey")
+
+    control_transmon: str
+    target_transmon: str
+    max_delay_ns: int
+    min_delay_ns: int
+    delay_step_ns: int
+    virtual_detuning: float
+    recycle_delay_ns: int = 10_000
+    shot_count: int = 400
+    update: Literal["auto", "off", "prompt"] = "auto"