Rabi update (Qiskit-Extensions#1238)

qiskit_experiments/library/characterization/rabi.py

@@ -56,6 +56,32 @@ class Rabi(BaseExperiment, RestlessMixin):
 
     # section: analysis_ref
         :class:`~qiskit_experiments.curve_analysis.OscillationAnalysis`
+
+    # section: example
+        .. jupyter-execute::
+            :hide-code:
+
+            # backend
+            from qiskit_experiments.test.pulse_backend import SingleTransmonTestBackend
+            backend = SingleTransmonTestBackend(5.2e9, seed=200)
+
+        .. jupyter-execute::
+
+            import numpy as np
+            from qiskit import pulse
+            from qiskit.circuit import Parameter
+            from qiskit_experiments.library import Rabi
+
+            with pulse.build() as build_sched:
+                pulse.play(pulse.Gaussian(160, Parameter("amp"), 40), pulse.DriveChannel(0))
+
+            exp = Rabi(physical_qubits=(0,),
+                       schedule=build_sched,
+                       amplitudes=np.linspace(-0.1, 0.1, 21),
+                       backend=backend,)
+
+            exp_data = exp.run().block_for_results()
+            exp_data.figure(0)
     """
 
     __gate_name__ = "Rabi"