Metadata-Version: 2.4
Name: parityos-pyquil
Version: 0.1.0
Summary: pyQuil extension for ParityOS
Project-URL: Homepage, https://parityqc.com/
Author-email: ParityQC <parityos@parityqc.com>
License-Expression: BSD-3-Clause
License-File: LICENSE.txt
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Typing :: Typed
Requires-Python: <3.13,>=3.11
Requires-Dist: parityos>=3.0.0
Requires-Dist: pyquil<5.0,>=4.17
Description-Content-Type: text/markdown

# ParityOS pyQuil

ParityOS extension for [pyQuil](https://pyquil-docs.rigetti.com/en/stable/index.html).

## Installation

It is recommended to install this package in a separate Python virtual environment. For example:

```shell
# To create a standard Python virtual environment:
python -m venv my_new_venv && source my_new_venv/bin/activate
# Alternatively, to create a Anaconda/Miniconda environment:
conda create --name my_new_conda_env python=<version> && conda activate my_new_conda_env
# or a pyenv environment
pyenv virtualenv <version> my_new_venv && pyenv activate my_new_venv
# or a uv managed environment
uv venv -p <version>
```
where `<version>` is a python version and one of `[3.11, 3.12]`.

After activating the virtual environment, install via your favorite package manager, e.g.:

```shell
# using pip
pip install parityos-pyquil
# using uv
uv pip install parityos-pyquil
```

## Features

- `parityos-pyquil` can be used to convert a `CompilerISA` object, typically obtained from a [pyQuil](https://pyquil-docs.rigetti.com/en/stable/index.html) `QuantumComputer`, into a `DeviceModel` compatible with 
the ParityOS framework.


- The package offers an exporter of ParityOS to PyQuil quantum circuits.



## License

This software package is made available under the 3-Clause BSD License. See `LICENSE.txt` for
details.
