Fix rebase / doc errors

Author: chriseclectic

qiskit_experiments/base_analysis.py

@@ -15,12 +15,14 @@
 
 from abc import ABC, abstractmethod
 from typing import List, Tuple
-import copy
 
 from qiskit.providers.options import Options
 from qiskit.exceptions import QiskitError
 
-from .experiment_data import ExperimentData, AnalysisResult
+from qiskit_experiments.experiment_data import ExperimentData, AnalysisResult
+
+# pylint: disable = unused-import
+from qiskit_experiments.matplotlib import pyplot
 
 
 class BaseAnalysis(ABC):
@@ -40,25 +42,29 @@ class BaseAnalysis(ABC):
     def _default_options(cls) -> Options:
         return Options()
 
-    def run(self, experiment_data, save=True, return_figures=False, **options):
+    def run(
+        self,
+        experiment_data: ExperimentData,
+        save: bool = True,
+        return_figures: bool = False,
+        **options,
+    ):
         """Run analysis and update ExperimentData with analysis result.
 
         Args:
-            experiment_data (ExperimentData): the experiment data to analyze.
-            save (bool): if True save analysis results and figures to the
-                         :class:`ExperimentData`.
-            return_figures (bool): if true return a pair of
-                                   ``(analysis_results, figures)``,
-                                    otherwise return only analysis_results.
+            experiment_data: the experiment data to analyze.
+            save: if True save analysis results and figures to the
+                  :class:`ExperimentData`.
+            return_figures: if true return a pair of
+                            ``(analysis_results, figures)``,
+                            otherwise return only analysis_results.
             options: additional analysis options. See class documentation for
                      supported options.
 
         Returns:
-            AnalysisResult: the output of the analysis that produces a
-                            single result.
             List[AnalysisResult]: the output for analysis that produces
                                   multiple results.
-            tuple: If ``return_figures=True`` the output is a pair
+            Tuple: If ``return_figures=True`` the output is a pair
                    ``(analysis_results, figures)`` where  ``analysis_results``
                    may be a single or list of :class:`AnalysisResult` objects, and
                    ``figures`` may be None, a single figure, or a list of figures.
@@ -102,7 +108,7 @@ def run(self, experiment_data, save=True, return_figures=False, **options):
     @abstractmethod
     def _run_analysis(
         self, experiment_data: ExperimentData, **options
-    ) -> Tuple[List[AnalysisResult], List["Figure"]]:
+    ) -> Tuple[List[AnalysisResult], List["pyplot.Figure"]]:
         """Run analysis on circuit data.
 
         Args:

qiskit_experiments/base_experiment.py

@@ -17,15 +17,12 @@
 from typing import Union, Iterable, Optional, Tuple, List
 import copy
 from numbers import Integral
-from typing import List, Optional, Iterable, Tuple, Union
 
 from qiskit import transpile, assemble, QuantumCircuit
 from qiskit.providers.options import Options
 from qiskit.providers.backend import Backend
 from qiskit.providers.basebackend import BaseBackend as LegacyBackend
 from qiskit.exceptions import QiskitError
-from qiskit.providers.backend import Backend
-from qiskit.providers.basebackend import BaseBackend as LegacyBackend
 
 from .experiment_data import ExperimentData
 
@@ -172,7 +169,7 @@ def physical_qubits(self) -> Tuple[int]:
         return self._physical_qubits
 
     @classmethod
-    def analysis(cls, **kwargs) -> "BaseAnalysis":
+    def analysis(cls, **kwargs):
         """Return the default Analysis class for the experiment."""
         if cls.__analysis_class__ is None:
             raise QiskitError(f"Experiment {cls.__name__} does not have a default Analysis class")
@@ -187,7 +184,7 @@ def circuits(self, backend: Optional[Backend] = None) -> List[QuantumCircuit]:
             backend: Optional, a backend object.
 
         Returns:
-            A list of :class:`QuantumCircuit`s.
+            A list of :class:`QuantumCircuit`.
 
         .. note::
             These circuits should be on qubits ``[0, .., N-1]`` for an

qiskit_experiments/characterization/t1_experiment.py

@@ -33,12 +33,17 @@ class T1Analysis(BaseAnalysis):
     """T1 Experiment result analysis class.
 
     Analysis Options:
-        t1_guess (float): Optional, an initial guess of T1
-        amplitude_guess (float): Optional, an initial guess of the coefficient of the exponent
-        offset_guess (float): Optional, an initial guess of the offset
-        t1_bounds (list of two floats): Optional, lower bound and upper bound to T1
-        amplitude_bounds (list of two floats): Optional, lower bound and upper bound to the amplitude
-        offset_bounds (list of two floats): Optional, lower bound and upper bound to the offset
+
+        * t1_guess (float): Optional, an initial guess of T1.
+        * amplitude_guess (float): Optional, an initial guess of the
+                                   coefficient of the exponent.
+        * offset_guess (float): Optional, an initial guess of the offset.
+        * t1_bounds (list of two floats): Optional, lower bound and upper
+                                          bound to T1.
+        * amplitude_bounds (list of two floats): Optional, lower bound and upper
+                                                 bound to the amplitude.
+        * offset_bounds (list of two floats): Optional, lower bound and
+                                              upper bound to the offset.
     """
 
     @classmethod
