add tags configuration + techniques/interface tags

unitaryfund · Aug 10, 2024 · 988d723 · 988d723
1 parent 277cc0d
commit 988d723
Show file tree

Hide file tree

Showing 52 changed files with 356 additions and 0 deletions.
diff --git a/docs/source/_tags/bqskit.md b/docs/source/_tags/bqskit.md
@@ -0,0 +1,10 @@
+(sphx_tag_bqskit)=
+# Tags: bqskit
+
+```{toctree}
+---
+maxdepth: 1
+caption: Pages with this tag: 
+---
+../examples/bqskit.md
+```
diff --git a/docs/source/_tags/braket.md b/docs/source/_tags/braket.md
@@ -0,0 +1,12 @@
+(sphx_tag_braket)=
+# Tags: braket
+
+```{toctree}
+---
+maxdepth: 1
+caption: Pages with this tag: 
+---
+../examples/braket_mirror_circuit.md
+../examples/simple-landscape-braket.md
+../examples/zne-braket-ionq.md
+```
diff --git a/docs/source/_tags/calibration.md b/docs/source/_tags/calibration.md
@@ -0,0 +1,10 @@
+(sphx_tag_calibration)=
+# Tags: calibration
+
+```{toctree}
+---
+maxdepth: 1
+caption: Pages with this tag: 
+---
+../examples/calibration-tutorial.md
+```
diff --git a/docs/source/_tags/cdr.md b/docs/source/_tags/cdr.md
@@ -0,0 +1,11 @@
+(sphx_tag_cdr)=
+# Tags: cdr
+
+```{toctree}
+---
+maxdepth: 1
+caption: Pages with this tag: 
+---
+../examples/cdr_qrack.md
+../examples/quantum_simulation_1d_ising.md
+```
diff --git a/docs/source/_tags/cirq.md b/docs/source/_tags/cirq.md
@@ -0,0 +1,26 @@
+(sphx_tag_cirq)=
+# Tags: cirq
+
+```{toctree}
+---
+maxdepth: 1
+caption: Pages with this tag: 
+---
+../examples/cdr_qrack.md
+../examples/cirq-ibmq-backends.md
+../examples/combine_ddd_zne.md
+../examples/combine_rem_zne.md
+../examples/ddd_tutorial.md
+../examples/hamiltonians.md
+../examples/learning-depolarizing-noise.md
+../examples/maxcut-demo.md
+../examples/molecular_hydrogen.md
+../examples/molecular_hydrogen_pennylane.md
+../examples/pec_tutorial.md
+../examples/quantum_simulation_1d_ising.md
+../examples/rshadows_tutorial.md
+../examples/scaling.md
+../examples/shadows_tutorial.md
+../examples/simple-landscape-cirq.md
+../examples/zne_logical_rb_cirq_stim.md
+```
diff --git a/docs/source/_tags/ddd.md b/docs/source/_tags/ddd.md
@@ -0,0 +1,12 @@
+(sphx_tag_ddd)=
+# Tags: ddd
+
+```{toctree}
+---
+maxdepth: 1
+caption: Pages with this tag: 
+---
+../examples/combine_ddd_zne.md
+../examples/ddd_on_ibmq_ghz.md
+../examples/ddd_tutorial.md
+```
diff --git a/docs/source/_tags/ionq.md b/docs/source/_tags/ionq.md
@@ -0,0 +1,10 @@
+(sphx_tag_ionq)=
+# Tags: ionq
+
+```{toctree}
+---
+maxdepth: 1
+caption: Pages with this tag: 
+---
+../examples/zne-braket-ionq.md
+```
diff --git a/docs/source/_tags/pec.md b/docs/source/_tags/pec.md
@@ -0,0 +1,11 @@
+(sphx_tag_pec)=
+# Tags: pec
+
+```{toctree}
+---
+maxdepth: 1
+caption: Pages with this tag: 
+---
+../examples/learning-depolarizing-noise.md
+../examples/pec_tutorial.md
+```
diff --git a/docs/source/_tags/pennylane.md b/docs/source/_tags/pennylane.md
@@ -0,0 +1,12 @@
+(sphx_tag_pennylane)=
+# Tags: pennylane
+
+```{toctree}
+---
+maxdepth: 1
+caption: Pages with this tag: 
+---
+../examples/molecular_hydrogen_pennylane.md
+../examples/pennylane-ibmq-backends.md
+../examples/simple-landscape-pennylane.md
+```
diff --git a/docs/source/_tags/qibo.md b/docs/source/_tags/qibo.md
@@ -0,0 +1,10 @@
+(sphx_tag_qibo)=
+# Tags: qibo
+
+```{toctree}
+---
+maxdepth: 1
+caption: Pages with this tag: 
+---
+../examples/qibo-noisy-simulation.md
+```
diff --git a/docs/source/_tags/qiskit.md b/docs/source/_tags/qiskit.md
@@ -0,0 +1,21 @@
+(sphx_tag_qiskit)=
+# Tags: qiskit
+
+```{toctree}
+---
+maxdepth: 1
+caption: Pages with this tag: 
+---
+../examples/calibration-tutorial.md
+../examples/cdr_qrack.md
+../examples/cirq-ibmq-backends.md
+../examples/ddd_on_ibmq_ghz.md
+../examples/ggi_summer_school_solved.md
+../examples/ggi_summer_school_unsolved.md
+../examples/ibmq-backends.md
+../examples/layerwise-folding.md
+../examples/pec_tutorial.md
+../examples/pennylane-ibmq-backends.md
+../examples/quantum_simulation_scars_ibmq.md
+../examples/simple-landscape-qiskit.md
+```
diff --git a/docs/source/_tags/qrack.md b/docs/source/_tags/qrack.md
@@ -0,0 +1,10 @@
+(sphx_tag_qrack)=
+# Tags: qrack
+
+```{toctree}
+---
+maxdepth: 1
+caption: Pages with this tag: 
+---
+../examples/cdr_qrack.md
+```
diff --git a/docs/source/_tags/rem.md b/docs/source/_tags/rem.md
@@ -0,0 +1,10 @@
+(sphx_tag_rem)=
+# Tags: rem
+
+```{toctree}
+---
+maxdepth: 1
+caption: Pages with this tag: 
+---
+../examples/combine_rem_zne.md
+```
diff --git a/docs/source/_tags/shadows.md b/docs/source/_tags/shadows.md
@@ -0,0 +1,11 @@
+(sphx_tag_shadows)=
+# Tags: shadows
+
+```{toctree}
+---
+maxdepth: 1
+caption: Pages with this tag: 
+---
+../examples/rshadows_tutorial.md
+../examples/shadows_tutorial.md
+```
diff --git a/docs/source/_tags/stim.md b/docs/source/_tags/stim.md
@@ -0,0 +1,10 @@
+(sphx_tag_stim)=
+# Tags: stim
+
+```{toctree}
+---
+maxdepth: 1
+caption: Pages with this tag: 
+---
+../examples/zne_logical_rb_cirq_stim.md
+```
diff --git a/docs/source/_tags/tagsindex.md b/docs/source/_tags/tagsindex.md
@@ -0,0 +1,26 @@
+(tagoverview)=
+
+# All tags
+
+```{toctree}
+---
+caption: Tags in the documentation tutorials: 
+maxdepth: 1
+---
+bqskit (1) <bqskit>
+braket (3) <braket>
+calibration (1) <calibration>
+cdr (2) <cdr>
+cirq (17) <cirq>
+ddd (3) <ddd>
+ionq (1) <ionq>
+pec (2) <pec>
+pennylane (3) <pennylane>
+qibo (1) <qibo>
+qiskit (12) <qiskit>
+qrack (1) <qrack>
+rem (1) <rem>
+shadows (2) <shadows>
+stim (1) <stim>
+zne (25) <zne>
+```
diff --git a/docs/source/_tags/zne.md b/docs/source/_tags/zne.md
@@ -0,0 +1,34 @@
+(sphx_tag_zne)=
+# Tags: zne
+
+```{toctree}
+---
+maxdepth: 1
+caption: Pages with this tag: 
+---
+../examples/bqskit.md
+../examples/braket_mirror_circuit.md
+../examples/calibration-tutorial.md
+../examples/cirq-ibmq-backends.md
+../examples/combine_ddd_zne.md
+../examples/combine_rem_zne.md
+../examples/ggi_summer_school_solved.md
+../examples/ggi_summer_school_unsolved.md
+../examples/hamiltonians.md
+../examples/ibmq-backends.md
+../examples/layerwise-folding.md
+../examples/maxcut-demo.md
+../examples/molecular_hydrogen.md
+../examples/molecular_hydrogen_pennylane.md
+../examples/pennylane-ibmq-backends.md
+../examples/qibo-noisy-simulation.md
+../examples/quantum_simulation_1d_ising.md
+../examples/quantum_simulation_scars_ibmq.md
+../examples/scaling.md
+../examples/simple-landscape-braket.md
+../examples/simple-landscape-cirq.md
+../examples/simple-landscape-pennylane.md
+../examples/simple-landscape-qiskit.md
+../examples/zne-braket-ionq.md
+../examples/zne_logical_rb_cirq_stim.md
+```
diff --git a/docs/source/conf.py b/docs/source/conf.py
@@ -98,8 +98,20 @@ def setup(app):
     "sphinx_copybutton",
     "nbsphinx",
     "sphinx_gallery.load_style",
