Add more documentation

Author: chriseclectic

qiskit_experiments/base_experiment.py

@@ -191,6 +191,10 @@ def _transpile(
     @classmethod
     def _default_options(cls) -> Options:
         """Default kwarg options for experiment"""
+        # Experiment subclasses should override this method to return
+        # an `Options` object containing all the supported options for
+        # that experiment and their default values. Only options listed
+        # here can be modified later by the `set_options` method.
         return Options()
 
     @property
@@ -217,6 +221,9 @@ def set_options(self, **fields):
     @classmethod
     def _default_transpile_options(cls) -> Options:
         """Default transpiler options for transpilation of circuits"""
+        # Experiment subclasses can override this method if they need
+        # to set specific transpiler options defaults for running the
+        # experiment.
         return Options(optimization_level=0)
 
     @property
@@ -260,8 +267,10 @@ def set_backend_options(self, **fields):
 
     @classmethod
     def _default_analysis_options(cls) -> Options:
-        """Default transpiler options for transpilation of circuits"""
-        # These should typically be set by the analysis class default options
+        """Default options for analysis of experiment results."""
+        # Experiment subclasses can override this method if they need
+        # to set specific analysis options defaults that are different
+        # from the Analysis subclass `_default_options` values.
         if cls.__analysis_class__:
             return cls.__analysis_class__._default_options()
         return None

qiskit_experiments/characterization/t1_experiment.py

@@ -196,7 +196,13 @@ def _format_plot(cls, ax, analysis_result, qubit=None, add_label=True):
 
 
 class T1Experiment(BaseExperiment):
-    """T1 experiment class"""
+    """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'.
+    """
 
     __analysis_class__ = T1Analysis
 

qiskit_experiments/randomized_benchmarking/rb_analysis.py

@@ -14,7 +14,6 @@
 """
 
 from typing import Optional, List
-import numpy as np
 
 from qiskit.providers.options import Options
 from qiskit_experiments.base_analysis import BaseAnalysis

qiskit_experiments/randomized_benchmarking/rb_experiment.py

@@ -20,13 +20,19 @@
 from qiskit import QuantumCircuit
 from qiskit.providers import Backend
 from qiskit.quantum_info import Clifford, random_clifford
+from qiskit.providers.options import Options
 
 from qiskit_experiments.base_experiment import BaseExperiment
 from .rb_analysis import RBAnalysis
 
 
 class RBExperiment(BaseExperiment):
-    """RB Experiment class"""
+    """RB Experiment class.
+    
+    Experiment Options:
+        lengths: A list of RB sequences lengths.
+        num_samples: number of samples to generate for each sequence length.
+    """
 
     # Analysis class for experiment
     __analysis_class__ = RBAnalysis
@@ -45,8 +51,7 @@ def __init__(
             qubits: the number of qubits or list of
                     physical qubits for the experiment.
             lengths: A list of RB sequences lengths.
-            num_samples: number of samples to generate for each
-                         sequence length
+            num_samples: number of samples to generate for each sequence length.
             seed: Seed or generator object for random number
                   generation. If None default_rng will be used.
             full_sampling: If True all Cliffords are independently sampled for
@@ -58,10 +63,12 @@ def __init__(
             self._rng = default_rng(seed=seed)
         else:
             self._rng = seed
-        self._lengths = list(lengths)
-        self._num_samples = num_samples
         self._full_sampling = full_sampling
-        super().__init__(qubits)
+        super().__init__(qubits, lenghs=list(lengths), num_samples=num_samples)
+
+    @classmethod
+    def _default_options(cls):
+        return Options(lengths=None, num_samples=None)
 
     # pylint: disable = arguments-differ
     def circuits(self, backend: Optional[Backend] = None) -> List[QuantumCircuit]:
@@ -72,8 +79,8 @@ def circuits(self, backend: Optional[Backend] = None) -> List[QuantumCircuit]:
             A list of :class:`QuantumCircuit`.
         """
         circuits = []
-        for _ in range(self._num_samples):
-            circuits += self._sample_circuits(self._lengths, seed=self._rng)
+        for _ in range(self.options.num_samples):
+            circuits += self._sample_circuits(self.options.lengths, seed=self._rng)
         return circuits
 
     def _sample_circuits(