Merge branch 'main' into feature/stark_p1_frequency_scan

Author: wshanks

.github/workflows/cron-staging.yml

@@ -10,7 +10,7 @@ jobs:
     runs-on: ${{ matrix.os }}
     strategy:
       matrix:
-        python-version: [3.8, 3.9, "3.10", "3.11"]
+        python-version: [3.8, "3.11"]
         os: ["ubuntu-latest", "macOS-latest", "windows-latest"]
     steps:
       - name: Print Concurrency Group

.github/workflows/main.yml

@@ -15,7 +15,7 @@ jobs:
     runs-on: ${{ matrix.os }}
     strategy:
       matrix:
-        python-version: [3.8, 3.9, "3.10", "3.11"]
+        python-version: [3.8, "3.11"]
         os: ["ubuntu-latest", "macOS-latest", "windows-latest"]
     steps:
       - name: Print Concurrency Group
@@ -39,25 +39,20 @@ jobs:
             ${{ runner.os }}-${{ matrix.python-version }}-pip-tests-
             ${{ runner.os }}-${{ matrix.python-version }}-pip-
             ${{ runner.os }}-${{ matrix.python-version }}
+      - name: Stestr cache
+        uses: actions/cache@v3
+        with:
+          path: .stestr
+          key: stestr-${{ runner.os }}-${{ matrix.python-version }}
+          restore-keys: |
+            stestr-${{ runner.os }}-
+            stestr-
       - name: Install Deps
-        run: python -m pip install -U "tox==3.27.1" setuptools virtualenv wheel
-      - name: Install and Run Tests (Windows and Linux)
+        run: python -m pip install -U tox setuptools virtualenv wheel stestr
+      - name: Install and Run Tests
         run: tox -e py
-        if: runner.os != 'macOS'
-      - name: Install and Run Tests (Macs only)
-        run: tox -e cover
-        if: runner.os == 'macOS'
-        env:
-          OMP_NUM_THREADS: 1
-      - name: Report coverage to coveralls.io (Macs only)
-        if: runner.os == 'macOS'
-        uses: coverallsapp/github-action@v2
-        env:
-          ACTIONS_RUNNER_DEBUG: 1
-        with:
-          github-token: ${{ secrets.GITHUB_TOKEN }}
-          flag-name: unit-tests_python${{ matrix.python-version }}-${{ matrix.os }}
-          path-to-lcov: coverage.lcov
+      - name: Clean up stestr cache
+        run: stestr history remove all
 
   lint:
     name: lint
@@ -98,7 +93,7 @@ jobs:
           python -m pip install -U tox
           sudo apt-get install -y pandoc graphviz
       - name: Build Docs
-        run: tox -edocs
+        run: tox -edocs-parallel
       - name: Compress Artifacts
         run: |
           mkdir artifacts

.github/workflows/release.yml

@@ -7,14 +7,17 @@ jobs:
   wheel-build:
     name: Build and Publish Release Artifacts
     runs-on: ubuntu-latest
+    environment: release
+    permissions:
+      id-token: write
     steps:
       - uses: actions/checkout@v3
       - uses: actions/setup-python@v4
         name: Install Python
         with:
           python-version: '3.8'
       - name: Install Deps
-        run: pip install -U twine wheel
+        run: pip install -U wheel
       - name: Build Artifacts
         run: |
           python setup.py sdist
@@ -24,7 +27,4 @@ jobs:
         with:
           path: ./dist/qiskit*
       - name: Publish to PyPi
-        env:
-          TWINE_PASSWORD: ${{ secrets.TWINE_PASSWORD }}
-          TWINE_USERNAME: qiskit
-        run: twine upload dist/qiskit*
+        uses: pypa/gh-action-pypi-publish@release/v1

.stestr.conf

@@ -1,2 +1,3 @@
 [DEFAULT]
 test_path=./test
+parallel_class=True

CODE_OF_CONDUCT.md

@@ -1,7 +1,7 @@
 <!-- Copyright Contributors to the Qiskit project. -->
 
 # Code of Conduct
