Refactor monkey-patching so it is active during docs build

docs/howtos/artifacts.rst

@@ -25,6 +25,13 @@ Viewing artifacts
 Here we run a parallel experiment consisting of two :class:`.T1` experiments in parallel and then view the output
 artifacts as a list of :class:`.ArtifactData` objects accessed by :meth:`.ExperimentData.artifacts`:
 
+.. jupyter-execute::
+    :hide-code:
+
+    # Temporary workaround for missing support in Qiskit and qiskit-ibm-runtime
+    from qiskit_experiments.test.patching import patch_sampler_test_support
+    patch_sampler_test_support()
+
 .. jupyter-execute::
 
     from qiskit_ibm_runtime.fake_provider import FakePerth

docs/manuals/characterization/t1.rst

@@ -34,6 +34,13 @@ for qubit 0.
     packages to run simulations.  You can install them with ``python -m pip
     install qiskit-aer qiskit-ibm-runtime``.
 
+.. jupyter-execute::
+    :hide-code:
+
+    # Temporary workaround for missing support in Qiskit and qiskit-ibm-runtime
+    from qiskit_experiments.test.patching import patch_sampler_test_support
+    patch_sampler_test_support()
+
 .. jupyter-execute::
 
     import numpy as np

docs/manuals/characterization/t2ramsey.rst

@@ -62,6 +62,13 @@ pure T1/T2 relaxation noise model.
     packages to run simulations.  You can install them with ``python -m pip
     install qiskit-aer qiskit-ibm-runtime``.
 
+.. jupyter-execute::
+    :hide-code:
+
+    # Temporary workaround for missing support in Qiskit and qiskit-ibm-runtime
+    from qiskit_experiments.test.patching import patch_sampler_test_support
+    patch_sampler_test_support()
+
 .. jupyter-execute::
 
     # A T1 simulator

docs/manuals/characterization/tphi.rst

@@ -25,6 +25,13 @@ From the :math:`T_1` and :math:`T_2` estimates, we compute the results for
     packages to run simulations.  You can install them with ``python -m pip
     install qiskit-aer qiskit-ibm-runtime``.
 
+.. jupyter-execute::
+    :hide-code:
+
+    # Temporary workaround for missing support in Qiskit and qiskit-ibm-runtime
+    from qiskit_experiments.test.patching import patch_sampler_test_support
+    patch_sampler_test_support()
+
 .. jupyter-execute::
 
     import numpy as np

docs/manuals/measurement/readout_mitigation.rst

@@ -35,6 +35,13 @@ experiments to generate the corresponding mitigators.
     packages to run simulations.  You can install them with ``python -m pip
     install qiskit-aer qiskit-ibm-runtime``.
 
+.. jupyter-execute::
+    :hide-code:
+
+    # Temporary workaround for missing support in Qiskit and qiskit-ibm-runtime
+    from qiskit_experiments.test.patching import patch_sampler_test_support
+    patch_sampler_test_support()
+
 .. jupyter-execute::
 
     import numpy as np

docs/manuals/measurement/restless_measurements.rst

@@ -62,6 +62,13 @@ they use always starts with the qubits in the ground state.
     This tutorial requires the :external+qiskit_ibm_runtime:doc:`qiskit-ibm-runtime <index>` package to model a
     backend.  You can install it with ``python -m pip install qiskit-ibm-runtime``.
 
+.. jupyter-execute::
+    :hide-code:
+
+    # Temporary workaround for missing support in Qiskit and qiskit-ibm-runtime
+    from qiskit_experiments.test.patching import patch_sampler_test_support
+    patch_sampler_test_support()
+
 .. jupyter-execute::
 
     from qiskit_ibm_runtime.fake_provider import FakePerth

docs/manuals/verification/quantum_volume.rst

@@ -29,6 +29,13 @@ z_value = 2), and at least 100 trials have been ran.
     packages to run simulations.  You can install them with ``python -m pip
     install qiskit-aer qiskit-ibm-runtime``.
 
