Metadata-Version: 2.1
Name: graphstatesim
Version: 0.2.6
Summary: A fast stabilizer simulator using a graph state representation.
Requires-Python: >=3.12
Description-Content-Type: text/markdown

<!-- SPHINX-START -->

# GraphStateSim

This is a modified repository of Simon Anders' library GraphSim, using pybind11. GraphSim is able to simulate an important class of stabilizer circuits via a graph state representation with local clifford operators.

If you find this codebase useful, please cite the original paper [here](https://arxiv.org/abs/quant-ph/0504117).

## Installation

### PyPI

Install with pip:

```
pip install graphstatesim
```

Then in python, `import graphsim`.

### Building locally

To install, run
```
uv build
```

then navigate to the `dist/` folder and pip install the wheel.
```
uv pip install dist/*.whl
```

## Documentation

Documentation regarding the python bindings can be found at:

https://graphsim.readthedocs.io/en/latest/

## License

This code is not actively supported or maintained, but pull requests for minor bug fixes will be accepted.

> This is GraphSim, a library to simulate stabilizer quantum circuits.
>
> - Author: Simon Anders, sanders@fs.tum.de, University of Innsbruck
> - Version: v.10 (initial release)
> - Date: 1 Feb 2005 (last change), 18 Apr 2005 (release prep)
> - (c) 2005, released under GPL
>
> For information about this package, please read
> - the paper describing the algorithm:
>      S. Anders, H. J. Briegel:
>      Fast Simulation of Stabilizer Circuits using a Graph State Formalism
>      quant-ph/0504117
> - the documentation of the C++ library in doc/html/index.html
> - the documentation of the Python bindings in doc/graphsim_py.html
> - the file COPYING for the text of the GPL
>
> If you use this paper for scientific work, please cite the paper 
> referenced above in your publication.
     
In case of problems, please submit an issue.