@@ -62,6 +67,7 @@ def _run_analysis(
         t1_bounds=None,
         amplitude_bounds=None,
         offset_bounds=None,
+        plot=True,
     ) -> Tuple[AnalysisResult, None]:
         """
         Calculate T1
@@ -70,17 +76,23 @@ def _run_analysis(
             experiment_data (ExperimentData): the experiment data to analyze
             t1_guess (float): Optional, an initial guess of T1
             amplitude_guess (float): Optional, an initial guess of the coefficient
-                of the exponent
+                                     of the exponent
             offset_guess (float): Optional, an initial guess of the offset
             t1_bounds (list of two floats): Optional, lower bound and upper bound to T1
-            amplitude_bounds (list of two floats): Optional, lower bound and upper bound to the amplitude
-            offset_bounds (list of two floats): Optional, lower bound and upper bound to the offset
+            amplitude_bounds (list of two floats): Optional, lower bound and upper
+                                                   bound to the amplitude
+            offset_bounds (list of two floats): Optional, lower bound and upper
+                                                bound to the offset
+            plot (bool): Generator plot of exponential fit.
 
         Returns:
             The analysis result with the estimated T1
         """
-        unit = experiment_data._data[0]["metadata"]["unit"]
-        conversion_factor = experiment_data._data[0]["metadata"].get("dt_factor", None)
+        data = experiment_data.data()
+        unit = data[0]["metadata"]["unit"]
+        conversion_factor = data[0]["metadata"].get("dt_factor", None)
+        qubit = data[0]["metadata"]["qubit"]
+
         if conversion_factor is None:
             conversion_factor = 1 if unit == "s" else apply_prefix(1, unit)
 
@@ -199,9 +211,9 @@ class T1Experiment(BaseExperiment):
     """T1 experiment class.
 
     Experiment Options:
-        delays: delay times of the experiments
-        unit: Optional, unit of the delay times. Supported units are
-              's', 'ms', 'us', 'ns', 'ps', 'dt'.
+        * delays: delay times of the experiments
+        * unit: Optional, unit of the delay times. Supported units are
+                's', 'ms', 'us', 'ns', 'ps', 'dt'.
     """
 
     __analysis_class__ = T1Analysis
@@ -237,7 +249,7 @@ def __init__(
         # Set experiment options
         self.set_options(delays=delays, unit=unit)
 
-    def circuits(self, backend: Optional["Backend"] = None) -> List[QuantumCircuit]:
+    def circuits(self, backend: Optional[Backend] = None) -> List[QuantumCircuit]:
         """
         Return a list of experiment circuits
 

qiskit_experiments/composite/composite_analysis.py

@@ -13,6 +13,7 @@
 Composite Experiment Analysis class.
 """
 
+from qiskit.exceptions import QiskitError
 from qiskit_experiments.base_analysis import BaseAnalysis, AnalysisResult
 from .composite_experiment_data import CompositeExperimentData
 

qiskit_experiments/randomized_benchmarking/rb_analysis.py

@@ -16,18 +16,14 @@
 from typing import Optional, List
 
 from qiskit.providers.options import Options
+from qiskit_experiments.experiment_data import ExperimentData
 from qiskit_experiments.base_analysis import BaseAnalysis
 from qiskit_experiments.analysis.curve_fitting import curve_fit, process_curve_data
 from qiskit_experiments.analysis.data_processing import (
     level2_probability,
     mean_xy_data,
 )
-from qiskit_experiments.analysis.plotting import (
-    HAS_MATPLOTLIB,
-    plot_curve_fit,
-    plot_scatter,
-    plot_errorbar,
-)
+from qiskit_experiments.analysis import plotting
 
 
 class RBAnalysis(BaseAnalysis):
@@ -50,10 +46,10 @@ def _default_options(cls):
     # pylint: disable = arguments-differ, invalid-name
     def _run_analysis(
         self,
-        experiment_data: "ExperimentData",
+        experiment_data: ExperimentData,
         p0: Optional[List[float]] = None,
         plot: bool = True,
-        ax: Optional["AxesSubplot"] = None,
+        ax: Optional["plotting.pyplot.AxesSubplot"] = None,
     ):
         """Run analysis on circuit data.
         Args:
@@ -95,10 +91,10 @@ def fit_fun(x, a, alpha, b):
         analysis_result["EPC"] = scale * (1 - popt[1])
         analysis_result["EPC_err"] = scale * popt_err[1] / popt[1]
 
-        if plot and HAS_MATPLOTLIB:
-            ax = plot_curve_fit(fit_fun, analysis_result, ax=ax)
-            ax = plot_scatter(x_raw, y_raw, ax=ax)
-            ax = plot_errorbar(xdata, ydata, ydata_sigma, ax=ax)
+        if plot and plotting.HAS_MATPLOTLIB:
+            ax = plotting.plot_curve_fit(fit_fun, analysis_result, ax=ax)
+            ax = plotting.plot_scatter(x_raw, y_raw, ax=ax)
+            ax = plotting.plot_errorbar(xdata, ydata, ydata_sigma, ax=ax)
             self._format_plot(ax, analysis_result)
             figures = [ax.get_figure()]
         else: