Improve calibration experiments

qiskit_experiments/calibration_management/base_calibration_experiment.py

@@ -0,0 +1,90 @@
+# This code is part of Qiskit.
+#
+# (C) Copyright IBM 2021.
+#
+# This code is licensed under the Apache License, Version 2.0. You may
+# obtain a copy of this license in the LICENSE.txt file in the root directory
+# of this source tree or at http://www.apache.org/licenses/LICENSE-2.0.
+#
+# Any modifications or derivative works of this code must retain this
+# copyright notice, and modified files need to carry a notice indicating
+# that they have been altered from the originals.
+
+"""Base class for calibration-type experiments."""
+
+from abc import abstractmethod
+from typing import Optional
+
+from qiskit.providers.options import Options
+from qiskit.providers.backend import Backend
+
+from qiskit_experiments.framework.base_experiment import BaseExperiment
+from qiskit_experiments.framework.experiment_data import ExperimentData
+
+
+class BaseCalibrationExperiment(BaseExperiment):
+    """An abstract base class for calibration experiments.
+
+    This abstract base class specifies an experiment and how to update an
+    optional instance of :class:`Calibrations` specified in the experiment options
+    under calibrations. Furthermore, the experiment options also specifies
+    an auto_update variable which, by default, is set to True. If this variable,
+    is True then the run method of the experiment will call :meth:`block_for_results`
+    and update the calibrations instance.
+    """
+
+    # The updater class that updates the Calibrations instance
+    __updater__ = None
+
+    @abstractmethod
+    def update_calibrations(self, experiment_data: ExperimentData):
+        """Update parameter values in the :class:`Calibrations` instance.
+
+        Subclasses must implement this method which will call the :meth:`update`
+        method of the updater.
+        """
+
+    @classmethod
+    def _default_experiment_options(cls) -> Options:
+        """Default options for experiment
+
+        Experiment Options:
+            calibrations (Calibrations): An optional instance of :class:`Calibrations` if this
+                instance is specified then the experiment will try and update the calibrations.
+            auto_update (bool): A boolean which defaults to True. If this variable is set to
+                True then running the calibration experiment will block for the results and
+                update the calibrations if the calibrations is not None.
+        """
+        options = super()._default_experiment_options()
+        options.calibrations = None
+        options.auto_update = True
+
+        return options
+
+    def run(
+        self,
+        backend: Backend,
+        analysis: bool = True,
+        experiment_data: Optional[ExperimentData] = None,
+        **run_options,
+    ) -> ExperimentData:
+        """Run an experiment, perform analysis, and update any calibrations.
+
+        Args:
+            backend: The backend to run the experiment on.
+            analysis: If True run analysis on the experiment data.
+            experiment_data: Optional, add results to existing experiment data.
+                If None a new ExperimentData object will be returned.
+            run_options: backend runtime options used for circuit execution.
+
+        Returns:
+            The experiment data object.
+        """
+        experiment_data = super().run(backend, analysis, experiment_data, **run_options)
+
+        if self.experiment_options.auto_update:
+            if self.experiment_options.calibrations is not None:
+                experiment_data = experiment_data.block_for_results()
+                self.update_calibrations(experiment_data)
+
+        return experiment_data

qiskit_experiments/calibration_management/update_library.py

@@ -152,6 +152,7 @@ def update(
         calibrations: BackendCalibrations,
         exp_data: ExperimentData,
         result_index: Optional[int] = None,
+        parameter: str = None,
         group: str = "default",
         **options,
     ):