-All members of this project agree to adhere to the Qiskit Code of Conduct listed at [https://github.com/Qiskit/qiskit-metapackage/blob/master/CODE_OF_CONDUCT.md](https://github.com/Qiskit/qiskit-metapackage/blob/master/CODE_OF_CONDUCT.md)
+All members of this project agree to adhere to the [Qiskit Code of Conduct](https://github.com/Qiskit/qiskit/blob/main/CODE_OF_CONDUCT.md).
 
 ----
 

CONTRIBUTING.md

@@ -121,6 +121,8 @@ To run a method:
 tox -- -n test.python.test_examples.TestPythonExamples.test_all_examples
 ```
 
+Note that tests will fail automatically if they do not finish execution within 60 seconds.
+
 #### STDOUT/STDERR and logging capture
 
 When running tests in parallel using `stestr` either via tox, the Makefile (`make

README.md

@@ -3,7 +3,6 @@
 [![License](https://img.shields.io/github/license/Qiskit-Extensions/qiskit-experiments.svg)](https://opensource.org/licenses/Apache-2.0)
 [![Release](https://img.shields.io/github/release/Qiskit-Extensions/qiskit-experiments.svg)](https://github.com/Qiskit-Extensions/qiskit-experiments/releases)
 ![Python](https://img.shields.io/pypi/pyversions/qiskit-experiments.svg)
-[![Coverage Status](https://coveralls.io/repos/github/Qiskit-Extensions/qiskit-experiments/badge.svg?branch=main)](https://coveralls.io/github/Qiskit-Extensions/qiskit-experiments?branch=main)
 [![DOI](https://joss.theoj.org/papers/10.21105/joss.05329/status.svg)](https://doi.org/10.21105/joss.05329)
 
 **Qiskit Experiments** is a repository that builds tools for building, running,

docs/conf.py

@@ -53,7 +53,6 @@
     "sphinx.ext.autodoc",
     "sphinx.ext.autosummary",
     "sphinx.ext.mathjax",
-    "sphinx.ext.viewcode",
     "sphinx.ext.extlinks",
     "sphinx_copybutton",
     "jupyter_sphinx",
@@ -69,11 +68,14 @@
     "sphinx_remove_toctrees",
 ]
 
-# Remove stubs from the toctree by default because the full build is slow
-# This is turned off for docs deployment
-if not os.getenv("FULL_TOCTREE", None):
+if os.getenv("PROD_BUILD", None):
+    # Turn on view code source for production build
+    extensions.append("sphinx.ext.viewcode")
+else:
+    # Remove stubs from the toctree for non-prod build because the full build is slow
     remove_from_toctrees = ["stubs/*"]
 
+
 html_static_path = ["_static"]
 templates_path = ["_templates"]
 # Manually add the gallery CSS file for now

docs/howtos/figure_generation.rst

@@ -0,0 +1,45 @@
+Control figure generation 
+=========================
+
+Problem
+-------
+
+You want to change the default behavior where figures are generated with every experiment.
+
+Solution
+--------
+
+For a single non-composite experiment, figure generation can be switched off by setting the analysis
+option ``plot`` to ``False``:
+
+.. jupyter-input::
+
+    experiment.analysis.set_options(plot = False)    
+
+For composite experiments, there is a ``generate_figures`` analysis option which controls how child figures are
+generated. There are three options:
+
+- ``always``: The default behavior, generate figures for each child experiment.
+- ``never``: Never generate figures for any child experiment.
+- ``selective``: Only generate figures for analysis results where ``quality`` is ``bad``. This is useful
+  for large composite experiments where you only want to examine qubits with problems.
+
+This parameter should be set on the analysis of a composite experiment before the analysis runs:
+
+.. jupyter-input::
+
+    parallel_exp = ParallelExperiment(
+        [T1(physical_qubits=(i,), delays=delays) for i in range(2)]
+    )
+    parallel_exp.analysis.set_options(generate_figures="selective")
+
+Discussion
+----------
+
+These options are useful for large composite experiments, where generating all figures incurs a significant
+overhead.
+
+See Also
+--------
+
+* The `Visualization tutorial <visualization.html>`_ discusses how to customize figures

docs/manuals/characterization/stark_experiment.rst

@@ -104,7 +104,7 @@ By default, the Stark tone is applied to the same channel as the qubit drive
 with a frequency shift. This frequency shift might update the channel frame,
 which accumulates unwanted phase against the frequency difference between
 the qubit drive :math:`f_0` and Stark tone frequencies :math:`f_S` in addition to
-the qubit Stark shfit :math:`\delta f_s`.
+the qubit Stark shift :math:`\delta f_s`.
 You can use a dedicated Stark drive channel if available.
 Otherwise, you may want to use a control channel associated with the physical
 drive port of the qubit.