{"id":22882544,"url":"https://github.com/cqcl/pytket-aqt","last_synced_at":"2025-07-18T01:06:45.275Z","repository":{"id":62584358,"uuid":"546063547","full_name":"CQCL/pytket-aqt","owner":"CQCL","description":"pytket-aqt, extensions for pytket quantum SDK ","archived":false,"fork":false,"pushed_at":"2025-06-26T15:54:00.000Z","size":11019,"stargazers_count":5,"open_issues_count":2,"forks_count":5,"subscribers_count":8,"default_branch":"main","last_synced_at":"2025-06-26T16:46:32.085Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"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/CQCL.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":".github/CODEOWNERS","security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null}},"created_at":"2022-10-05T13:10:57.000Z","updated_at":"2025-06-03T14:50:16.000Z","dependencies_parsed_at":"2023-02-05T17:31:25.533Z","dependency_job_id":"8876db75-59ba-4686-9672-1e1058f03188","html_url":"https://github.com/CQCL/pytket-aqt","commit_stats":{"total_commits":28,"total_committers":3,"mean_commits":9.333333333333334,"dds":0.4642857142857143,"last_synced_commit":"dfa6f8d8e1f23e3474c3d0c755b1fb342b6b499b"},"previous_names":[],"tags_count":16,"template":false,"template_full_name":null,"purl":"pkg:github/CQCL/pytket-aqt","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/CQCL%2Fpytket-aqt","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/CQCL%2Fpytket-aqt/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/CQCL%2Fpytket-aqt/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/CQCL%2Fpytket-aqt/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/CQCL","download_url":"https://codeload.github.com/CQCL/pytket-aqt/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/CQCL%2Fpytket-aqt/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":262570987,"owners_count":23330489,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","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":[],"created_at":"2024-12-13T18:18:13.666Z","updated_at":"2025-06-29T09:34:50.516Z","avatar_url":"https://github.com/CQCL.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"# pytket-aqt\n\n[Pytket](https://tket.quantinuum.com/api-docs/index.html) is a python module for interfacing\nwith tket, a quantum computing toolkit and optimising compiler developed by Quantinuum.\n\n`pytket-aqt` is an extension to `pytket` that allows `pytket` circuits to be\nexecuted on AQT's ([Alpine Quantum Technologies'](https://www.aqt.eu/)) quantum devices and simulators.\n\nSee [extension documentation](https://cqcl.github.io/pytket-aqt/api/index.html) for more.\n\n## Getting started\n\n`pytket-aqt` is available for Python 3.10, 3.11 and 3.12, on Linux, MacOS\nand Windows. To install, run:\n\n```shell\npip install pytket-aqt\n```\n\nThis will install `pytket` if it isn't already installed, and add new classes\nand methods into the `pytket.extensions` namespace.\n\n## Available devices\n\n`pytket-aqt` offers offline simulators for aqt devices that do not require special access.\nAccess to remote simulators and machines can be configured by providing an AQT access token.\n\nTo see which devices are available to you, use the `AQTBackend.print_device_table` method.\nThis method will prompt for an access token if none has been configured. Providing a token at the\nprompt will store it in memory for further API use. Skip the prompt to see the available offline\nsimulators. It is also possible to store and use your access token across sessions using\n`config.set_aqt_config`.\n\n## Ion Shuttling\n\nThe `AQTMultiZoneBackend` supports routing of a circuit to a particular segmented ion-trap architecture before submission. This feature is experimental and not necessary for any currently available AQT devices. Using the graph partitioning based algorithms within this context requires the [mt-kahypar](https://github.com/kahypar/mt-kahypar) package.\n\nOn Windows based systems, `mtkahypar` is not installable via `pip` and will not be included with `pytket-aqt` as a dependency. It must be compiled and installed manually (see the instructions provided in the mt-kahypar repository for a manual\ninstallation).\n\n## Bugs, support and feature requests\n\nPlease file bugs and feature requests on the Github\n[issue tracker](https://github.com/CQCL/pytket-aqt/issues).\n\nThere is also a Slack channel for discussion and support. Click [here](https://tketusers.slack.com/join/shared_invite/zt-18qmsamj9-UqQFVdkRzxnXCcKtcarLRA#/shared-invite/email) to join.\n\n## Development\n\nThis project uses [Poetry](https://python-poetry.org/) for packaging and dependency management and\n[Nox](https://nox.thea.codes/en/stable/) for task automation.\n\n### Recommended development setup\n\nInstall development tools:\n\n```shell\npip install -r dev-tool-requirements.txt\n```\n\n### Local development with Nox (recommended)\n\n[Nox](https://nox.thea.codes/en/stable/) can be used to automate various development tasks running in isolated python environments.\nThe following Nox sessions are provided:\n\n- `pre-commit`: run the configured pre-commit hooks within [.pre-commit-config.yaml](.pre-commit-config.yaml), this includes linting with black and pylint\n- `mypy`: run type checks using mypy\n- `tests`: run the unit tests\n- `docs-build`: build the documentation\n\nTo run a session use:\n\n```shell\nnox -s \u003csession_name\u003e\n```\n\nTo save time, reuse the session virtual environment using the `-r` option, i.e. `nox -rs \u003csession_name\u003e` (may cause errors after a dependency update).\n\n[Pre-commit](https://pre-commit.com/) can be used to run the pre-commit hooks before each commit. This is recommended.\nTo set up the pre-commit hooks to run automatically on each commit run:\n\n```shell\nnox -s pre-commit -- install\n```\n\nAfterward, the [pre-configured hooks](.pre-commit-config.yaml) will run on all changed files in a commit and the commit will be\nrejected if the hooks find errors. Some hooks will correct formatting issues automatically (but will still reject the commit, so that\nthe `git commit` command will need to be repeated).\n\n### Local development without Nox\n\nTo install the local package, its dependencies and various development dependencies run:\n\n```shell\npoetry install --with tests,docs,mypy,pre-commit\n```\n\nThis will install the dependencies within an isolated virtual environment managed by Poetry. To activate that environment run:\n\n```shell\npoetry shell\n```\n\nWithin this environment, the following commands can be used:\n\n```shell\n# run tests\npytest tests\n# run mypy\nmypy --explicit-package-bases pytket tests docs/conf.py docs/build-docs\n# run pre-commit checks\npre-commit run --all-files --show-diff-on-failure\n# build documentation\n./docs/build-docs\n```\n\nTo exit the Poetry environment, run:\n\n```shell\nexit\n```\n\n## Contributing\n\nPull requests are welcome. To make a PR, first fork the repo, make your proposed\nchanges on the `main` branch, and open a PR from your fork. If it passes\ntests and is accepted after review, it will be merged in.\n\n### Code style\n\n#### Formatting and Linting\n\nAll code will be checked on the CI with [black](https://black.readthedocs.io/en/stable/) and [pylint](https://pypi.org/project/pylint/)\nas configured within the `pre-commit` checks. These checks should be\nrun locally before any pull request submission using the corresponding `nox` session or `pre-commit` directly (see above).\nThe used versions of the formatting ad linting tools is specified in the [pyproject.toml](pyproject.toml).\n\n#### Type annotation\n\nOn the CI, [mypy](https://mypy.readthedocs.io/en/stable/) is used as a static\ntype checker and all submissions must pass its checks. You should therefore run\n`mypy` locally on any changed files before submitting a PR. This should be done using the method\ndescribed under Local development [with Nox](#local-development-with-nox-recommended) or [without Nox](#local-development-without-nox).\n\n### Adding Tests\n\nWhen adding a new feature, please add appropriate tests for it within the [tests](tests) directory. When fixing a bug, please\nadd a test that demonstrates the fix.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcqcl%2Fpytket-aqt","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fcqcl%2Fpytket-aqt","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcqcl%2Fpytket-aqt/lists"}