Metadata-Version: 2.1
Name: ssip
Version: 0.1.0
Summary: "Tools to perform surgery with CSS codes"
Author: Alexander Cowtan
Author-email: alexander.cowtan@quantinuum.com
Requires-Python: >=3.10,<4.0
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Requires-Dist: networkx (>=3.3,<4.0)
Requires-Dist: numpy (>=1.26.4,<2.0.0)
Requires-Dist: pytest-cov (>=5.0.0,<6.0.0)
Requires-Dist: z3-solver (>=4.13.0.0,<5.0.0.0)
Description-Content-Type: text/markdown

# SSIP

See the [documentation](https://cqcl.github.io/SSIP/api-docs/) for a more thorough description.

## Development

### Prerequisites

- Python >= 3.10
- [Poetry](https://python-poetry.org/docs/#installation)
- [GAP](https://www.gap-system.org)


### Installing

Run the following to setup your virtual environment and install dependencies:

```sh
poetry install
```


You can then activate the virtual environment and work within it with:

```sh
poetry shell
```

Consider using [direnv](https://github.com/direnv/direnv/wiki/Python#poetry) to
automate this when entering and leaving a directory.

To run a single command in the shell, just prefix it with `poetry run`.

Run tests using

```sh
poetry run pytest -v
```

Run tests with code coverage using

```sh
poetry run pytest --cov-report term-missing --cov=ssip tests/
```
