Add NEAT notebook (#2223)

Closes #2191 (Just a draft; adding the initial content from Sam) FYI @abbycross @SamFerracin @jyu00 --------- Co-authored-by: ABBY CROSS <across@us.ibm.com>
Qiskit · Nov 8, 2024 · bc16d03 · bc16d03
1 parent 870071a
commit bc16d03
Show file tree

Hide file tree

Showing 7 changed files with 642 additions and 1 deletion.
diff --git a/docs/guides/_toc.json b/docs/guides/_toc.json
@@ -304,6 +304,10 @@
               "title": "Qiskit Runtime local testing mode",
               "url": "/guides/local-testing-mode"
             },
+            {
+              "title": "Debug Qiskit Runtime jobs",
+              "url": "/guides/debug-qiskit-runtime-jobs"
+            },
             {
               "title": "Build noise models",
               "url": "/guides/build-noise-models"

diff --git a/docs/guides/debug-qiskit-runtime-jobs.ipynb b/docs/guides/debug-qiskit-runtime-jobs.ipynb
diff --git a/docs/guides/debugging-tools.mdx b/docs/guides/debugging-tools.mdx
@@ -21,6 +21,7 @@ For general quantum circuits, the following tools are available to test and debu
 - For exact simulation of small quantum circuits, you can use the reference primitives included with Qiskit. See [Exact simulation with Qiskit primitives](./simulate-with-qiskit-sdk-primitives).
 - For higher-performance simulation that can handle larger circuits, or to incorporate noise models into your simulation, use [Qiskit Aer](https://qiskit.org/ecosystem/aer/), a project that is part of the [Qiskit Ecosystem](https://qiskit.github.io/ecosystem/). See [Exact and noisy simulation with Qiskit Aer primitives](simulate-with-qiskit-aer).
 - To build custom noise models, use the [`noise`](https://qiskit.org/ecosystem/aer/apidocs/aer_noise.html) module of Qiskit Aer. See [Building noise models](./build-noise-models).
+- For Qiskit Runtime Estimator jobs, use the Qiskit Runtime [`Neat`](/api/qiskit-ibm-runtime/debug_tools) class to debug and analyze your jobs. See [Debug Qiskit Runtime jobs](/guides/debug-qiskit-runtime-jobs) for details.
 
 ## Hardware considerations
 

diff --git a/docs/guides/optimize-for-hardware.mdx b/docs/guides/optimize-for-hardware.mdx
@@ -49,6 +49,7 @@ can be run on IBM&reg; hardware using IBM Qiskit Runtime.
 * [Exact simulation with Qiskit SDK primitives](./simulate-with-qiskit-sdk-primitives)
 * [Exact and noisy simulation with Qiskit Aer primitives](./simulate-with-qiskit-aer)
 * [Qiskit Runtime local testing mode](./local-testing-mode)
+* [Debug Qiskit Runtime jobs](./debug-qiskit-runtime-jobs)
 * [Build noise models](./build-noise-models)
 * [Plot quantum states](./plot-quantum-states)
 * [Efficient simulation of stabilizer circuits with Qiskit Aer primitives](./simulate-stabilizer-circuits)

diff --git a/qiskit_bot.yaml b/qiskit_bot.yaml
@@ -235,6 +235,10 @@ notifications:
     - "`@mtreinish`"
   "docs/guides/visualize-circuits":
     - "@frankharkins"
+  "docs/guides/debug-qiskit-runtime-jobs":
+    - "@beckykd"
+    - "@abbycross"
+    - "@SamFerracin"
   "docs/migration-guides/index":
     - "@javabster"
   "docs/migration-guides/qiskit-algorithms-module":

diff --git a/scripts/config/cspell/dictionaries/qiskit.txt b/scripts/config/cspell/dictionaries/qiskit.txt
@@ -17,6 +17,11 @@ CVXPY
 Canonicalization
 Clbits
 Cliffords
+Cliffordize
+Cliffordization
+Cliffordized
+Cliffordizing
+Cliffordizes
 Colab
 DIMACS
 Deutsches

diff --git a/scripts/config/notebook-testing.toml b/scripts/config/notebook-testing.toml
@@ -28,7 +28,6 @@ notebooks_normal_test = [
     "docs/guides/simulate-with-qiskit-aer.ipynb",
     "docs/guides/simulate-stabilizer-circuits.ipynb",
     "docs/guides/operator-class.ipynb",
-    "docs/guides/error-mitigation-and-suppression-techniques.ipynb",        
     "docs/guides/error-mitigation-and-suppression-techniques.ipynb",
     "docs/guides/serverless-first-program.ipynb",
     "docs/guides/serverless-run-first-workload.ipynb",
@@ -51,6 +50,7 @@ notebooks_exclude = [
 # The following notebooks submit jobs that can be mocked with a simulator
 notebooks_that_submit_jobs = [
     "docs/guides/primitive-input-output.ipynb",
+    "docs/guides/debug-qiskit-runtime-jobs.ipynb",
 ]
 
 # The following notebooks submit jobs that are too big to mock with a simulator (or use functions that aren't supported on sims)