From 32ce28f83d572b6fcbe56adcbdc6247ca9fe7ee2 Mon Sep 17 00:00:00 2001 From: meandmytram Date: Sat, 2 Mar 2024 16:34:48 -0500 Subject: [PATCH] update docs --- docs/source/classical_ldpc.ipynb | 9 ++++++++- docs/source/conf.py | 2 +- docs/source/csp_codes.ipynb | 11 +++++++++-- docs/source/ground_state.ipynb | 7 +++++++ docs/source/hypergraph_product.ipynb | 11 +++++++++-- docs/source/main_component.ipynb | 7 +++++++ docs/source/mps-rand-circ.ipynb | 9 ++++++++- docs/source/shor.ipynb | 7 +++++++ docs/source/toric.ipynb | 7 +++++++ 9 files changed, 63 insertions(+), 7 deletions(-) diff --git a/docs/source/classical_ldpc.ipynb b/docs/source/classical_ldpc.ipynb index b719537d..fb58909d 100644 --- 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 index 5382d333..9cadbc5b 100644 --- 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 index 674f6999..53bdd2b7 100644 --- 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 index e3ffa7f2..5ac86c06 100644 --- 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 index 6a421529..6026d81b 100644 --- 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 index 93bcd126..aa3df0af 100644 --- 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 index ea95e987..f95175ea 100644 --- 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 index cdbf3b5e..7bdce982 100644 --- 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 index ad3ad74b..226f2d35 100644 --- 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",