Fast forward experimental-0.2

.github/workflows/ci.yml

@@ -23,11 +23,11 @@ jobs:
     name: Run code quality checks
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v2
+      - uses: actions/checkout@v4
         with:
           fetch-depth: 0
       - name: Set up Python 3.9
-        uses: actions/setup-python@v2
+        uses: actions/setup-python@v5
         with:
           python-version: 3.9
       - name: Install dependencies
@@ -45,11 +45,11 @@ jobs:
     name: Build documentation
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v2
+      - uses: actions/checkout@v4
         with:
           fetch-depth: 0
       - name: Set up Python 3.9
-        uses: actions/setup-python@v2
+        uses: actions/setup-python@v5
         with:
           python-version: 3.9
       - name: Install dependencies
@@ -69,7 +69,7 @@ jobs:
       - name: Build documentation
         run: tox -edocs
       - name: Upload documentation
-        uses: actions/upload-artifact@v2
+        uses: actions/upload-artifact@v4
         with:
           name: html_docs
           path: docs/_build/html
@@ -88,11 +88,11 @@ jobs:
       STREAM_LOG: True
       QISKIT_IN_PARALLEL: True
     steps:
-      - uses: actions/checkout@v2
+      - uses: actions/checkout@v4
         with:
           fetch-depth: 0
       - name: Set up Python ${{ matrix.python-version }}
-        uses: actions/setup-python@v2
+        uses: actions/setup-python@v5
         with:
           python-version: ${{ matrix.python-version }}
       - name: Install dependencies
@@ -102,12 +102,12 @@ jobs:
       - name: Run unit tests
         run: make unit-test-coverage
       - name: Report coverage to coveralls.io
-        uses: coverallsapp/github-action@1.1.3
+        uses: coverallsapp/github-action@v2
         with:
           github-token: ${{ secrets.GITHUB_TOKEN }}
           flag-name: unit-tests_python${{ matrix.python-version }}-${{ matrix.os }}
           parallel: true
-          path-to-lcov: coverage.lcov
+          file: coverage.lcov
   integration-tests:
     if: github.event_name == 'push' && github.repository_owner == 'Qiskit'
     # only kick-off resource intensive integration tests if unit tests and all basic checks succeeded
@@ -130,11 +130,11 @@ jobs:
       STREAM_LOG: True
       QISKIT_IN_PARALLEL: True
     steps:
-      - uses: actions/checkout@v2
+      - uses: actions/checkout@v4
         with:
           fetch-depth: 0
       - name: Set up Python ${{ matrix.python-version }}
-        uses: actions/setup-python@v2
+        uses: actions/setup-python@v5
         with:
           python-version: ${{ matrix.python-version }}
       - name: Install dependencies
@@ -150,7 +150,7 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - name: Notify coveralls.io that all parallel tests have finished
-        uses: coverallsapp/github-action@1.1.3
+        uses: coverallsapp/github-action@v2
         with:
           github-token: ${{ secrets.GITHUB_TOKEN }}
           parallel-finished: true

.github/workflows/deploy.yml

@@ -27,15 +27,15 @@ jobs:
       matrix:
         python-version: [3.9]
     steps:
-      - uses: actions/checkout@v2
-      - uses: actions/setup-python@v2
+      - uses: actions/checkout@v4
+      - uses: actions/setup-python@v5
         with:
           python-version: ${{ matrix.python-version }}
       - name: Install deps
         run: pip install -U pip setuptools build
       - name: Build sdist
         run: python3 -m build
