diff --git a/README.md b/README.md index 281ffde..58a0245 100644 --- a/README.md +++ b/README.md @@ -1,9 +1,10 @@ # abp 0.4.22 +Python port of Anders and Briegel' s [method](https://arxiv.org/abs/quant-ph/0504117) for fast simulation of Clifford circuits. -Python port of Anders and Briegel' s [method](https://arxiv.org/abs/quant-ph/0504117) for fast simulation of Clifford circuits. You can read the full documentation [here](https://peteshadbolt.co.uk/abp/). +## Documentation +You can read the full documentation [here](https://peteshadbolt.co.uk/abp/). You can also build it locally using Sphinx with `make doc`. ## Installation - It's easiest to install with `pip`: ```shell @@ -19,42 +20,3 @@ $ python setup.py develop --user $ python setup.py develop --user --prefix= # Might be required on OSX ``` -## Visualization - -`abp` comes with a tool to visualize graph states in a web browser. It uses a client-server architecture. - -First, run `abpserver` in a terminal: - -```shell -$ abpserver -Listening on port 5000 for clients.. -``` -Then browse to `http://localhost:5001/`. Alternatively, `abpserver -v` will automatically pop a browser window. - -Now, in another terminal, use `abp.fancy.GraphState` to run a Clifford circuit: - -```python ->>> from abp.fancy import GraphState ->>> g = GraphState(10) ->>> for i in range(10): -... g.act_hadamard(i) -... ->>> g.update() ->>> for i in range(9): -... g.act_cz(i, i+1) -... ->>> g.update() -``` - -And you should see a visualization of the state. - -## Testing - -`abp` has a bunch of tests. You can run them all with `nose`: - -```shell -$ nosetests -53 tests run in 39.5 seconds (53 tests passed) -``` - -Currently I use some reference implementations of `chp` and `graphsim` which you won't have installed, so some tests will be skipped. That's expected. diff --git a/doc/index.rst b/doc/index.rst index c597ecc..a89dd71 100644 --- a/doc/index.rst +++ b/doc/index.rst @@ -204,6 +204,16 @@ The ``clifford`` module provides a few useful functions: .. autofunction:: abp.clifford.use_old_cz :noindex: +Testing +---------------------- + +``abp`` has a bunch of tests. You can run them all with `nose`:: + + $ nosetests + 53 tests run in 39.5 seconds (53 tests passed) + +Currently I use some reference implementations of ``chp`` and ``graphsim`` which you won't have installed, so some tests will be skipped. That's expected. + Reference ----------------------------