Installation

Installation is most easily done using the pip package manager from the PyPI server:
pip install vecs2pauli
For instructions to install directly from the source code, please see here.

How to use Vecs2Pauli: A first example

Use the following Python code to find the stabilizer group generators of the Bell state:
bell_state = [1, 0, 0, 1]  # |00> + |11>

print(vecs2pauli.get_stabilizers(bell_state))
# prints ["+ZZ", "+XX"]

Documentation

Before release of version 1.0.0 of vecs2pauli, full documentation of the library's API will be provided (you can already build the beta version of the documentation yourself: see here). Before release, the examples will be also be collected in one place.

For now, have a look at the the examples on this website and the example snippets in the source code.

Or, if you're eager to compile the code yourself or see what's under the hood of Vecs2Pauli, check out the the source code and the accompanying README.