@@ -163,14 +164,19 @@ def update(
             calibrations: The calibrations to update.
             exp_data: The experiment data from which to update.
             result_index: The result index to use. By default search entry by name.
+            parameter: The name of the parameter to update. If None is given this will default
+                to :code:`calibrations.__qubit_freq_parameter__`.
             group: The calibrations group to update. Defaults to "default."
             options: Trailing options.
 
         """
+        if parameter is None:
+            parameter = calibrations.__qubit_freq_parameter__
+
         super().update(
             calibrations=calibrations,
             exp_data=exp_data,
-            parameter=calibrations.__qubit_freq_parameter__,
+            parameter=parameter,
             schedule=None,
             result_index=result_index,
             group=group,

qiskit_experiments/library/calibration/drag.py

@@ -21,12 +21,18 @@
 from qiskit.providers import Backend
 import qiskit.pulse as pulse
 
-from qiskit_experiments.framework import BaseExperiment, Options
+from qiskit_experiments.framework import Options
+from qiskit_experiments.framework.experiment_data import ExperimentData
 from qiskit_experiments.exceptions import CalibrationError
 from qiskit_experiments.library.calibration.analysis.drag_analysis import DragCalAnalysis
+from qiskit_experiments.calibration_management.update_library import Drag
+from qiskit_experiments.calibration_management.calibrations import Calibrations
+from qiskit_experiments.calibration_management.base_calibration_experiment import (
+    BaseCalibrationExperiment,
+)
 
 
-class DragCal(BaseExperiment):
+class DragCal(BaseCalibrationExperiment):
     r"""An experiment that scans the DRAG parameter to find the optimal value.
 
     # section: overview
@@ -75,6 +81,8 @@ class DragCal(BaseExperiment):
 
     __analysis_class__ = DragCalAnalysis
 
+    __updater__ = Drag
+
     @classmethod
     def _default_run_options(cls) -> Options:
         """Default option values for the experiment :meth:`run` method."""
@@ -107,6 +115,8 @@ def _default_experiment_options(cls) -> Options:
                 each series. Note that this list must always have a length of three as
                 otherwise the analysis class will not run.
             betas (Iterable): the values of the DRAG parameter to scan.
+            cal_parameter_name (str): The name of the DRAG parameter in the schedule stored in
+                the calibrations instance. The default value is "β".
         """
         options = super()._default_experiment_options()
 
@@ -117,6 +127,7 @@ def _default_experiment_options(cls) -> Options:
         options.sigma = 40
         options.reps = [1, 3, 5]
         options.betas = np.linspace(-5, 5, 51)
+        options.cal_parameter_name = "β"
 
         return options
 
@@ -149,13 +160,41 @@ def set_experiment_options(self, reps: Optional[List] = None, **fields):
 
         super().set_experiment_options(reps=reps, **fields)
 
-    def __init__(self, qubit: int):
+    def __init__(
+        self,
+        qubit: int,
+        cals: Optional[Calibrations] = None,
+        schedule_name: Optional[str] = "x",
+        cal_parameter_name: Optional[str] = "β",
+        betas: Optional[List] = None,
+        reps: Optional[List] = None,
+    ):
         """
         Args:
             qubit: The qubit for which to run the Drag calibration.
+            cals: If calibrations is given then running the experiment may update the
+                values of the pulse parameters stored in calibrations.
+            schedule_name: The name of the schedule to extract from the calibrations. This value
+                defaults to "x".
+            cal_parameter_name: The name of the parameter in calibrations to update. This name will
+                be stored in the experiment options and defaults to "β".
+            betas: The values of the DRAG parameter to scan. Specify this argument to override the
+                default values of the experiment.
         """
-
         super().__init__([qubit])
+        self.experiment_options.calibrations = cals
+        self.experiment_options.cal_parameter_name = cal_parameter_name
+
+        if cals is not None and schedule_name is not None:
+            self.experiment_options.rp = cals.get_schedule(
+                schedule_name, qubit, assign_params={cal_parameter_name: Parameter("β")}
+            )
+
+        if betas is not None:
+            self.experiment_options.betas = betas
+
+        if reps is not None:
+            self.experiment_options.reps = reps
 
     def circuits(self, backend: Optional[Backend] = None) -> List[QuantumCircuit]:
         """Create the circuits for the Drag calibration.
@@ -258,3 +297,17 @@ def circuits(self, backend: Optional[Backend] = None) -> List[QuantumCircuit]:
                 circuits.append(assigned_circuit)
 
         return circuits
+
+    def update_calibrations(self, experiment_data: ExperimentData):
+        """Update the calibrations given the experiment data.
+
+        Args:
+            experiment_data: The experiment data to use for the update.
+        """
+        calibrations = self.experiment_options.calibrations
+        name = self.experiment_options.rp.name
+        parameter_name = self.experiment_options.cal_parameter_name
+
+        self.__updater__.update(
+            calibrations, experiment_data, parameter=parameter_name, schedule=name
+        )