From 9e18b46f3c8896dd1aca1684c51d817edaa4e2b3 Mon Sep 17 00:00:00 2001 From: Pete Shadbolt Date: Fri, 12 Aug 2016 10:00:33 +0100 Subject: [PATCH 1/3] Update README.md --- README.md | 9 +++++---- 1 file changed, 5 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 2087837..539dfeb 100644 --- a/README.md +++ b/README.md @@ -6,17 +6,18 @@ Python port of Anders and Briegel' s [method](https://arxiv.org/abs/quant-ph/050 ## Installation -Install with `pip`: +It's easiest to install with `pip`: ```shell $ pip install --user abp ``` -Or clone and install: +Or clone and install in `develop` mode: ```shell $ git clone https://github.com/peteshadbolt/abp.git -$ python setup.py install --user +$ python setup.py develop --user +$ python setup.py develop --user --prefix= # Might be required on OSX ``` ## Visualization @@ -59,4 +60,4 @@ $ 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. +Currently I use some reference implementations of `CHP` and `graphsim` which you won't have installed, so a bunch of tests will be skipped. That's expected. From 5d4791427d3375fb063200044f5b49c6b7f11cdc Mon Sep 17 00:00:00 2001 From: Pete Shadbolt Date: Fri, 12 Aug 2016 10:01:06 +0100 Subject: [PATCH 2/3] Update README.md --- README.md | 1 + 1 file changed, 1 insertion(+) diff --git a/README.md b/README.md index 539dfeb..29efd9c 100644 --- a/README.md +++ b/README.md @@ -16,6 +16,7 @@ Or clone and install in `develop` mode: ```shell $ git clone https://github.com/peteshadbolt/abp.git +$ cd abp $ python setup.py develop --user $ python setup.py develop --user --prefix= # Might be required on OSX ``` From f84d5e88091dbc58c2e04b5e41096f2d2594f373 Mon Sep 17 00:00:00 2001 From: Pete Shadbolt Date: Fri, 12 Aug 2016 10:02:55 +0100 Subject: [PATCH 3/3] Update README.md --- README.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 29efd9c..5d0c84a 100644 --- a/README.md +++ b/README.md @@ -23,7 +23,7 @@ $ python setup.py develop --user --prefix= # Might be required on OSX ## Visualization -`abp` comes with a tool to visualize graph states in a WebGL compatible web browser (Chrome, Firefox, Safari etc). It uses a client-server architecture. +`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: @@ -31,7 +31,7 @@ First, run `abpserver` in a terminal: $ abpserver Listening on port 5000 for clients.. ``` -Then browse to `http://localhost:5001/` (in some circumstances `abp` will automatically pop a browser window). +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: @@ -61,4 +61,4 @@ $ 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 a bunch of tests will be skipped. That's expected. +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.