diff --git a/README.md b/README.md index aafd22b..6bf3ac4 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,20 @@ # abp 0.6.1 Python port of Anders and Briegel' s [method](https://arxiv.org/abs/quant-ph/0504117) for fast simulation of Clifford circuits. +## Usage + +```python +import abp +from abp.util import xyz +g = abp.GraphState() +g.add_qubit("alice", position=xyz(0, 0, 0)) +g.add_qubit("bob", position=xyz(0, 0, 0)) +g.act_hadamard("alice") +g.act_hadamard("bob") +g.act_cz("alice", "bob") +g.push() # Sends for visualization +``` + ## Installation Install from source @@ -10,7 +24,7 @@ $ git clone http://gitlab.psiquantum.lan/pete/abp $ cd abp $ virtualenv env $ source env/bin/activate -$ python setup.py develop --user +$ python setup.py develop ``` ## Documentation