+.. jupyter-execute::
+    :hide-code:
+
+    # Temporary workaround for missing support in Qiskit and qiskit-ibm-runtime
+    from qiskit_experiments.test.patching import patch_sampler_test_support
+    patch_sampler_test_support()
+
 .. jupyter-execute::
 
     from qiskit_experiments.framework import BatchExperiment

docs/manuals/verification/randomized_benchmarking.rst

@@ -16,6 +16,13 @@ explanation on the RB method, which is based on Refs. [1]_ [2]_.
     packages to run simulations.  You can install them with ``python -m pip
     install qiskit-aer qiskit-ibm-runtime``.
 
+.. jupyter-execute::
+    :hide-code:
+
+    # Temporary workaround for missing support in Qiskit and qiskit-ibm-runtime
+    from qiskit_experiments.test.patching import patch_sampler_test_support
+    patch_sampler_test_support()
+
 .. jupyter-execute::
 
     import numpy as np

docs/manuals/verification/state_tomography.rst

@@ -14,6 +14,13 @@ complete basis of measurement operators.
 
 We first initialize a simulator to run the experiments on.
 
+.. jupyter-execute::
+    :hide-code:
+
+    # Temporary workaround for missing support in Qiskit and qiskit-ibm-runtime
+    from qiskit_experiments.test.patching import patch_sampler_test_support
+    patch_sampler_test_support()
+
 .. jupyter-execute::
 
     from qiskit_aer import AerSimulator

docs/tutorials/custom_experiment.rst

@@ -562,6 +562,13 @@ To test our code, we first simulate a noisy backend with asymmetric readout erro
     You can install it with ``python -m pip install qiskit-aer``.
 
 
+.. jupyter-execute::
+    :hide-code:
+
+    # Temporary workaround for missing support in Qiskit and qiskit-ibm-runtime
+    from qiskit_experiments.test.patching import patch_sampler_test_support
+    patch_sampler_test_support()
+
 .. jupyter-execute::
 
   from qiskit_aer import AerSimulator, noise

docs/tutorials/getting_started.rst

@@ -86,6 +86,13 @@ backend, real or simulated, that you can access through Qiskit.
     packages to run simulations.  You can install them with ``python -m pip
     install qiskit-aer qiskit-ibm-runtime``.
 
+.. jupyter-execute::
+    :hide-code:
+
+    # Temporary workaround for missing support in Qiskit and qiskit-ibm-runtime
+    from qiskit_experiments.test.patching import patch_sampler_test_support
+    patch_sampler_test_support()
+
 .. jupyter-execute::
 
     from qiskit_ibm_runtime.fake_provider import FakePerth

qiskit_experiments/library/characterization/correlated_readout_error.py

@@ -77,6 +77,10 @@ class CorrelatedReadoutError(BaseExperiment):
         .. jupyter-execute::
             :hide-code:
 
+            # Temporary workaround for missing support in Qiskit and qiskit-ibm-runtime
+            from qiskit_experiments.test.patching import patch_sampler_test_support
+            patch_sampler_test_support()
+
             from qiskit.providers.fake_provider import GenericBackendV2
             from qiskit_aer import AerSimulator
 

qiskit_experiments/library/characterization/fine_frequency.py

@@ -53,6 +53,10 @@ class FineFrequency(BaseExperiment):
         .. jupyter-execute::
             :hide-code:
 
+            # Temporary workaround for missing support in Qiskit and qiskit-ibm-runtime
+            from qiskit_experiments.test.patching import patch_sampler_test_support
+            patch_sampler_test_support()
+
             # backend
             from qiskit_ibm_runtime.fake_provider import FakePerth
             from qiskit_aer import AerSimulator

qiskit_experiments/library/characterization/local_readout_error.py

@@ -66,6 +66,10 @@ class LocalReadoutError(BaseExperiment):
         .. jupyter-execute::
             :hide-code:
 