+    "sphinx_design",
+    "sphinx_tags",
 ]
 
+# to add tags to the documentation tutorials
+tags_create_tags = True
+tags_overview_title = "All tags"
+tags_create_badges = True
+tags_intro_text = "Tags on this page: " 
+tags_page_title = "Tags" 
+tags_page_header = "Pages with this tag: "
+tags_index_head = "Tags in the documentation tutorials: "
+tags_extension = ["md"]
+
 # hide primary sidebar from the following pages
 html_sidebars = {"apidoc": [], "changelog": [], "bibliography": []}
 

diff --git a/docs/source/examples/bqskit.md b/docs/source/examples/bqskit.md
@@ -10,6 +10,9 @@ kernelspec:
   name: python3
 ---
 
+```{tags} bqskit, zne
+```
+
 # Improving the accuracy of BQSKit compiled circuits with error mitigation
 
 In this tutorial we describe how to use error mitigation capabilities from [Mitiq](https://mitiq.readthedocs.io/en/stable/) together with the compilation capabilities of [BQSKit](https://bqskit.lbl.gov/) {cite}`Patel_2022_ACM`, a compiler for quantum circuits. BQSKit stands for Berkeley Quantum Synthesis Toolkit and it allows one "to compile quantum programs to efficient physical circuits for any QPU".

diff --git a/docs/source/examples/braket_mirror_circuit.md b/docs/source/examples/braket_mirror_circuit.md
@@ -11,6 +11,9 @@ kernelspec:
   name: python3
 ---
 
+```{tags} braket, zne
+```
+
 # Mitiq with Braket
 
 This notebook shows improved performance on a mirror circuit benchmark with zero-noise extrapolation on Rigetti Aspen-9 via Amazon Braket.

diff --git a/docs/source/examples/calibration-tutorial.md b/docs/source/examples/calibration-tutorial.md
@@ -12,6 +12,9 @@ kernelspec:
   name: python3
 ---
 
+```{tags} calibration, zne, qiskit
+```
+
 # Breaking into error mitigation with Mitiq's calibration module
 
 <img src="../_thumbnails/calibration.png" width="400">

diff --git a/docs/source/examples/cdr_qrack.md b/docs/source/examples/cdr_qrack.md
@@ -12,6 +12,9 @@ kernelspec:
   name: python3
 ---
 
+```{tags} qiskit, cdr, qrack, cirq
+```
+
 # CDR with Qrack as Near-Clifford Simulator
 
 In this tutorial, [Clifford Data Regression](../guide/cdr.md) (CDR) is used with [Qrack](https://qrack.readthedocs.io/en/latest/) and a Qiskit fake backend.

diff --git a/docs/source/examples/cirq-ibmq-backends.md b/docs/source/examples/cirq-ibmq-backends.md
@@ -11,6 +11,9 @@ kernelspec:
   name: python3
 ---
 
+```{tags} cirq, zne, qiskit
+```
+
 # Error mitigation with Cirq on IBMQ backends
 
 

diff --git a/docs/source/examples/combine_ddd_zne.md b/docs/source/examples/combine_ddd_zne.md
@@ -11,6 +11,8 @@ kernelspec:
   language: python
   name: python3
 ---
+```{tags} ddd, zne, cirq
+```
 
 # Composing techniques: Digital Dynamical Decoupling and Zero Noise Extrapolation
 

diff --git a/docs/source/examples/combine_rem_zne.md b/docs/source/examples/combine_rem_zne.md
@@ -11,6 +11,8 @@ kernelspec:
   language: python
   name: python3
 ---
+```{tags} rem, zne, cirq
+```
 
 # Composing techniques: Readout Error Mitigation and Zero Noise Extrapolation
 

diff --git a/docs/source/examples/ddd_on_ibmq_ghz.md b/docs/source/examples/ddd_on_ibmq_ghz.md
@@ -11,6 +11,8 @@ kernelspec:
   language: python
   name: python3
 ---
+```{tags} ddd, qiskit
+```
 
 # Digital dynamical decoupling (DDD) with Qiskit on GHZ Circuits
 

diff --git a/docs/source/examples/ddd_tutorial.md b/docs/source/examples/ddd_tutorial.md
@@ -10,6 +10,8 @@ kernelspec:
   language: python
   name: python3
 ---
+```{tags} ddd, cirq
+```
 
 # Digital dynamical decoupling (DDD) with Mirror Circuits
 

diff --git a/docs/source/examples/examples.md b/docs/source/examples/examples.md
@@ -38,3 +38,12 @@ Composing techniques: REM + ZNE <combine_rem_zne.md>
 Composing techniques: DDD + ZNE <combine_ddd_zne.md>
 The Mitiq paper code <mitiq-paper/mitiq-paper-codeblocks.md>
 ```
+
+You can also search for a specific example by clicking on one of the tags below:
+
+```{toctree}
+---
+maxdepth: 2
+---
+../../_tags/tagsindex.md
+```
diff --git a/docs/source/examples/ggi_summer_school_solved.md b/docs/source/examples/ggi_summer_school_solved.md
@@ -11,6 +11,8 @@ kernelspec:
   name: python3
 orphan: true
 ---
+```{tags} qiskit, zne
+```
 
 # Solution to hands-on lab on error mitigation with Mitiq.