docs and readme cleanup

Author: lazyoracle

README.md

@@ -29,6 +29,18 @@ pip install -e .\[all\]
 jupyter notebook notebooks/
 ```
 
+## Documentation
+
+Documentation is available online at https://lazyoracle.github.io/isotropic-error-analysis/
+
+### Build local docs
+
+If you want to build and view the documentation locally, follow the steps below:
+
+1. Clone the repository using `git clone https://github.com/lazyoracle/isotropic-error-analysis`
+2. Install dependencies for docs using `pip install -e .\[docs,all\]`
+3. Build and serve a live reloading version of the docs using `mkdocs serve`
+
 ## Executive summary of concepts
 
 In quantum error models, isotropic errors are those that affect all states of the system equally, without a preferred direction in Hilbert space. For example, depolarizing noise is isotropic. A depolarizing channel replaces a qubit state with the maximally mixed state with some probability $p$. No basis or axis is privileged. The error distribution is thus uniform over possible error directions. On the other hand, independent errors are assumed to act locally and independently across different qubits or gates. For example, an independent bit-flip error model applies an $X$ operator to each qubit with probability $p$, independently of what happens to other qubits. In this case, errors are uncorrelated across subsystems.
@@ -51,3 +63,7 @@ Once we have a recipe for adding an isotropic error to a quantum state, we can s
 2. What algorithms can be analysed?
 
     As of now, only Grover's algorithm is implemented (using Qiskit) and analysed here. However, the library accepts an arbitrary quantum state and returns the perturbed quantum state, both as a standard complex array. Which means it can be integrated with any quantum programming library such as Pennylane or Qiskit or Cirq that has its own routines for statevector simulation of different quantum algorithms.
+
+3. Why does this not work on Python 3.13?
+
+    You likely ran into an issue with the build from source of the `qiskit-aer` dependency. Try installing the library without the optional `[all]` or `[algo]` flags, and then separately install `qiskit<2.0,>1.2` and `qiskit-aer<0.18,>0.15`.

docs/index.md

@@ -11,10 +11,24 @@ Broadly this involves the following steps:
 $$\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.
+## Installation
+
+You can install `isotropic` from `pip` with:
+
+```bash
+pip install isotropic
+```
+
+If you want to test the effect of isotropic errors with one of the included quantum algorithm implementations, consider installing with the `all` option as such:
+
+```bash
+pip install isotropic\[all\]
+```
 
 ## API Reference
 
+This library provides modules to perform each of the steps outlined above. See below for the API reference:
+
 - [Algorithms](algos.md)
 - [Coefficients of e2](e2.md)
 - [Orthonormal basis](orthonormal.md)

docs/thetazero.md

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

mkdocs.yml

@@ -1,4 +1,5 @@
 site_name: "isotropic"
+repo_url: https://github.com/lazyoracle/isotropic-error-analysis
 
 theme:
   name: "material"
@@ -8,10 +9,10 @@ theme:
     - content.tabs.link
     - navigation.indexes
     - navigation.footer
-    - navigation.tabs
     - navigation.top
     - search.highlight
     - search.suggest
+    - toc.follow
   language: en
   palette:
     - scheme: default

src/isotropic/thetazero.py

@@ -1,4 +1,4 @@
-"""This module contains functions for generating theta_0."""
+"""This module contains functions for generating $\\theta_0$."""
 
 from typing import Callable