-      - uses: actions/upload-artifact@v3
+      - uses: actions/upload-artifact@v4
         with:
           path: ./dist/*
       - name: Deploy to Pypi

.github/workflows/docs.yml

@@ -10,11 +10,11 @@ jobs:
   deploy:
     runs-on: ubuntu-latest
     steps:
-    - uses: actions/checkout@v2
+    - uses: actions/checkout@v4
       with:
         fetch-depth: 0
     - name: Set up Python
-      uses: actions/setup-python@v2
+      uses: actions/setup-python@v5
       with:
         python-version: '3.9.12'
     - name: Install dependencies
@@ -25,7 +25,7 @@ jobs:
     - name: Build docs
       run: tox -e docs
     - name: Upload artifact
-      uses: actions/upload-artifact@v2
+      uses: actions/upload-artifact@v4
       with:
         name: html_docs
         path: docs/_build/html

.github/workflows/e2e-tests.yml

@@ -37,11 +37,11 @@ jobs:
       STREAM_LOG: True
       QISKIT_IN_PARALLEL: True
     steps:
-      - uses: actions/checkout@v2
+      - uses: actions/checkout@v4
         with:
           fetch-depth: 0
       - name: Set up Python ${{ matrix.python-version }}
-        uses: actions/setup-python@v2
+        uses: actions/setup-python@v5
         with:
           python-version: ${{ matrix.python-version }}
       - name: Install dependencies

.github/workflows/integration-tests-qiskit-main.yml

@@ -37,11 +37,11 @@ jobs:
       STREAM_LOG: True
       QISKIT_IN_PARALLEL: True
     steps:
-      - uses: actions/checkout@v2
+      - uses: actions/checkout@v4
         with:
           fetch-depth: 0
       - name: Set up Python ${{ matrix.python-version }}
-        uses: actions/setup-python@v2
+        uses: actions/setup-python@v5
         with:
           python-version: ${{ matrix.python-version }}
       - name: Install dependencies

.github/workflows/integration-tests.yml

@@ -37,11 +37,11 @@ jobs:
       STREAM_LOG: True
       QISKIT_IN_PARALLEL: True
     steps:
-      - uses: actions/checkout@v2
+      - uses: actions/checkout@v4
         with:
           fetch-depth: 0
       - name: Set up Python ${{ matrix.python-version }}
-        uses: actions/setup-python@v2
+        uses: actions/setup-python@v5
         with:
           python-version: ${{ matrix.python-version }}
       - name: Install dependencies

.github/workflows/q-ctrl-tests.yml

@@ -12,6 +12,8 @@
 
 name: Q-CTRL Tests
 on:
+  schedule:
+    - cron: '0 1 * * *'
   push:
       tags:
         - "*"
@@ -37,11 +39,11 @@ jobs:
       STREAM_LOG: True
       QISKIT_IN_PARALLEL: True
     steps:
-      - uses: actions/checkout@v2
+      - uses: actions/checkout@v4
         with:
           fetch-depth: 0
       - name: Set up Python ${{ matrix.python-version }}
-        uses: actions/setup-python@v2
+        uses: actions/setup-python@v5
         with:
           python-version: ${{ matrix.python-version }}
       - name: Install dependencies

.github/workflows/unit-tests-terra-main.yml

@@ -25,11 +25,11 @@ jobs:
       STREAM_LOG: True
       QISKIT_IN_PARALLEL: True
     steps:
-      - uses: actions/checkout@v2
+      - uses: actions/checkout@v4
         with:
           fetch-depth: 0
       - name: Set up Python 3.9
-        uses: actions/setup-python@v2
+        uses: actions/setup-python@v5
         with:
           python-version: 3.9
       - name: Install dependencies

.gitignore

@@ -107,3 +107,6 @@ Qconfig.py
 .DS_Store
 
 /docs/stubs/
+
+# Pycharm
+.idea

docs/conf.py

@@ -11,7 +11,9 @@
 # that they have been altered from the originals.
 
 # -- Path setup --------------------------------------------------------------
+import inspect
 import os
+import re
 import sys
 
 sys.path.insert(0, os.path.abspath('.'))
@@ -34,7 +36,7 @@
     'sphinx.ext.autodoc',
     'sphinx.ext.autosummary',
     # This is used by qiskit/documentation to generate links to github.com.
-    "sphinx.ext.viewcode",
+    "sphinx.ext.linkcode",
     'jupyter_sphinx',
     'sphinx_autodoc_typehints',
     'reno.sphinxext',
@@ -117,3 +119,75 @@
 html_last_updated_fmt = '%Y/%m/%d'
 html_sourcelink_suffix = ''
 autoclass_content = 'both'
+
+
+# ----------------------------------------------------------------------------------
+# Source code links
+# ----------------------------------------------------------------------------------
+
+def determine_github_branch() -> str:
+    """Determine the GitHub branch name to use for source code links.
+
+    We need to decide whether to use `stable/<version>` vs. `main` for dev builds.
+    Refer to https://docs.github.com/en/actions/learn-github-actions/variables
+    for how we determine this with GitHub Actions.
+    """
+    # If CI env vars not set, default to `main`. This is relevant for local builds.
+    if "GITHUB_REF_NAME" not in os.environ:
+        return "main"
+
+    # PR workflows set the branch they're merging into.
+    if base_ref := os.environ.get("GITHUB_BASE_REF"):
+        return base_ref
+
+    ref_name = os.environ["GITHUB_REF_NAME"]
+
+    # Check if the ref_name is a tag like `1.0.0` or `1.0.0rc1`. If so, we need
+    # to transform it to a Git branch like `stable/1.0`.
+    version_without_patch = re.match(r"(\d+\.\d+)", ref_name)
+    return (
+        f"stable/{version_without_patch.group()}"
+        if version_without_patch
+        else ref_name
+    )
+
+
+GITHUB_BRANCH = determine_github_branch()
+
+
+def linkcode_resolve(domain, info):
+    if domain != "py":
+        return None
+
+    module_name = info["module"]
+    module = sys.modules.get(module_name)
+    if module is None or "qiskit_ibm_runtime" not in module_name:
+        return None
+
+    obj = module
+    for part in info["fullname"].split("."):
+        try:
+            obj = getattr(obj, part)
+        except AttributeError:
+            return None
+        is_valid_code_object = (
+            inspect.isclass(obj) or inspect.ismethod(obj) or inspect.isfunction(obj)
+        )
+        if not is_valid_code_object:
+            return None
+    try:
+        full_file_name = inspect.getsourcefile(obj)
+    except TypeError:
+        return None
+    if full_file_name is None or "/qiskit_ibm_runtime/" not in full_file_name:
+        return None
+    file_name = full_file_name.split("/qiskit_ibm_runtime/")[-1]
+
+    try:
+        source, lineno = inspect.getsourcelines(obj)
+    except (OSError, TypeError):
+        linespec = ""
+    else:
+        ending_lineno = lineno + len(source) - 1
+        linespec = f"#L{lineno}-L{ending_lineno}"
+    return f"https://github.com/Qiskit/qiskit-ibm-runtime/tree/{GITHUB_BRANCH}/qiskit_ibm_runtime/{file_name}{linespec}"

docs/index.rst

@@ -28,11 +28,11 @@ Next steps
     Get started with Estimator <tutorials/how-to-getting-started-with-estimator>
     Get started with Sampler <tutorials/how-to-getting-started-with-sampler>
     Get started with error suppression and error mitigation <tutorials/Error-Suppression-and-Error-Mitigation>
-    CHSH with Estimator <tutorials/chsh_with_estimator>
-    VQE with Estimator <tutorials/vqe_with_estimator>
-    Grover with Sampler <tutorials/grover_with_sampler>
-    QAOA with Primitives <tutorials/qaoa_with_primitives>
-    Submit user-transpiled circuits using primitives <tutorials/user-transpiled-circuits>
+    CHSH with Estimator <tutorials/chsh_inequality/chsh_with_estimator>
+    VQE with Estimator <tutorials/variational_quantum_eigensolver/vqe_with_estimator>
+    Grover with Sampler <tutorials/grovers_algorithm/grover_with_sampler>
+    QAOA with Primitives <tutorials/quantum_approximate_optimization_algorithm/qaoa_with_primitives>
+    Submit user-transpiled circuits using primitives <tutorials/submitting_transpiled_circuits/user-transpiled-circuits>
     All tutorials <tutorials>
 
 

docs/release_notes.rst

@@ -1 +1,2 @@
 .. release-notes:: Release Notes
+  :earliest-version: 0.1.0rc1

docs/tutorials.rst

@@ -11,18 +11,18 @@ Estimator
 
    tutorials/how-to-getting-started-with-estimator
    tutorials/Error-Suppression-and-Error-Mitigation
-   tutorials/chsh_with_estimator
-   tutorials/vqe_with_estimator
+   tutorials/chsh_inequality/chsh_with_estimator
+   tutorials/variational_quantum_eigensolver/vqe_with_estimator
 
 Sampler
 =================================
 
 .. nbgallery::
 
    tutorials/how-to-getting-started-with-sampler
-   tutorials/grover_with_sampler
-   tutorials/user-transpiled-circuits
-   tutorials/qaoa_with_primitives
+   tutorials/grovers_algorithm/grover_with_sampler
+   tutorials/submitting_transpiled_circuits/user-transpiled-circuits
+   tutorials/quantum_approximate_optimization_algorithm/qaoa_with_primitives
 
 
 .. Hiding - Indices and tables