ParityOS

ParityOS is a client software that supplies data structures to formulate optimization problems, create quantum circuits, states and code mappings as input for the ParityOS cloud services and for analyzing their results.

Service clients can be used to connect to these cloud services and send input and receive results.

For more information see the documentation.

Installation

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

# 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, 3.13].

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

# using pip
pip install parityos
# using uv
uv pip install parityos

License

Since version 2.1.0, the ParityOS Client software package is made available under the 3-Clause BSD License. See License.txt for details.