+            # Temporary workaround for missing support in Qiskit and qiskit-ibm-runtime
+            from qiskit_experiments.test.patching import patch_sampler_test_support
+            patch_sampler_test_support()
+
             # backend
             from qiskit_aer import AerSimulator
             from qiskit_ibm_runtime.fake_provider import FakePerth

qiskit_experiments/library/characterization/multi_state_discrimination.py

@@ -57,6 +57,10 @@ class MultiStateDiscrimination(BaseExperiment):
         .. jupyter-execute::
             :hide-code:
 
+            # Temporary workaround for missing support in Qiskit and qiskit-ibm-runtime
+            from qiskit_experiments.test.patching import patch_sampler_test_support
+            patch_sampler_test_support()
+
             # backend
             from qiskit_experiments.test.pulse_backend import SingleTransmonTestBackend
             backend = SingleTransmonTestBackend(5.2e9,-.25e9, 1e9, 0.8e9, 1e4, noise=False, seed=199)

qiskit_experiments/library/characterization/ramsey_xy.py

@@ -85,6 +85,10 @@ class RamseyXY(BaseExperiment, RestlessMixin):
         .. jupyter-execute::
             :hide-code:
 
+            # Temporary workaround for missing support in Qiskit and qiskit-ibm-runtime
+            from qiskit_experiments.test.patching import patch_sampler_test_support
+            patch_sampler_test_support()
+
             # backend
             from qiskit_aer import AerSimulator
             from qiskit_ibm_runtime.fake_provider import FakePerth

qiskit_experiments/library/characterization/t1.py

@@ -41,6 +41,10 @@ class T1(BaseExperiment):
         .. jupyter-execute::
             :hide-code:
 
+            # Temporary workaround for missing support in Qiskit and qiskit-ibm-runtime
+            from qiskit_experiments.test.patching import patch_sampler_test_support
+            patch_sampler_test_support()
+
             # backend
             from qiskit_ibm_runtime.fake_provider import FakeManilaV2
             from qiskit_aer import AerSimulator

qiskit_experiments/library/characterization/t2ramsey.py

@@ -63,6 +63,10 @@ class T2Ramsey(BaseExperiment):
         .. jupyter-execute::
             :hide-code:
 
+            # Temporary workaround for missing support in Qiskit and qiskit-ibm-runtime
+            from qiskit_experiments.test.patching import patch_sampler_test_support
+            patch_sampler_test_support()
+
             # backend
             from qiskit_ibm_runtime.fake_provider import FakeManilaV2
             from qiskit_aer import AerSimulator

qiskit_experiments/library/characterization/tphi.py

@@ -54,6 +54,10 @@ class Tphi(BatchExperiment):
         .. jupyter-execute::
             :hide-code:
 
+            # Temporary workaround for missing support in Qiskit and qiskit-ibm-runtime
+            from qiskit_experiments.test.patching import patch_sampler_test_support
+            patch_sampler_test_support()
+
             # backend
             from qiskit_ibm_runtime.fake_provider import FakeManilaV2
             from qiskit_aer import AerSimulator

qiskit_experiments/library/characterization/zz_ramsey.py

@@ -129,6 +129,10 @@ class ZZRamsey(BaseExperiment):
         .. jupyter-execute::
             :hide-code:
 
+            # Temporary workaround for missing support in Qiskit and qiskit-ibm-runtime
+            from qiskit_experiments.test.patching import patch_sampler_test_support
+            patch_sampler_test_support()
+
             # backend
             from qiskit_ibm_runtime.fake_provider import FakePerth
             from qiskit_aer import AerSimulator

qiskit_experiments/test/mock_iq_backend.py

@@ -47,6 +47,11 @@ def __init__(
         backend_version: str = None,
         **fields,
     ):
+        # Temporary workaround for missing support in Qiskit and qiskit-ibm-runtime
+        from qiskit_experiments.test.patching import patch_sampler_test_support
+
+        patch_sampler_test_support()
+
         super().__init__(provider, name, description, online_date, backend_version, **fields)
 
         backend_v1 = FakeOpenPulse2Q()