update docs

quicophy · Mar 2, 2024 · 32ce28f · 32ce28f
1 parent ac26710
commit 32ce28f
Show file tree

Hide file tree

Showing 9 changed files with 63 additions and 7 deletions.
diff --git a/docs/source/classical_ldpc.ipynb b/docs/source/classical_ldpc.ipynb
@@ -1,5 +1,12 @@
 {
  "cells": [
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "# Decoding a classical LDPC code"
+   ]
+  },
   {
    "attachments": {},
    "cell_type": "markdown",
@@ -971,7 +978,7 @@
    "name": "python",
    "nbconvert_exporter": "python",
    "pygments_lexer": "ipython3",
-   "version": "3.11.5"
+   "version": "3.11.8"
   },
   "orig_nbformat": 4,
   "vscode": {

diff --git a/docs/source/conf.py b/docs/source/conf.py
@@ -26,7 +26,7 @@
 author = "Aleksandr Berezutskii"
 
 # The full version, including alpha/beta/rc tags
-release = "0.3.0"
+release = "0.5.0"
 
 
 # -- General configuration ---------------------------------------------------

diff --git a/docs/source/csp_codes.ipynb b/docs/source/csp_codes.ipynb
@@ -1,8 +1,15 @@
 {
  "cells": [
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "# Decoding CSP quantum error correcting codes"
+   ]
+  },
   {
    "cell_type": "code",
-   "execution_count": 1,
+   "execution_count": null,
    "metadata": {},
    "outputs": [],
    "source": [
@@ -201,7 +208,7 @@
    "name": "python",
    "nbconvert_exporter": "python",
    "pygments_lexer": "ipython3",
-   "version": "3.11.5"
+   "version": "3.11.8"
   },
   "orig_nbformat": 4
  },

diff --git a/docs/source/ground_state.ipynb b/docs/source/ground_state.ipynb
@@ -1,5 +1,12 @@
 {
  "cells": [
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "# Ground state search for a 1D quantum Ising model"
+   ]
+  },
   {
    "attachments": {},
    "cell_type": "markdown",

diff --git a/docs/source/hypergraph_product.ipynb b/docs/source/hypergraph_product.ipynb
@@ -1,8 +1,15 @@
 {
  "cells": [
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "# Decoding Hypergraph Product Code"
+   ]
+  },
   {
    "cell_type": "code",
-   "execution_count": 1,
+   "execution_count": null,
    "metadata": {},
    "outputs": [],
    "source": [
@@ -220,7 +227,7 @@
    "name": "python",
    "nbconvert_exporter": "python",
    "pygments_lexer": "ipython3",
-   "version": "3.11.5"
+   "version": "3.11.8"
   },
   "orig_nbformat": 4
  },

diff --git a/docs/source/main_component.ipynb b/docs/source/main_component.ipynb
@@ -1,5 +1,12 @@
 {
  "cells": [
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "# The main component problem"
+   ]
+  },
   {
    "attachments": {},
    "cell_type": "markdown",

diff --git a/docs/source/mps-rand-circ.ipynb b/docs/source/mps-rand-circ.ipynb
@@ -1,5 +1,12 @@
 {
  "cells": [
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "# Random circuit simulation"
+   ]
+  },
   {
    "cell_type": "markdown",
    "metadata": {},
@@ -385,7 +392,7 @@
    "name": "python",
    "nbconvert_exporter": "python",
    "pygments_lexer": "ipython3",
-   "version": "3.11.5"
+   "version": "3.11.8"
   },
   "orig_nbformat": 4
  },

diff --git a/docs/source/shor.ipynb b/docs/source/shor.ipynb
@@ -1,5 +1,12 @@
 {
  "cells": [
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "# Decoding Shor's code"
+   ]
+  },
   {
    "attachments": {},
    "cell_type": "markdown",

diff --git a/docs/source/toric.ipynb b/docs/source/toric.ipynb
@@ -1,5 +1,12 @@
 {
  "cells": [
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "# Decoding the Shor's code"
+   ]
+  },
   {
    "attachments": {},
    "cell_type": "markdown",