{"id":13751256,"url":"https://github.com/qctrl/open-controls","last_synced_at":"2026-03-11T03:02:10.983Z","repository":{"id":35027747,"uuid":"181630046","full_name":"qctrl/open-controls","owner":"qctrl","description":"🎛 Q-CTRL Open Controls","archived":false,"fork":false,"pushed_at":"2026-02-04T01:44:44.000Z","size":2424,"stargazers_count":113,"open_issues_count":3,"forks_count":39,"subscribers_count":41,"default_branch":"master","last_synced_at":"2026-02-04T13:37:43.036Z","etag":null,"topics":["boulder-opal-engineering","engineering","infrastructure","type-standard"],"latest_commit_sha":null,"homepage":"https://q-ctrl.com","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/qctrl.png","metadata":{"files":{"readme":".github/README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":"CODEOWNERS","security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null,"notice":null,"maintainers":null,"copyright":null,"agents":null,"dco":null,"cla":null}},"created_at":"2019-04-16T06:39:52.000Z","updated_at":"2026-02-04T06:25:48.000Z","dependencies_parsed_at":"2024-02-18T23:36:00.384Z","dependency_job_id":"9eac1f04-4788-4b40-bf76-8c9331babf33","html_url":"https://github.com/qctrl/open-controls","commit_stats":null,"previous_names":["qctrl/python-open-controls"],"tags_count":57,"template":false,"template_full_name":null,"purl":"pkg:github/qctrl/open-controls","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/qctrl%2Fopen-controls","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/qctrl%2Fopen-controls/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/qctrl%2Fopen-controls/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/qctrl%2Fopen-controls/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/qctrl","download_url":"https://codeload.github.com/qctrl/open-controls/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/qctrl%2Fopen-controls/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":30368551,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-03-10T21:41:54.280Z","status":"online","status_checked_at":"2026-03-11T02:00:07.027Z","response_time":84,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["boulder-opal-engineering","engineering","infrastructure","type-standard"],"created_at":"2024-08-03T09:00:40.170Z","updated_at":"2026-03-11T03:02:10.978Z","avatar_url":"https://github.com/qctrl.png","language":"Python","readme":"# Q-CTRL Open Controls\n\n![Python](https://img.shields.io/badge/python-3.9+-blue.svg)\n\nQ-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:\n\n- Custom quantum hardware\n- Publicly available cloud quantum computers\n- The [Q-CTRL product suite](https://q-ctrl.com/products/)\n\nAnyone interested in quantum control is welcome to contribute to this project.\n\n## Installation\n\nQ-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.\n\n### Requirements\n\nTo 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.\n\nWe 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.\n\n### Using PyPi\n\nUse `pip` to install the latest version of Q-CTRL Open Controls.\n\n```shell\npip install qctrl-open-controls\n```\n\n### From source\n\nThe source code is hosted on [GitHub](https://github.com/qctrl/open-controls). The repository can be cloned using\n\n```shell\ngit clone git@github.com:qctrl/open-controls.git\n```\n\nOnce the clone is complete, you have two options:\n\n1. Using Poetry\n\n   Follow the instructions from the [Poetry documentation](https://python-poetry.org/docs/#installation) to install Poetry.\n\n   After you have installed Poetry, use:\n\n   ```bash\n   cd open-controls\n   poetry install\n   ```\n\n1. Using pip\n\n   ```shell\n   cd open-controls\n   poetry export --dev -f requirements.txt --output requirements.txt --without-hashes\n   pip install -r requirements.txt\n   pip install -e .\n   rm requirements.txt\n   ```\n\nOnce installed via one of the above methods, test your installation by running `pytest` in the `open-controls` directory.\n\n```shell\npytest\n```\n\n## Usage\n\nSee the [Jupyter notebooks examples](../examples) and the [Q-CTRL Open Controls reference documentation](https://docs.q-ctrl.com/open-controls/references/qctrl-open-controls/).\n\n## Contributing\n\nFor general guidelines, see [Contributing](https://code.q-ctrl.com/contributing).\n\n### Building documentation\n\nDocumentation 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/).\n\nTo build it locally:\n\n1. Ensure you have used one of the install options above.\n1. Execute the make file from the docs directory:\n\n   If using Poetry:\n\n   ```bash\n   cd docs\n   poetry run make html\n   ```\n\n   If using pip:\n\n   ```bash\n   cd docs\n   # Activate your virtual environment if required\n   make html\n   ```\n\nThe generated HTML will appear in the `docs/_build/html` directory.\n\n### Formatting, linting, and static analysis\n\nCode is formatted, linted and checked using the following tools:\n\n- [Ruff](https://github.com/astral-sh/ruff) - A fast Python linter and formatter (replaces Black, isort, and Pylint)\n- [mypy](http://mypy-lang.org/)\n\nThese checks are run on all code merged to master, and may also be run locally from the open-controls directory:\n\n```shell\npip install ruff mypy\nmypy\nruff check .\nruff format --check .\n```\n\nRuff, in addition to checking code, can also automatically apply fixes. To fix all code in the open-controls tree, run:\n\n```shell\nruff check --fix .\nruff format .\n```\n\nYou can also run these checks only in the files that you changed by using the `pre-commit` tool. To use it, run:\n\n```shell\npip install pre-commit\npre-commit install\n```\n\nWith 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`.\n\nIf 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).\n\n## Credits\n\nSee [Contributors](https://github.com/qctrl/open-controls/graphs/contributors).\n\n## License\n\nSee [LICENSE](../LICENSE).\n","funding_links":[],"categories":["Community","Python"],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fqctrl%2Fopen-controls","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fqctrl%2Fopen-controls","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fqctrl%2Fopen-controls/lists"}