docs first attempt

Author: lazyoracle

docs/algos.md

@@ -0,0 +1,5 @@
+# `algos`
+
+This module contains Qiskit implementations of example algorithms to analyse the effects of isotropic errors.
+
+::: isotropic.algos

docs/e2.md

@@ -0,0 +1,5 @@
+# `e2`
+
+This module contains functions to calculate the coefficients which are multipled with the orthonormal basis to make up the $e_2$ vector.
+
+::: isotropic.e2

docs/index.md

@@ -0,0 +1,22 @@
+# Welcome to `isotropic`
+
+`isotropic` is a python package for isotropic error analysis in quantum computing. The library provides a comprehensive set of tools to model and generate isotropic errors to test their effect on various quantum algorithms.
+
+Broadly this involves the following steps:
+
+1. Construct an orthonormal basis of $\Pi$ with center at $\Phi$.
+2. Generate a vector $e_2$ in $S_{d−1}$ with uniform distribution.
+3. Generate an angle $\theta_0$ in $[0,\pi]$ with density function $f(\theta_0)$.
+4. Generate the final perturbed state $\Psi$ as a rotation of $e_1 = \Phi$ by angle $\theta_0$ in the subspace spanned by the orthonormal basis $[e_1,e_2]$ using the expression
+$$\Psi = \Phi \cos(\theta_0) + e_2 \sin(\theta_0)$$
+
+
+This library provides modules to perform each of the above steps. See below for the API reference.
+
+## API Reference
+
+- [Algorithms](algos.md)
+- [Coefficients of e2](e2.md)
+- [Orthonormal basis](orthonormal.md)
+- [Theta Zero](thetazero.md)
+- [Utilities](utils.md)

docs/javascripts/katex.js

@@ -0,0 +1,10 @@
+document$.subscribe(({ body }) => {
+  renderMathInElement(body, {
+    delimiters: [
+      { left: "$$", right: "$$", display: true },
+      { left: "$", right: "$", display: false },
+      { left: "\\(", right: "\\)", display: false },
+      { left: "\\[", right: "\\]", display: true },
+    ],
+  });
+});

docs/orthonormal.md

@@ -0,0 +1,5 @@
+# `orthonormal`
+
+This module contains functions to calculate the orthonormal basis representing the hyperplane $\Pi$ that is tangential to the hypersphere $S_{d-1}$ representing the input state.
+
+::: isotropic.orthonormal

docs/thetazero.md

@@ -0,0 +1,5 @@
+# `thetazero`
+
+This module contains functions to calculate the angle theta_0 with a normal distribution.
+
+::: isotropic.thetazero

docs/utils.md

@@ -0,0 +1,5 @@
+# `utils`
+
+This module contains miscellaneous utilities useful for various steps involved in the isotropic error generation.
+
+::: isotropic.utils

mkdocs.yml

@@ -0,0 +1,52 @@
+site_name: "isotropic"
+
+theme:
+  name: "material"
+  features:
+    - content.code.annotation
+    - content.code.copy
+    - content.tabs.link
+    - navigation.indexes
+    - navigation.footer
+    - navigation.tabs
+    - navigation.top
+    - search.highlight
+    - search.suggest
+  language: en
+  palette:
+    - scheme: default
+      toggle:
+        icon: material/toggle-switch-off-outline
+        name: Switch to dark mode
+    - scheme: slate
+      toggle:
+        icon: material/toggle-switch
+        name: Switch to light mode
+
+plugins:
+- search
+- mkdocstrings:
+    handlers:
+      python:
+        options:
+          show_submodules: true
+          show_root_heading: true
+          show_symbol_type_toc: true
+          docstring_style: numpy
+
+extra_css:
+  - https://cdn.jsdelivr.net/npm/katex@0/dist/katex.min.css
+
+extra_javascript:
+  - javascripts/katex.js
+  - https://cdn.jsdelivr.net/npm/katex@0/dist/katex.min.js
+  - https://cdn.jsdelivr.net/npm/katex@0/dist/contrib/auto-render.min.js
+
+nav:
+- Home: index.md
+- API Reference:
+    - algos: algos.md
+    - e2: e2.md
+    - orthonormal: orthonormal.md
+    - thetazero: thetazero.md
+    - utils: utils.md

pyproject.toml

@@ -31,6 +31,11 @@ algo = [
     "qiskit-aer==0.15.1",
 ]
 all = ["isotropic[dev,algo]"]
+docs = [
+    "mkdocs>=1.6.1",
+    "mkdocs-material>=9.6.20",
+    "mkdocstrings-python>=1.18.2",
+]
 
 [tool.ruff]
 # Exclude a variety of commonly ignored directories.