diff --git a/.gitignore b/.gitignore index 61d1dcd..be84bc9 100644 --- a/.gitignore +++ b/.gitignore @@ -1,3 +1,4 @@ +scripts/ chp/ .venv .anders diff --git a/README.md b/README.md index f21961e..f618caa 100644 --- a/README.md +++ b/README.md @@ -2,13 +2,27 @@ Python port of Anders and Briegel' s [method](https://arxiv.org/abs/quant-ph/0504117) for fast simulation of Clifford circuits. Should do thousands of qubits without much trouble. +![demo](examples/demo.gif) + +## Installation + Install with `pip`: ```shell $ pip install --user abp ``` -![demo](examples/demo.gif) +Or clone and install: + +```shell +$ git clone https://github.com/peteshadbolt/abp +$ python setup.py install --user +``` + +# Documentation + +You can read the documentation [here](https://peteshadbolt.co.uk/abp/). + ## Visualization