https://github.com/qctrl/open-controls
🎛 Q-CTRL Open Controls
https://github.com/qctrl/open-controls
boulder-opal-engineering engineering infrastructure type-standard
Last synced: 25 days ago
JSON representation
🎛 Q-CTRL Open Controls
- Host: GitHub
- URL: https://github.com/qctrl/open-controls
- Owner: qctrl
- License: apache-2.0
- Created: 2019-04-16T06:39:52.000Z (almost 7 years ago)
- Default Branch: master
- Last Pushed: 2026-02-04T01:44:44.000Z (2 months ago)
- Last Synced: 2026-02-04T13:37:43.036Z (about 2 months ago)
- Topics: boulder-opal-engineering, engineering, infrastructure, type-standard
- Language: Python
- Homepage: https://q-ctrl.com
- Size: 2.31 MB
- Stars: 113
- Watchers: 41
- Forks: 39
- Open Issues: 3
-
Metadata Files:
- Readme: .github/README.md
- License: LICENSE
- Codeowners: CODEOWNERS
Awesome Lists containing this project
README
# Q-CTRL Open Controls
Q-CTRL Open Controls is an open-source Python package that makes it easy to create and deploy established error-robust quantum control protocols from the open literature. The aim of the package is to be the most comprehensive library of published and tested quantum control techniques developed by the community, with easy to use export functions allowing users to deploy these controls on:
- Custom quantum hardware
- Publicly available cloud quantum computers
- The [Q-CTRL product suite](https://q-ctrl.com/products/)
Anyone interested in quantum control is welcome to contribute to this project.
## Installation
Q-CTRL Open Controls can be installed through `pip` or from source. We recommend the `pip` distribution to get the most recent stable release. If you want the latest features, then install from source.
### Requirements
To use Q-CTRL Open Controls you will need an installation of Python. We recommend using the [Anaconda](https://www.anaconda.com/) distribution of Python. Anaconda includes standard numerical and scientific Python packages which are optimally compiled for your machine. Follow the [Anaconda Installation](https://docs.anaconda.com/anaconda/install/) instructions and consult the [Anaconda User guide](https://docs.anaconda.com/anaconda/user-guide/) to get started.
We use interactive jupyter notebooks for our usage examples. The Anaconda python distribution comes with editors for these files, or you can [install the jupyter notebook editor](https://jupyter.org/install) on its own.
### Using PyPi
Use `pip` to install the latest version of Q-CTRL Open Controls.
```shell
pip install qctrl-open-controls
```
### From source
The source code is hosted on [GitHub](https://github.com/qctrl/open-controls). The repository can be cloned using
```shell
git clone git@github.com:qctrl/open-controls.git
```
Once the clone is complete, you have two options:
1. Using Poetry
Follow the instructions from the [Poetry documentation](https://python-poetry.org/docs/#installation) to install Poetry.
After you have installed Poetry, use:
```bash
cd open-controls
poetry install
```
1. Using pip
```shell
cd open-controls
poetry export --dev -f requirements.txt --output requirements.txt --without-hashes
pip install -r requirements.txt
pip install -e .
rm requirements.txt
```
Once installed via one of the above methods, test your installation by running `pytest` in the `open-controls` directory.
```shell
pytest
```
## Usage
See the [Jupyter notebooks examples](../examples) and the [Q-CTRL Open Controls reference documentation](https://docs.q-ctrl.com/open-controls/references/qctrl-open-controls/).
## Contributing
For general guidelines, see [Contributing](https://code.q-ctrl.com/contributing).
### Building documentation
Documentation generation relies on [Sphinx](http://www.sphinx-doc.org). The reference documentation for the latest released version of Q-CTRL Open Controls is hosted online in the [Q-CTRL documentation website](https://docs.q-ctrl.com/open-controls/references/qctrl-open-controls/).
To build it locally:
1. Ensure you have used one of the install options above.
1. Execute the make file from the docs directory:
If using Poetry:
```bash
cd docs
poetry run make html
```
If using pip:
```bash
cd docs
# Activate your virtual environment if required
make html
```
The generated HTML will appear in the `docs/_build/html` directory.
### Formatting, linting, and static analysis
Code is formatted, linted and checked using the following tools:
- [Ruff](https://github.com/astral-sh/ruff) - A fast Python linter and formatter (replaces Black, isort, and Pylint)
- [mypy](http://mypy-lang.org/)
These checks are run on all code merged to master, and may also be run locally from the open-controls directory:
```shell
pip install ruff mypy
mypy
ruff check .
ruff format --check .
```
Ruff, in addition to checking code, can also automatically apply fixes. To fix all code in the open-controls tree, run:
```shell
ruff check --fix .
ruff format .
```
You can also run these checks only in the files that you changed by using the `pre-commit` tool. To use it, run:
```shell
pip install pre-commit
pre-commit install
```
With this, the checks will run every time that you commit code with `git commit`. If you prefer to run the checks every time that you push changes instead of when you commit changes, use `pre-commit install -t pre-push`.
If you no longer wish to use `pre-commit`, you can uninstall it by running `pre-commit uninstall` in the `open-controls` directory (or by running `pre-commit uninstall -t pre-push`, if you used the pre-push hooks).
## Credits
See [Contributors](https://github.com/qctrl/open-controls/graphs/contributors).
## License
See [LICENSE](../LICENSE).