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

boulderopalscaleupsdk/device/processor/superconducting_processor.py

@@ -161,7 +161,27 @@ class Feedline(Component[Literal["feedline"]]):
     traits: list = Field(default=[])
 
 
-SuperconductingComponentType = Transmon | Resonator | Port | Feedline | Filter | Coupler
+class TWPA(Component[Literal["twpa"]]):
+    dtype: Literal["twpa"] = "twpa"
+    traits: list = Field(default=[])
+
+    impedance: FloatComponentParameter = Field(
+        default=ComponentParameter(value=0.0),
+        json_schema_extra={"display": {"label": "impedance", "unit": "Ohm", "scale": 1}},
+    )
+
+    # Tunable TWPA parameters
+    pump_power: FloatComponentParameter = Field(
+        default=ComponentParameter(value=0.0),
+        json_schema_extra={"display": {"label": "pump_power", "unit": "dBm", "scale": 1}},
+    )
+    pump_freq: FloatComponentParameter = Field(
+        default=ComponentParameter(value=(0.0)),
+        json_schema_extra={"display": {"label": "pump_freq", "unit": "MHz", "scale": 1e-6}},
+    )
+
+
+SuperconductingComponentType = Transmon | Resonator | Port | Feedline | Filter | Coupler | TWPA
 
 
 class Edge(BaseModel):
@@ -176,14 +196,14 @@ class TemplateParam(BaseModel):
 
 
 class ProcessorTemplate(BaseModel):
-    elements: dict[str, Transmon | Resonator | Port | Feedline | Filter | Coupler]
+    elements: dict[str, SuperconductingComponentType]
     edges: list[Edge]
 
 
 class SuperconductingProcessorTemplate(BaseModel):
     build: list[TemplateParam]
     templates: dict[str, ProcessorTemplate]
