feature: updates to error mitigation examples

.github/workflows/python-package.yml

@@ -43,3 +43,7 @@ jobs:
     - name: Run integ tests
       run: |
         hatch run test -p no:cacheprovider
+    - name: Run optional tests
+      if: ${{ matrix.python-version != '3.10' && matrix.python-version != '3.13' }}
+      run: |
+        hatch run test-mitiq:test

README.md

@@ -229,6 +229,30 @@ Welcome to the primary repository for Amazon Braket examples and tutorials. Lear
 
   This tutorial serves as an introduction to the local emulator for validating and debugging verbatim circuits for gate-based devices. This tutorial explains how to instantiate local emulator from up-to-date device calibration data and customize it for emulating verbatim circuits locally.
 
+-  [**Getting started with mitiq on Braket**](examples/error_mitigation/on_mitiq/0_Getting_started_with_mitiq_on_Braket.ipynb) [(GSm)](#index_GSm)<a name="GSm"></a>
+
+  This tutorial introduces the mitiq library and how you can utilize it with Amazon Braket.
+
+-  [**Readout mitigation with mitiq**](examples/error_mitigation/on_mitiq/1_Readout_mitigation_with_mitiq.ipynb) [(REMm)](#index_REMm)<a name="REMm"></a>
+
+  This tutorial shows how to use mitiq's readout error mitigation capabilities with Amazon Braket.
+
+-  [**Zero noise extrapolation with mitiq**](examples/error_mitigation/on_mitiq/2_Zero_noise_extrapolation_with_mitiq.ipynb) [(ZNEm)](#index_ZNEm)<a name="ZNEm"></a>
+
+  This tutorial shows how to use mitiq's zero noise extrapolation capabilities with Amazon Braket.
+
+-  [**Twirling with program sets**](examples/error_mitigation/on_mitiq/3_Twirling_with_program_sets.ipynb) [(TPS)](#index_TPS)<a name="TPS"></a>
+
+  This tutorial shows how to use mitiq's Pauli twirling capabilities with Amazon Braket.
+
+-  [**Error mitigation workflow with mitiq**](examples/error_mitigation/on_mitiq/4_Error_mitigation_workflow_with_mitiq.ipynb) [(EMWm)](#index_EMWm)<a name="EMWm"></a>
+
+  This tutorial shows how to perform an error mitigation workflow using mitiq with Amazon Braket.
+
+-  [**Advanced QPU error mitigation workflow**](examples/error_mitigation/supplemental/Advanced_QPU_workflow.ipynb) [(AQEMW)](#index_AQEMW)<a name="AQEMW"></a>
+
+  This tutorial introduces the mitiq library
+
 
 ---
 
@@ -519,7 +543,7 @@ Welcome to the primary repository for Amazon Braket examples and tutorials. Lear
 
 -  [**Compiling Braket circuits with the Qiskit-Braket provider**](examples/qiskit/1_Compilation_with_the_Qiskit_Braket_provider.ipynb) [(CBQBP)](#index_CBQBP)<a name="CBQBP"></a>
 
-  This tutorial shows how to compile Braket circuits using the to_braket Qiskit-Braket provider, allowing for compilation using Qiskit.
+  This tutorial shows how to compile Braket circuits using the to_braket Qiskit-Braket provider, allowing for circuit compilation.
 
 ## <a name="index">Index</a> 
  |  Terms  | Notebooks  | 
@@ -544,26 +568,28 @@ Welcome to the primary repository for Amazon Braket examples and tutorials. Lear
  | devices    |  [NM](#NM), [AQQD](#AQQD), [GDCDP](#GDCDP), [NGC](#NGC), [LEmu](#LEmu)| <br>
  | dynamic circuits |  [DCOQ3](#DCOQ3)<a name="index_DCOQ3"></a>| <br>
  | emulator   |  [LEmu](#LEmu)| <br>
+ | error mitigation |  [GSm](#GSm)<a name="index_GSm"></a>, [REMm](#REMm)<a name="index_REMm"></a>, [EMWm](#EMWm)<a name="index_EMWm"></a>, [AQEMW](#AQEMW)<a name="index_AQEMW"></a>, [EMIQ](#EMIQ)<a name="index_EMIQ"></a>, [ZNEm](#ZNEm)<a name="index_ZNEm"></a>, [TPS](#TPS)<a name="index_TPS"></a>| <br>
  | estimators |  [EVPrS](#EVPrS)| <br>
  | gates      |  [IQMNG](#IQMNG)<a name="index_IQMNG"></a>, [BSQG](#BSQG)<a name="index_BSQG"></a>| <br>
  | gpus       |  [PTQML](#PTQML)<a name="index_PTQML"></a>, [SQPG](#SQPG), [PSG](#PSG), [DSVSG](#DSVSG)| <br>
  | graph      |  [MIS](#MIS), [MWIS](#MWIS)| <br>
- | hamiltonian |  [QAOA](#QAOA)<a name="index_QAOA"></a>, [VQEChem](#VQEChem), [VQETFIM](#VQETFIM)<a name="index_VQETFIM"></a>, [NQD](#NQD), [QNES](#QNES)<a name="index_QNES"></a>, [GOQ](#GOQ)<a name="index_GOQ"></a>, [HGV](#HGV), [AGC](#AGC), [GSAHS](#GSAHS), [GSA](#GSA), [OPRS](#OPRS), [PTA](#PTA), [MIS](#MIS), [RLS](#RLS), [SPL](#SPL), [SLGRA](#SLGRA), [MWIS](#MWIS), [PSG](#PSG), [GSPrS](#GSPrS)<a name="index_GSPrS"></a>, [EVPrS](#EVPrS)| <br>
+ | hamiltonian |  [QAOA](#QAOA)<a name="index_QAOA"></a>, [VQEChem](#VQEChem), [VQETFIM](#VQETFIM)<a name="index_VQETFIM"></a>, [NQD](#NQD), [QNES](#QNES)<a name="index_QNES"></a>, [GOQ](#GOQ)<a name="index_GOQ"></a>, [HGV](#HGV), [AGC](#AGC), [GSAHS](#GSAHS), [GSA](#GSA), [OPRS](#OPRS), [PTA](#PTA), [MIS](#MIS), [RLS](#RLS), [SPL](#SPL), [SLGRA](#SLGRA), [MWIS](#MWIS), [PSG](#PSG), [GSPrS](#GSPrS)<a name="index_GSPrS"></a>, [EVPrS](#EVPrS), [EMWm](#EMWm), [AQEMW](#AQEMW)| <br>
  | hybrid job |  [GSHJ](#GSHJ), [QMLHJ](#QMLHJ)<a name="index_QMLHJ"></a>, [QHJP](#QHJP)<a name="index_QHJP"></a>, [BYOC](#BYOC), [ESHJ](#ESHJ), [PTQML](#PTQML), [QNES](#QNES), [RJNHJ](#RJNHJ)<a name="index_RJNHJ"></a>, [CHJS](#CHJS), [CPL](#CPL)<a name="index_CPL"></a>, [GOQ](#GOQ), [HGV](#HGV), [HCQJ](#HCQJ), [SQPG](#SQPG)| <br>
- | ionq       |  [RQCQ](#RQCQ), [VC](#VC), [RNG](#RNG)<a name="index_RNG"></a>, [EMIQ](#EMIQ)<a name="index_EMIQ"></a>, [IonNG](#IonNG)<a name="index_IonNG"></a>, [GDCDP](#GDCDP)| <br>
+ | ionq       |  [RQCQ](#RQCQ), [VC](#VC), [RNG](#RNG)<a name="index_RNG"></a>, [EMIQ](#EMIQ), [IonNG](#IonNG)<a name="index_IonNG"></a>, [GDCDP](#GDCDP)| <br>
  | iqm        |  [RQCQ](#RQCQ), [VC](#VC), [Grover](#Grover), [IQMNG](#IQMNG), [GSDCI](#GSDCI)<a name="index_GSDCI"></a>, [DCC](#DCC), [HNDC](#HNDC), [OQSDC](#OQSDC)<a name="index_OQSDC"></a>| <br>
  | job        |  [RQCQ](#RQCQ), [GSHJ](#GSHJ), [QMLHJ](#QMLHJ), [QHJP](#QHJP), [BYOC](#BYOC), [ESHJ](#ESHJ), [PTQML](#PTQML), [QNES](#QNES), [RJNHJ](#RJNHJ), [CHJS](#CHJS), [CPL](#CPL), [GOQ](#GOQ), [HGV](#HGV), [HCQJ](#HCQJ), [SQPG](#SQPG), [PSG](#PSG), [DSVSG](#DSVSG), [IntroSL](#IntroSL)| <br>
  | kraus      |  [GSOQ](#GSOQ), [SN](#SN)<a name="index_SN"></a>, [SNCP](#SNCP)<a name="index_SNCP"></a>| <br>
  | local simulator |  [RQCS](#RQCS)<a name="index_RQCS"></a>, [ExpLS](#ExpLS)<a name="index_ExpLS"></a>, [ESHJ](#ESHJ), [CGPPL](#CGPPL)<a name="index_CGPPL"></a>, [RLS](#RLS), [SPL](#SPL)| <br>
+ | mitiq      |  [GSm](#GSm), [REMm](#REMm), [ZNEm](#ZNEm), [TPS](#TPS), [EMWm](#EMWm)| <br>
  | model      |  [VQETFIM](#VQETFIM)| <br>
  | moments    |  [DDQC](#DDQC)<a name="index_DDQC"></a>| <br>
  | native gates |  [VC](#VC), [IQMNG](#IQMNG), [IonNG](#IonNG), [LEmu](#LEmu)| <br>
- | noise      |  [GSOQ](#GSOQ), [RNG](#RNG), [SN](#SN), [NM](#NM), [NM](#NM), [NQD](#NQD), [SNCP](#SNCP), [LEmu](#LEmu)| <br>
+ | noise      |  [GSOQ](#GSOQ), [RNG](#RNG), [SN](#SN), [NM](#NM), [NM](#NM), [NQD](#NQD), [SNCP](#SNCP), [ZNEm](#ZNEm), [LEmu](#LEmu)| <br>
  | open quantum systems |  [GSOQ](#GSOQ), [SN](#SN), [SNCP](#SNCP), [OQSDC](#OQSDC)| <br>
  | openqasm   |  [GSOQ](#GSOQ), [AOQLS](#AOQLS)<a name="index_AOQLS"></a>, [DCOQ3](#DCOQ3)| <br>
  | optimization |  [QNES](#QNES), [GOQ](#GOQ), [MIS](#MIS), [MWIS](#MWIS)| <br>
  | parallel   |  [CGPPL](#CGPPL), [SQPG](#SQPG), [PSG](#PSG), [DSVSG](#DSVSG)| <br>
- | parameters |  [DDQC](#DDQC), [QAOA](#QAOA), [BE](#BE)<a name="index_BE"></a>, [NGC](#NGC), [BSQG](#BSQG)| <br>
+ | parameters |  [DDQC](#DDQC), [QAOA](#QAOA), [BE](#BE)<a name="index_BE"></a>, [NGC](#NGC), [BSQG](#BSQG), [EMWm](#EMWm)| <br>
  | pauli operators |  [EVPrS](#EVPrS)| <br>
  | pennylane  |  [GSHJ](#GSHJ), [QHJP](#QHJP), [BYOC](#BYOC), [ESHJ](#ESHJ), [PTQML](#PTQML), [QNES](#QNES), [CHJS](#CHJS), [CPL](#CPL), [CGPPL](#CGPPL), [GOQ](#GOQ), [HGV](#HGV), [SNCP](#SNCP), [TRU](#TRU), [AGC](#AGC), [SPL](#SPL)| <br>
  | physics    |  [VQETFIM](#VQETFIM), [SLGRA](#SLGRA)| <br>
@@ -572,13 +598,14 @@ Welcome to the primary repository for Amazon Braket examples and tutorials. Lear
  | pulse      |  [BE](#BE), [NGC](#NGC), [BPPR](#BPPR), [BSQG](#BSQG), [SPL](#SPL)| <br>
  | qaa        |  [QAA](#QAA)<a name="index_QAA"></a>| <br>
  | qaoa       |  [AGRT](#AGRT), [QAOA](#QAOA), [QHJP](#QHJP), [ESHJ](#ESHJ), [QNES](#QNES), [GOQ](#GOQ), [SNCP](#SNCP)| <br>
- | qiskit     |  [Qis](#Qis)<a name="index_Qis"></a>, [DCQis](#DCQis)<a name="index_DCQis"></a>, [CBQBP](#CBQBP)| <br>
+ | qiskit     |  [Qis](#Qis)<a name="index_Qis"></a>, [DCQis](#DCQis)<a name="index_DCQis"></a>, [GSm](#GSm), [REMm](#REMm), [ZNEm](#ZNEm), [AQEMW](#AQEMW), [CBQBP](#CBQBP)| <br>
  | qml        |  [QMLHJ](#QMLHJ)| <br>
  | qpe        |  [QPE](#QPE)<a name="index_QPE"></a>| <br>
+ | rem        |  [EMWm](#EMWm), [AQEMW](#AQEMW)| <br>
  | reset      |  [GSDCI](#GSDCI), [DCC](#DCC), [HNDC](#HNDC)| <br>
  | result type |  [AGRT](#AGRT)| <br>
  | results    |  [DDQC](#DDQC), [GSOQ](#GSOQ), [AGRT](#AGRT), [QFT](#QFT)<a name="index_QFT"></a>, [GSPrS](#GSPrS), [LEmu](#LEmu)| <br>
- | rigetti    |  [RQCQ](#RQCQ), [GSOQ](#GSOQ), [VC](#VC), [RNG](#RNG), [NM](#NM), [AQQD](#AQQD), [BE](#BE), [BPPR](#BPPR), [CPL](#CPL), [LEmu](#LEmu)| <br>
+ | rigetti    |  [RQCQ](#RQCQ), [GSOQ](#GSOQ), [VC](#VC), [RNG](#RNG), [NM](#NM), [AQQD](#AQQD), [BE](#BE), [BPPR](#BPPR), [CPL](#CPL), [LEmu](#LEmu), [AQEMW](#AQEMW)| <br>
  | rydberg    |  [NQD](#NQD), [GSAHS](#GSAHS), [GSA](#GSA), [OPRS](#OPRS), [PTA](#PTA), [MIS](#MIS), [RLS](#RLS), [SPL](#SPL), [SLGRA](#SLGRA), [MWIS](#MWIS)| <br>
  | s3         |  [GNQT](#GNQT)<a name="index_GNQT"></a>, [CHJS](#CHJS)| <br>
  | shots      |  [GSPrS](#GSPrS)| <br>
@@ -588,8 +615,10 @@ Welcome to the primary repository for Amazon Braket examples and tutorials. Lear
  | superdense |  [SC](#SC)| <br>
  | task       |  [RQCQ](#RQCQ), [SC](#SC), [DDQC](#DDQC), [GSOQ](#GSOQ), [GNQT](#GNQT), [Grover](#Grover), [RNG](#RNG), [TNSim](#TNSim), [TNHP](#TNHP), [GSHJ](#GSHJ), [CHJS](#CHJS), [AQQD](#AQQD), [CPL](#CPL), [TRU](#TRU), [AGC](#AGC), [GSA](#GSA), [PTA](#PTA)| <br>
  | teleportation |  [SC](#SC), [DCC](#DCC)| <br>
- | verbatim   |  [GSOQ](#GSOQ), [VC](#VC), [IQMNG](#IQMNG), [HNDC](#HNDC), [LEmu](#LEmu)| <br>
+ | twirling   |  [TPS](#TPS), [EMWm](#EMWm), [AQEMW](#AQEMW)| <br>
+ | verbatim   |  [GSOQ](#GSOQ), [VC](#VC), [IQMNG](#IQMNG), [HNDC](#HNDC), [LEmu](#LEmu), [GSm](#GSm), [AQEMW](#AQEMW)| <br>
  | vqe        |  [VQEChem](#VQEChem), [VQETFIM](#VQETFIM), [HGV](#HGV), [AGC](#AGC), [Qis](#Qis)| <br>
+ | zne        |  [EMWm](#EMWm), [AQEMW](#AQEMW)| <br>
 
 ---
 

TESTING.md

@@ -96,3 +96,18 @@ To ensure this process works correctly:
 
 Following this convention allows the integration test system to selectively and safely test example notebooks without risking unintended costly runs in normal usage.
 
+## Troubleshooting testing
+
+The tests may fail due to version conflicts. If necessary, update your repository to the latest, run 
+``` 
+hatch env prune 
+hatch env create default
+```
+
+## Testing `mitiq` examples
+
+The mitiq examples exist in their own hatch environment. To run them, use:
+```
+hatch env create mitiq-test 
+hatch run test-mitiq:test
+```

docs/ENTRIES.json

@@ -36,7 +36,7 @@
     },
     "Getting Started with OpenQASM on Braket": {
         "index_abbrv": "GSOQ",
-        "index_terms" : [], 
+        "index_terms" : ["rigetti"], 
         "categories": ["braket"],
         "location": "examples/braket_features/Getting_Started_with_OpenQASM_on_Braket.ipynb",
         "content": "  This tutorial demonstrates how to submit OpenQASM quantum tasks to various devices on Braket and introduce some OpenQASM features available on Braket. OpenQASM is a popular, open source, human-readable and hardware-agnostic quantum circuit description language."
@@ -162,7 +162,7 @@
     },
     "Error Mitigation on IonQ": {
         "index_abbrv": "EMIQ",
-        "index_terms" : [], 
+        "index_terms" : ["error mitigation"], 
         "categories": ["noise","ionq"],
         "location": "examples/braket_features/Error_Mitigation_on_Amazon_Braket.ipynb",
         "content": "  This tutorial explains how to get started with using error mitigation on IonQ\u2019s Aria QPU. You\u2019ll learn how Aria\u2019s two built-in error mitigation techniques work, how to switch between them, and the performance difference you can expect to see with and without these techniques for some problems."
@@ -517,6 +517,48 @@
         "location"   : "examples/braket_features/program_sets/02_Expectation_value_calculations_with_program_sets.ipynb",
         "content"    : "  Amazon Braket program sets make it easier to implement an intelligent shot allocation strategy, which is particularly beneficial for algorithms like the Variational Quantum Eigensolver (VQE). This approach maintains the same total shot budget while significantly improving statistical accuracy in expectation value estimates."
     },
+    "Getting started with mitiq on Braket": {
+        "index_abbrv" : "GSm",
+        "index_terms": ["mitiq", "error mitigation"],
+        "categories" : ["noise"],
+        "location"   : "examples/error_mitigation/on_mitiq/0_Getting_started_with_mitiq_on_Braket.ipynb",
+        "content"    : "  This tutorial introduces the mitiq library and how you can utilize it with Amazon Braket."
+    },
+    "Readout mitigation with mitiq": {
+        "index_abbrv" : "REMm",
+        "index_terms": ["mitiq", "error mitigation"],
+        "categories" : ["noise"],
+        "location"   : "examples/error_mitigation/on_mitiq/1_Readout_mitigation_with_mitiq.ipynb",
+        "content"    : "  This tutorial shows how to use mitiq's readout error mitigation capabilities with Amazon Braket."
+    },
+    "Zero noise extrapolation with mitiq": {
+        "index_abbrv" : "ZNEm",
+        "index_terms": ["mitiq", "error mitigation"],
+        "categories" : ["noise"],
+        "location"   : "examples/error_mitigation/on_mitiq/2_Zero_noise_extrapolation_with_mitiq.ipynb",
+        "content"    : "  This tutorial shows how to use mitiq's zero noise extrapolation capabilities with Amazon Braket."
+    },
+    "Twirling with program sets": {
+        "index_abbrv" : "TPS",
+        "index_terms": ["mitiq", "error mitigation", "twirling"],
+        "categories" : ["noise"],
+        "location"   : "examples/error_mitigation/on_mitiq/3_Twirling_with_program_sets.ipynb",
+        "content"    : "  This tutorial shows how to use mitiq's Pauli twirling capabilities with Amazon Braket."
+    },
+    "Error mitigation workflow with mitiq": {
+        "index_abbrv" : "EMWm",
+        "index_terms": ["mitiq", "error mitigation", "zne", "rem", "twirling"],
+        "categories" : ["noise"],
+        "location"   : "examples/error_mitigation/on_mitiq/4_Error_mitigation_workflow_with_mitiq.ipynb",
+        "content"    : "  This tutorial shows how to perform an error mitigation workflow using mitiq with Amazon Braket."
+    },
+    "Advanced QPU error mitigation workflow": {
+        "index_abbrv" : "AQEMW",
+        "index_terms": ["rigetti", "error mitigation", "zne", "rem", "twirling"],
+        "categories" : ["noise"],
+        "location"   : "examples/error_mitigation/supplemental/Advanced_QPU_workflow.ipynb",
+        "content"    : "  This tutorial introduces the mitiq library"
+    },
     "Introduction to Amazon Braket spending limits": {
         "index_abbrv" : "IntroSL",
         "index_terms": [],