Update notebooks titles

christianbmadsen · Oct 19, 2022 · 1887f41 · 1887f41
1 parent dfb6131
commit 1887f41
Show file tree

Hide file tree

Showing 10 changed files with 134 additions and 37 deletions.
diff --git a/examples/01_workflows_example.ipynb b/examples/01_workflows_example.ipynb
@@ -4,7 +4,7 @@
    "cell_type": "markdown",
    "metadata": {},
    "source": [
-    "# Introduction to OpenQAOA: An example workflow\n",
+    "# 01 -  Introduction to OpenQAOA: An example workflow\n",
     "\n",
     "This section provides a walkthrough of a simple example workflow, and is intended as a quick introduction to the functionalities of the OpenQAOA library. More focused examples are provided in other sections of the documentation.\n",
     "\n",
@@ -579,9 +579,9 @@
  ],
  "metadata": {
   "kernelspec": {
-   "display_name": "OpenQAOA_kernel",
+   "display_name": "2022_10_19_oq_dev_main",
    "language": "python",
-   "name": "openqaoa_env"
+   "name": "2022_10_19_oq_dev_main"
   },
   "language_info": {
    "codemirror_mode": {
@@ -593,7 +593,20 @@
    "name": "python",
    "nbconvert_exporter": "python",
    "pygments_lexer": "ipython3",
-   "version": "3.8.8"
+   "version": "3.8.13"
+  },
+  "toc": {
+   "base_numbering": 1,
+   "nav_menu": {},
+   "number_sections": true,
+   "sideBar": true,
+   "skip_h1_title": false,
+   "title_cell": "Table of Contents",
+   "title_sidebar": "Contents",
+   "toc_cell": false,
+   "toc_position": {},
+   "toc_section_display": true,
+   "toc_window_display": false
   },
   "vscode": {
    "interpreter": {

diff --git a/examples/02_simulators_comparison.ipynb b/examples/02_simulators_comparison.ipynb
@@ -4,7 +4,7 @@
    "cell_type": "markdown",
    "metadata": {},
    "source": [
-    "# Compare Qiskit Simulators with different simulation methods\n",
+    "# 02 - Compare Qiskit Simulators with different simulation methods\n",
     "\n",
     "This notebook is a tutorial on how to use different simulator backends to solve the same problem and compare their simulation results. This tutorial compares the performance of a perfect noise-free statvector simulator, a noise-free shot-based simulator, and finally a noisy simulator emulating a real QPU. This notebook uses qiskit simulators for each of the three categories. We employ:\n",
     "- `qiskit.statevector_simulator`\n",
@@ -313,9 +313,9 @@
    "hash": "ffc96233305d7122dc6732a5f9b7f44477470c7d091ce18c27b788d4d214d89a"
   },
   "kernelspec": {
-   "display_name": "OpenQAOA_kernel",
+   "display_name": "2022_10_19_oq_dev_main",
    "language": "python",
-   "name": "openqaoa_env"
+   "name": "2022_10_19_oq_dev_main"
   },
   "language_info": {
    "codemirror_mode": {
@@ -327,7 +327,20 @@
    "name": "python",
    "nbconvert_exporter": "python",
    "pygments_lexer": "ipython3",
-   "version": "3.8.8"
+   "version": "3.8.13"
+  },
+  "toc": {
+   "base_numbering": 1,
+   "nav_menu": {},
+   "number_sections": true,
+   "sideBar": true,
+   "skip_h1_title": false,
+   "title_cell": "Table of Contents",
+   "title_sidebar": "Contents",
+   "toc_cell": false,
+   "toc_position": {},
+   "toc_section_display": true,
+   "toc_window_display": false
   }
  },
  "nbformat": 4,

diff --git a/examples/03_qaoa_on_qpus.ipynb b/examples/03_qaoa_on_qpus.ipynb
@@ -6,7 +6,7 @@
    "source": [
     "<a id='on_qvm'></a>\n",
     "\n",
-    "# Running on the IBMQ cloud simulators, QVM or QPU\n",
+    "# 03 - Running on the IBMQ cloud simulators, QVM or QPU\n",
     "\n",
     "We have seen examples of running QAOA on mostly simulators. However, we may also want to run them on the the Pyquil's QVM, IBMQ cloud simulators or even the real QPU. We demonstrate here the usage of such devices on OpenQAOA. The cloud devices would require the user to pass a set of credentials provided by the device hosts, for instance, IBMQ credentials for devices hosted on IBMQ cloud. For running computations on Rigetti's devices the user can assign specific device specific arguments (for e.g. `as_qvm`) during the device creation. The users must also remember that they should run `qvm` and `quilc` processes on their machines to use Rigetti simulators. For more information on this, see [Rigetti's docs](https://pyquil-docs.rigetti.com/en/v2.7.0/start.html#setting-up-server-mode-for-pyquil).\n",
     "\n",

diff --git a/examples/04_qaoa_variational_parameters.ipynb b/examples/04_qaoa_variational_parameters.ipynb
@@ -4,7 +4,7 @@
    "cell_type": "markdown",
    "metadata": {},
    "source": [
-    "# Working with the QAOA Variational Parameter Classes"
+    "# 04 - Working with the QAOA Variational Parameter Classes"
    ]
   },
   {
@@ -702,20 +702,13 @@
     "\n",
     "3. Z. Wang et al, XY-mixers: analytical and numerical results for QAOA"
    ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": null,
-   "metadata": {},
-   "outputs": [],
-   "source": []
   }
  ],
  "metadata": {
   "kernelspec": {
-   "display_name": "qiskit_test",
+   "display_name": "2022_10_19_oq_dev_main",
    "language": "python",
-   "name": "qiskit"
+   "name": "2022_10_19_oq_dev_main"
   },
   "language_info": {
    "codemirror_mode": {
@@ -727,7 +720,20 @@
    "name": "python",
    "nbconvert_exporter": "python",
    "pygments_lexer": "ipython3",
-   "version": "3.8.5"
+   "version": "3.8.13"
+  },
+  "toc": {
+   "base_numbering": 1,
+   "nav_menu": {},
+   "number_sections": true,
+   "sideBar": true,
+   "skip_h1_title": false,
+   "title_cell": "Table of Contents",
+   "title_sidebar": "Contents",
+   "toc_cell": false,
+   "toc_position": {},
+   "toc_section_display": true,
+   "toc_window_display": false
   }
  },
  "nbformat": 4,

diff --git a/examples/05_advanced_parameterization.ipynb b/examples/05_advanced_parameterization.ipynb
@@ -4,7 +4,7 @@
    "cell_type": "markdown",
    "metadata": {},
    "source": [
-    "# QAOA circuit with advanced circuit parameterizations\n",
+    "# 05 - QAOA circuit with advanced circuit parameterizations\n",
     "\n",
     "Here we illustrate the use of the `Annealing` and `Fourier` parameter classes included in the OpenQAOA. Like always, we first start with importing relevant modules from OpenQAOA"
    ]
@@ -586,6 +586,19 @@
    "nbconvert_exporter": "python",
    "pygments_lexer": "ipython3",
    "version": "3.8.13"
+  },
+  "toc": {
+   "base_numbering": 1,
+   "nav_menu": {},
+   "number_sections": true,
+   "sideBar": true,
+   "skip_h1_title": false,
+   "title_cell": "Table of Contents",
+   "title_sidebar": "Contents",
+   "toc_cell": false,
+   "toc_position": {},
+   "toc_section_display": true,
+   "toc_window_display": false
   }
  },
  "nbformat": 4,

diff --git a/examples/06_fast_qaoa_simulator.ipynb b/examples/06_fast_qaoa_simulator.ipynb
@@ -4,7 +4,7 @@
    "cell_type": "markdown",
    "metadata": {},
    "source": [
-    "# Vectorized: A fast QAOA simulator for prototyping\n",
+    "# 06 - Vectorized: A fast QAOA simulator for prototyping\n",
     "\n",
     "This notebook introduces and provides some simple benchmarks (against `qiskit.AerSimulator('statevector')`) to demonstrate the ability to simulate relatively modest QAOA circuits fast."
    ]
@@ -402,9 +402,9 @@
    "hash": "ffc96233305d7122dc6732a5f9b7f44477470c7d091ce18c27b788d4d214d89a"
   },
   "kernelspec": {
-   "display_name": "OpenQAOA_kernel",
+   "display_name": "2022_10_19_oq_dev_main",
    "language": "python",
-   "name": "openqaoa_env"
+   "name": "2022_10_19_oq_dev_main"
   },
   "language_info": {
    "codemirror_mode": {
@@ -416,7 +416,20 @@
    "name": "python",
    "nbconvert_exporter": "python",
    "pygments_lexer": "ipython3",
-   "version": "3.8.8"
+   "version": "3.8.13"
+  },
+  "toc": {
+   "base_numbering": 1,
+   "nav_menu": {},
+   "number_sections": true,
+   "sideBar": true,
+   "skip_h1_title": false,
+   "title_cell": "Table of Contents",
+   "title_sidebar": "Contents",
+   "toc_cell": false,
+   "toc_position": {},
+   "toc_section_display": true,
+   "toc_window_display": false
   }
  },
  "nbformat": 4,

diff --git a/examples/07_cost_landscapes_w_manual_mode.ipynb b/examples/07_cost_landscapes_w_manual_mode.ipynb
@@ -4,7 +4,7 @@
    "cell_type": "markdown",
    "metadata": {},
    "source": [
-    "# OpenQAOA Manual Mode: Plotting Cost Landscapes\n",
+    "# 07 - OpenQAOA Manual Mode: Plotting Cost Landscapes\n",
     "\n",
     "This notebook demonstrates the use of OpenQAOA by manual object creations instead of using the pre-defined `QAOA` workflow. Defining circuit objects and backends, using this mode, we will then use these objects to plot cost landscapes of some problem for a $p=1$ circuit."
    ]
@@ -242,7 +242,7 @@
  ],
  "metadata": {
   "kernelspec": {
-   "display_name": "Python 3.8.8 ('openqaoa_env': conda)",
+   "display_name": "Python 3 (ipykernel)",
    "language": "python",
    "name": "python3"
   },
@@ -256,7 +256,20 @@
    "name": "python",
    "nbconvert_exporter": "python",
    "pygments_lexer": "ipython3",
-   "version": "3.8.8"
+   "version": "3.8.13"
+  },
+  "toc": {
+   "base_numbering": 1,
+   "nav_menu": {},
+   "number_sections": true,
+   "sideBar": true,
+   "skip_h1_title": false,
+   "title_cell": "Table of Contents",
+   "title_sidebar": "Contents",
+   "toc_cell": false,
+   "toc_position": {},
+   "toc_section_display": true,
+   "toc_window_display": false
   },
   "vscode": {
    "interpreter": {

diff --git a/examples/08_results_example.ipynb b/examples/08_results_example.ipynb
@@ -4,7 +4,7 @@
    "cell_type": "markdown",
    "metadata": {},
    "source": [
-    "# QAOA Optimization Results\n",
+    "# 08 - QAOA Optimization Results\n",
     "\n",
     "This notebook demonstrates the accessible information post QAOA optimization with the results object. The user can access different aspects of the optimization run through the results object. \n",
     "\n",
@@ -933,9 +933,9 @@
  ],
  "metadata": {
   "kernelspec": {
-   "display_name": "OpenQAOA_kernel",
+   "display_name": "2022_10_19_oq_dev_main",
    "language": "python",
-   "name": "openqaoa_env"
+   "name": "2022_10_19_oq_dev_main"
   },
   "language_info": {
    "codemirror_mode": {
@@ -947,7 +947,20 @@
    "name": "python",
    "nbconvert_exporter": "python",
    "pygments_lexer": "ipython3",
-   "version": "3.8.8"
+   "version": "3.8.13"
+  },
+  "toc": {
+   "base_numbering": 1,
+   "nav_menu": {},
+   "number_sections": true,
+   "sideBar": true,
+   "skip_h1_title": false,
+   "title_cell": "Table of Contents",
+   "title_sidebar": "Contents",
+   "toc_cell": false,
+   "toc_position": {},
+   "toc_section_display": true,
+   "toc_window_display": false
   }
  },
  "nbformat": 4,

diff --git a/examples/09_RQAOA_example.ipynb b/examples/09_RQAOA_example.ipynb
@@ -4,7 +4,7 @@
    "cell_type": "markdown",
    "metadata": {},
    "source": [
-    "# Recursive QAOA"
+    "# 09 - Recursive QAOA"
    ]
   },
   {
@@ -565,9 +565,9 @@
  ],
  "metadata": {
   "kernelspec": {
-   "display_name": "openqaoa",
+   "display_name": "2022_10_19_oq_dev_main",
    "language": "python",
-   "name": "openqaoa"
+   "name": "2022_10_19_oq_dev_main"
   },
   "language_info": {
    "codemirror_mode": {
@@ -579,7 +579,20 @@
    "name": "python",
    "nbconvert_exporter": "python",
    "pygments_lexer": "ipython3",
-   "version": "3.8.8"
+   "version": "3.8.13"
+  },
+  "toc": {
+   "base_numbering": 1,
+   "nav_menu": {},
+   "number_sections": true,
+   "sideBar": true,
+   "skip_h1_title": false,
+   "title_cell": "Table of Contents",
+   "title_sidebar": "Contents",
+   "toc_cell": false,
+   "toc_position": {},
+   "toc_section_display": true,
+   "toc_window_display": false
   }
  },
  "nbformat": 4,

diff --git a/examples/10_workflows_on_Amazon_braket.ipynb b/examples/10_workflows_on_Amazon_braket.ipynb
@@ -4,7 +4,7 @@
    "cell_type": "markdown",
    "metadata": {},
    "source": [
-    "# Introduction to OpenQAOA: An example workflow\n",
+    "# 10 - Introduction to OpenQAOA: An example workflow\n",
     "\n",
     "This section provides a walkthrough of a simple example workflow, and is intended as a quick introduction to the functionalities of the OpenQAOA library. More focused examples are provided in other sections of the documentation.\n",
     "\n",