-    device_parameters: dict[str, Transmon | Resonator | Port | Feedline | Filter | Coupler] = Field(
+    device_parameters: dict[str, SuperconductingComponentType] = Field(
         default={},
     )
 

boulderopalscaleupsdk/errors.py

@@ -0,0 +1,21 @@
+# 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.
+
+
+class ScaleUpServerError(Exception):
+    """
+    Exception raised by client based on server behavior.
+    """
+
+    def __init__(self, message: str):
+        super().__init__(message)

boulderopalscaleupsdk/experiments/__init__.py

@@ -17,10 +17,13 @@ __all__ = [
     "T1",
     "T2",
     "CWSIterable",
+    "CZSpectroscopyByBias",
     "Chi01Scan",
     "ConstantWaveform",
     "DragCosineWaveform",
+    "DragLeakageCalibration",
     "Experiment",
+    "FineAmplitudeCalibration",
     "GaussianWaveform",
     "HypIterable",
     "LinspaceIterable",
@@ -28,15 +31,19 @@ __all__ = [
     "PowerRabi",
     "PowerRabiEF",
     "Ramsey",
+    "RamseyEF",
     "RangeIterable",
-    "ReadoutClassifierCalibration",
+    "ReadoutClassifier",
+    "ReadoutOptimization",
     "ResonatorSpectroscopy",
     "ResonatorSpectroscopyByBias",
     "ResonatorSpectroscopyByPower",
     "T2Echo",
     "TransmonAnharmonicity",
     "TransmonSpectroscopy",
+    "VoltageBiasFineTune",
     "Waveform",
+    "ZZRamsey",
     "update_amplitude",
 ]
 
@@ -49,10 +56,15 @@ from .common import (
     LogspaceIterable,
     RangeIterable,
 )
+from .cz_spectroscopy_by_bias import CZSpectroscopyByBias
+from .drag_leakage_calibration import DragLeakageCalibration
+from .fine_amplitude_calibration import FineAmplitudeCalibration
 from .power_rabi import PowerRabi
 from .power_rabi_ef import PowerRabiEF
 from .ramsey import Ramsey
-from .readout_classifier_calibration import ReadoutClassifierCalibration
+from .ramsey_ef import RamseyEF
+from .readout_classifier import ReadoutClassifier
+from .readout_optimization import ReadoutOptimization
 from .resonator_spectroscopy import ResonatorSpectroscopy
 from .resonator_spectroscopy_by_bias import ResonatorSpectroscopyByBias
 from .resonator_spectroscopy_by_power import ResonatorSpectroscopyByPower
@@ -61,6 +73,7 @@ from .t2 import T2
 from .t2_echo import T2Echo
 from .transmon_anharmonicity import TransmonAnharmonicity
 from .transmon_spectroscopy import TransmonSpectroscopy
+from .voltage_bias_fine_tune import VoltageBiasFineTune
 from .waveforms import (
     ConstantWaveform,
     DragCosineWaveform,
@@ -68,3 +81,4 @@ from .waveforms import (
     Waveform,
     update_amplitude,
 )
+from .zz_ramsey import ZZRamsey

boulderopalscaleupsdk/experiments/chi01_scan.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,9 +24,6 @@ from .common import (
 )
 from .waveforms import ConstantWaveform
 
-DEFAULT_RECYCLE_DELAY_NS = 10_000
-DEFAULT_SHOT_COUNT = 100
-
 
 class Chi01Scan(Experiment):
     """
@@ -35,12 +34,12 @@ class Chi01Scan(Experiment):
     ----------
     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 around the readout frequency.
     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 200,000 ns.
     shot_count : int, optional
         The number of shots to take. Defaults to 100.
     measure_waveform : ConstantWaveform or None, optional
@@ -48,6 +47,8 @@ class Chi01Scan(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("chi01_scan")
@@ -56,7 +57,8 @@ class Chi01Scan(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 = 200_000
+    shot_count: int = 100
     measure_waveform: ConstantWaveform | None = None
     run_mixer_calibration: bool = False
+    update: Literal["auto", "off", "prompt"] = "auto"

boulderopalscaleupsdk/experiments/cz_spectroscopy_by_bias.py

@@ -0,0 +1,84 @@
+# 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
+
+DEFAULT_PREP_PADDING_NS = 16
+DEFAULT_MEASUREMENT_PADDING_NS = 16
+DEFAULT_MIN_DURATION_NS = 16
+DEFAULT_MAX_DURATION_NS = 200
+DEFAULT_TIME_STEP_NS = 8
+DEFAULT_RECYCLE_DELAY_NS = 500_000
+DEFAULT_SHOT_COUNT = 200
+
+
+class CZSpectroscopyByBias(Experiment):
+    """
+    Parameters for running a Ramsey experiment.
+
+    Parameters
+    ----------
+    control_transmon : str
+        The control transmon to target in the experiment.
+    target_transmon : str
+        The target transmon to pair with the control transmon.
+    min_vp : float
+        The minimum voltage point, in volts.
+    max_vp : float
+        The maximum voltage point, in volts.
+    num_vp : int
+        The number of voltage points to sample.
+    min_duration_ns : int
+        The minimum duration for the pulse in the experiment, in nanoseconds.
+    max_duration_ns : int
+        The maximum duration for the pulse in the experiment, in nanoseconds.
+    duration_step_ns : int
+        The step size for the duration, in nanoseconds.
+    prep_padding_ns : int
+        The padding to apply before the CZ pulse, in nanoseconds.
+    measurement_padding_ns : int
+        The padding to apply after the CZ pulse, in nanoseconds.
+    recycle_delay_ns : float
+        The delay time between consecutive shots of the experiment, in nanoseconds.
+        Defaults to 500000 ns.
+    shot_count : int,
+        The number of shots to be taken in the experiment.
+        Defaults to 200.
+    batch_analysis : bool
+        Whether to perform batch analysis on the results.
+    spectroscopy_waveform : ConstantWaveform
+        The waveform to use in the spectroscopy pulse.
+    """
+
+    _experiment_name: str = PrivateAttr("cz_spectroscopy_by_bias")
+
+    control_transmon: str
+    target_transmon: str
+    coupler: str
+    min_vp: float
+    max_vp: float
+    num_vp: int
+    coupler_flux_vp: float
+    min_duration_ns: int = DEFAULT_MIN_DURATION_NS
+    max_duration_ns: int = DEFAULT_MAX_DURATION_NS
+    duration_step_ns: int = DEFAULT_TIME_STEP_NS
+    prep_padding_ns: int = DEFAULT_PREP_PADDING_NS
+    measurement_padding_ns: int = DEFAULT_MEASUREMENT_PADDING_NS
+    recycle_delay_ns: int = DEFAULT_RECYCLE_DELAY_NS
+    shot_count: int = DEFAULT_SHOT_COUNT
+    batch_analysis: bool = False
+    update: Literal["auto", "off", "prompt"] = "auto"

boulderopalscaleupsdk/experiments/drag_leakage_calibration.py

@@ -0,0 +1,66 @@
+# 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, field_validator
+
+from .common import CWSIterable, Experiment
+
+
+class DragLeakageCalibration(Experiment):
+    """
+    Parameters for running a DRAG leakage calibration experiment for
+    a specified gate on a transmon.
+
+    Attributes
+    ----------
+    transmon : str
+        The reference for the transmon to target.
+    recycle_delay_ns : int
+        The delay between consecutive shots, in nanoseconds. Defaults to 10,000 ns.
+    shot_count : int, optional
+        The number of shots to take. Defaults to 1,000.
+    alphas: list[float] or CWSIterable
+        List of values to sweep for DRAG parameter alpha.
+    repetitions : list[int]
+        List of repetition counts for the calibration experiment.
+    gate : "sx" or "x"
+        The gate to calibrate.
+    anharmonicity : float or None, optional
+        The anharmonicity of the transmon, in Hz.
+        Defaults to None, in which case the anharmonicity of the transmon will be used.
+    drag_guess : float
+        Initial guess for the DRAG parameter.
+    update : "auto" or "off" or "prompt", optional
+        How the device should be updated after an experiment run. Defaults to auto.
+    """
+
+    _experiment_name: str = PrivateAttr("drag_leakage_calibration")
+
+    transmon: str
+    recycle_delay_ns: int = 10_000
+    shot_count: int = 1_000
+    alphas: list[float] | CWSIterable
+    repetitions: list[int]
+    gate: Literal["x", "sx"]
+    anharmonicity: float | None = None
+    drag_guess: float
+    update: Literal["auto", "off", "prompt"] = "auto"
+
+    @field_validator("alphas")
+    @classmethod
+    def validate_alphas(cls, value: list[float] | CWSIterable):
+        if isinstance(value, CWSIterable) and value.center is None:
+            raise TypeError("The center of alphas must not be None.")
+        return value

boulderopalscaleupsdk/experiments/fine_amplitude_calibration.py

@@ -0,0 +1,54 @@
+# 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 Field, PrivateAttr
+
+from .common import Experiment
+from .waveforms import ConstantWaveform
+
+
+class FineAmplitudeCalibration(Experiment):
+    """
+    Parameters for running a fine amplitude calibration experiment for
+    a specified gate on a transmon.
+
+    Attributes
+    ----------
+    transmon : str
+        The reference for the transmon to target.
+    gate : Literal["sx", "x"]
+        The gate to be calibrated.
+    repetitions : list[int]
+        List of repetition counts for the calibration experiment.
+    recycle_delay_ns : int
+        The delay between consecutive shots, in nanoseconds. Defaults to 10,000 ns.
+    shot_count : int, optional
+        The number of shots to take. Defaults to 1000.
+    measure_waveform : ConstantWaveform or None, optional
+        The waveform to use for the measurement pulse.
+        Defaults to the measurement defcal.
+    update : "auto" or "off" or "prompt", optional
+        How the device should be updated after an experiment run. Defaults to auto.
+    """
+
+    _experiment_name: str = PrivateAttr("fine_amplitude_calibration")
+
+    transmon: str
+    gate: Literal["sx", "x"]
+    repetitions: list[int] = Field(default=list(range(0, 100, 4)))
+    recycle_delay_ns: int = 10_000
+    shot_count: int = 1000
+    measure_waveform: ConstantWaveform | None = None
+    update: Literal["auto", "off", "prompt"] = "auto"

boulderopalscaleupsdk/experiments/power_rabi.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,25 +24,23 @@ from .common import (
 )
 from .waveforms import ConstantWaveform, Waveform
 
-DEFAULT_SHOT_COUNT = 400
-
 
 class PowerRabi(Experiment):
     """
     Parameters for running a Power Rabi experiment.
 
-    Parameters
+    Attributes
     ----------
     transmon : str
         The reference for the transmon to target.
-    scales : list[float] or LinspaceIterable or RangeIterable
+    scales : list[float] or LinspaceIterable or RangeIterable \
             or CWSIterable or HypIterable or None, optional
         The scaling factors for the drive pulse amplitude.
         If None, a default scan will be used.
     drive_waveform : Waveform
         The waveform to use for the drive pulse.
     recycle_delay_ns : int
-        The delay between consecutive shots, in nanoseconds.
+        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.
     pulse_vp : float, optional
@@ -50,6 +50,8 @@ class PowerRabi(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("power_rabi")
@@ -57,8 +59,9 @@ class PowerRabi(Experiment):
     transmon: str
     scales: list[float] | LinspaceIterable | RangeIterable | CWSIterable | HypIterable | None = None
     drive_waveform: Waveform
-    recycle_delay_ns: int
-    shot_count: int = DEFAULT_SHOT_COUNT
+    recycle_delay_ns: int = 200_000
+    shot_count: int = 400
     pulse_vp: float | None = None
     measure_waveform: ConstantWaveform | None = None
     run_mixer_calibration: bool = False
+    update: Literal["auto", "off", "prompt"] = "auto"

boulderopalscaleupsdk/experiments/power_rabi_ef.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,27 +24,23 @@ from .common import (
 )
 from .waveforms import ConstantWaveform, Waveform
 
-DEFAULT_RECYCLE_DELAY_NS = 200_000
-DEFAULT_SHOT_COUNT = 400
-DEFAULT_DURATION_NS = 2_000
-
 
 class PowerRabiEF(Experiment):
     """
     Parameters for running a Power Rabi EF experiment.
 
-    Parameters
+    Attributes
     ----------
     transmon : str
         The reference for the transmon to target.
-    scales : list[float] or LinspaceIterable or RangeIterable
+    scales : list[float] or LinspaceIterable or RangeIterable \
             or CWSIterable or HypIterable or None, optional
         The scaling factors for the drive pulse amplitude.
         If None, a default scan will be used.
     drive_waveform : Waveform
         The waveform to use for the drive pulse.
     recycle_delay_ns : int
-        The delay between consecutive shots, in nanoseconds.
+        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.
     pulse_vp : float, optional
@@ -52,6 +50,8 @@ class PowerRabiEF(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("power_rabi_ef")
@@ -59,8 +59,9 @@ class PowerRabiEF(Experiment):
     transmon: str
     scales: list[float] | LinspaceIterable | RangeIterable | CWSIterable | HypIterable | None = None
     drive_waveform: Waveform
-    recycle_delay_ns: int = DEFAULT_RECYCLE_DELAY_NS
-    shot_count: int = DEFAULT_SHOT_COUNT
+    recycle_delay_ns: int = 200_000
+    shot_count: int = 400
     pulse_vp: float | None = None
     measure_waveform: ConstantWaveform | None = None
     run_mixer_calibration: bool = False
+    update: Literal["auto", "off", "prompt"] = "auto"

boulderopalscaleupsdk/experiments/ramsey.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 Experiment
 from .waveforms import ConstantWaveform
 
-DEFAULT_RECYCLE_DELAY_NS = 10_000
-DEFAULT_SHOT_COUNT = 400
-
 
 class Ramsey(Experiment):
     """
     Parameters for running a Ramsey experiment.
 
-    Parameters
+    Attributes
     ----------
     transmon : str
         The reference for the transmon to target.
@@ -37,7 +36,7 @@ class Ramsey(Experiment):
     virtual_detuning : float
         The virtual detuning added between SX pulses, in Hz.
     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 200,000 ns.
     shot_count : int, optional
         The number of shots to take. Defaults to 400.
     measure_waveform : ConstantWaveform or None, optional
@@ -45,6 +44,8 @@ class Ramsey(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("ramsey")
@@ -54,7 +55,8 @@ class Ramsey(Experiment):
     max_delay_ns: int
     delay_step_ns: int
     virtual_detuning: float
-    recycle_delay_ns: int = DEFAULT_RECYCLE_DELAY_NS
-    shot_count: int = DEFAULT_SHOT_COUNT
+    recycle_delay_ns: int = 200_000
+    shot_count: int = 400
     measure_waveform: ConstantWaveform | None = None
     run_mixer_calibration: bool = False
+    update: Literal["auto", "off", "prompt"] = "auto"

boulderopalscaleupsdk/experiments/ramsey_ef.py

@@ -0,0 +1,62 @@
+# 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
+from .waveforms import ConstantWaveform
+
+
+class RamseyEF(Experiment):
+    """
+    Parameters for running a EF Ramsey experiment.
+
+    Attributes
+    ----------
+    transmon : str
+        The reference for the transmon to target.
+    min_delay_ns : int
+        The minimum delay time, in nanoseconds.
+    max_delay_ns : int
+        The maximum delay time, in nanoseconds.
+    delay_step_ns : int
+        The step for generating the list of delays, in nanoseconds.
+    virtual_detuning : float
+        The virtual detuning added between sx_ef pulses, in Hz.
+    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.
+    measure_waveform : ConstantWaveform or None, optional
+        The waveform to use for the measurement pulse.
+        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("ramsey_ef")
+
+    transmon: str
+    min_delay_ns: int
+    max_delay_ns: int
+    delay_step_ns: int
+    virtual_detuning: float
+    recycle_delay_ns: int = 200_000
+    shot_count: int = 400
+    measure_waveform: ConstantWaveform | None = None
+    run_mixer_calibration: bool = False
+    update: Literal["auto", "off", "prompt"] = "auto"

boulderopalscaleupsdk/experiments/{readout_classifier_calibration.py → readout_classifier.py}

@@ -11,22 +11,28 @@
 # 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
 from .waveforms import ConstantWaveform
 
 
-class ReadoutClassifierCalibration(Experiment):
+class ReadoutClassifier(Experiment):
     """
-    Parameters for running calibration of readout classifier for a transmon.
+    Parameters for training a readout classifier.
+
+    This does not optimize the readout pulse itself.
+    The measure waveform is fixed (provided or using the device's default).
+    To optimize the readout pulse use ReadoutOptimization.
 
-    Parameters
+    Attributes
     ----------
     transmon : str
         The reference for the transmon to target.
     recycle_delay_ns : int
-        The delay between consecutive shots, in nanoseconds.
+        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.
     measure_waveform : ConstantWaveform or None, optional
@@ -34,11 +40,15 @@ class ReadoutClassifierCalibration(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("readout_classifier_calibration")
+    _experiment_name: str = PrivateAttr("readout_classifier")
+
     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"