From 5524f193b43e6a3abbdacdf0b713fcf12f196129 Mon Sep 17 00:00:00 2001 From: Pete Shadbolt Date: Sat, 23 Jul 2016 19:42:47 +0100 Subject: [PATCH] Update README --- README.md | 10 ++++++---- {img => examples}/demo.gif | Bin {img => examples}/viz.png | Bin 3 files changed, 6 insertions(+), 4 deletions(-) rename {img => examples}/demo.gif (100%) rename {img => examples}/viz.png (100%) diff --git a/README.md b/README.md index b2dc178..5652aa5 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,6 @@ # abp -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. Should do thousands of qubits without much trouble. Install with `pip`: @@ -8,7 +8,7 @@ Install with `pip`: $ pip install --user abp ``` -![demo](img/demo.gif) +![demo](examples/demo.gif) ## Visualization @@ -40,13 +40,15 @@ Now, in another terminal, use `abp.fancy.GraphState` to run a Clifford circuit: And you should see a visualization of the state: -![demo](img/viz.jpg) +![demo](examples/viz.png) ## Testing -`abp` has a fairly rigorous test suite. You can run all the tests with `nose`: +`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, hence some tests will fail with `ImportErrors`. You can ignore those :feelsgood:. diff --git a/img/demo.gif b/examples/demo.gif similarity index 100% rename from img/demo.gif rename to examples/demo.gif diff --git a/img/viz.png b/examples/viz.png similarity index 100% rename from img/viz.png rename to examples/viz.png