Welcome to Superstaq!
This repository is the home of the Superstaq development team's open-source work, which includes:
- Our quantum software platform that is optimized across the quantum stack and enables users to write quantum programs in Cirq or Qiskit and target a variety of quantum computers and simulators. Read more about it here.
Installation for users
For installation instructions for users of Superstaq, check out our documentation site! In short, you can install any of our packages by doing pip install <package> in a terminal, where <package> is qiskit-superstaq, cirq-superstaq, or general-superstaq.
Installation for development
If you'd like to contribute to Superstaq, below are the instructions for installation. Note, if you are working on multiple clients (e.g., qiskit-superstaq and cirq-superstaq), you do not need to clone the repository multiple times or set up multiple virtual environments, but you must install the client-specific requirements in each client directory.
qiskit-superstaq
```console
git clone git@github.com:Infleqtion/client-superstaq.git
python3 -m venv venv_superstaq
source venv_superstaq/bin/activate
cd client-superstaq/qiskit-superstaq
python3 -m pip install -e ".[dev]"
```
qiskit-superstaq cirq-superstaq
```console
git clone git@github.com:Infleqtion/client-superstaq.git
python3 -m venv venv_superstaq
source venv_superstaq/bin/activate
cd client-superstaq/cirq-superstaq
python3 -m pip install -e ".[dev]"
```
cirq-superstaq general-superstaq
```console
git clone git@github.com:Infleqtion/client-superstaq.git
python3 -m venv venv_superstaq
source venv_superstaq/bin/activate
cd client-superstaq/general-superstaq
python3 -m pip install -e ".[dev]"
```
general-superstaq Documentation
For more information on getting started, check out our documentation site!
License
Superstaq is licensed under the Apache License 2.0. See our LICENSE file for more details.
Contact Us
If you'd like to reach out to a member of our team, please email us at superstaq@infleqtion.com or join our Slack workspace.
