https://github.com/cqcl/pytket-aqt
pytket-aqt, extensions for pytket quantum SDK
Science Score: 26.0%
This score indicates how likely this project is to be science-related based on various indicators:
-
○CITATION.cff file
-
✓codemeta.json file
Found codemeta.json file -
✓.zenodo.json file
Found .zenodo.json file -
○DOI references
-
○Academic publication links
-
○Committers with academic emails
-
○Institutional organization owner
-
○JOSS paper metadata
-
○Scientific vocabulary similarity
Low similarity (16.6%) to scientific vocabulary
Keywords from Contributors
Repository
pytket-aqt, extensions for pytket quantum SDK
Basic Info
- Host: GitHub
- Owner: CQCL
- License: apache-2.0
- Language: Python
- Default Branch: main
- Size: 10.7 MB
Statistics
- Stars: 5
- Watchers: 8
- Forks: 5
- Open Issues: 1
- Releases: 16
Metadata Files
README.md
pytket-aqt
Pytket is a python module for interfacing with tket, a quantum computing toolkit and optimising compiler developed by Quantinuum.
pytket-aqt is an extension to pytket that allows pytket circuits to be
executed on AQT's (Alpine Quantum Technologies') quantum devices and simulators.
See extension documentation for more.
Getting started
pytket-aqt is available for Python 3.11 and 3.12, on Linux, MacOS
and Windows. To install, run:
shell
pip install pytket-aqt
This will install pytket if it isn't already installed, and add new classes
and methods into the pytket.extensions namespace.
Available devices
pytket-aqt offers offline simulators for aqt devices that do not require special access.
Access to remote simulators and machines can be configured by providing an AQT access token.
To see which devices are available to you, use the AQTBackend.print_device_table method.
This method will prompt for an access token if none has been configured. Providing a token at the
prompt will store it in memory for further API use. Skip the prompt to see the available offline
simulators. It is also possible to store and use your access token across sessions using
config.set_aqt_config.
Ion Shuttling
The 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 package.
On 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
installation).
Bugs, support and feature requests
Please file bugs and feature requests on the Github issue tracker.
There is also a Slack channel for discussion and support. Click here to join.
Development
This project uses Poetry for packaging and dependency management task automation.
Recommended development setup
Install development tools:
shell
pip install -r dev-tool-requirements.txt
Local development
To install the local package, its dependencies and various development dependencies run:
shell
poetry install --with tests,docs,mypy,pre-commit
This will install the dependencies within an isolated virtual environment managed by Poetry. To activate that environment run:
shell
poetry shell
Within this environment, the following commands can be used:
```shell
run tests
pytest tests
run mypy
mypy --config-file=mypy.ini --no-incremental --explicit-package-bases pytket tests
run pre-commit checks
pre-commit run --all-files --show-diff-on-failure
build documentation
./docs/build-docs ```
To exit the Poetry environment, run:
shell
exit
Pre-commit can be used to run the pre-commit hooks before each commit. This is recommended. To set up the pre-commit hooks to run automatically on each commit run:
shell
poetry run pre-commit install
Afterward, the pre-configured hooks will run on all changed files in a commit and the commit will be
rejected if the hooks find errors. Some hooks will correct formatting issues automatically (but will still reject the commit, so that
the git commit command will need to be repeated).
Contributing
Pull requests are welcome. To make a PR, first fork the repo, make your proposed
changes on the main branch, and open a PR from your fork. If it passes
tests and is accepted after review, it will be merged in.
Code style
Formatting and Linting
All code will be checked on the CI with ruff
as configured within the pre-commit checks. These checks should be
run locally before any pull request submission using pre-commit directly (see above).
The used versions of the formatting ad linting tools is specified in the pyproject.toml.
Type annotation
On the CI, mypy is used as a static
type checker and all submissions must pass its checks. You should therefore run
mypy locally on any changed files before submitting a PR.
Adding Tests
When adding a new feature, please add appropriate tests for it within the tests directory. When fixing a bug, please add a test that demonstrates the fix.
Owner
- Name: Cambridge Quantum
- Login: CQCL
- Kind: organization
- Location: Cambridge, UK
- Website: http://www.cambridgequantum.com
- Repositories: 48
- Profile: https://github.com/CQCL
Quantum Software and Technologies
GitHub Events
Total
- Create event: 35
- Release event: 1
- Issues event: 2
- Watch event: 3
- Delete event: 17
- Issue comment event: 30
- Push event: 71
- Pull request event: 57
- Pull request review comment event: 21
- Pull request review event: 39
- Fork event: 1
Last Year
- Create event: 35
- Release event: 1
- Issues event: 2
- Watch event: 3
- Delete event: 17
- Issue comment event: 30
- Push event: 71
- Pull request event: 57
- Pull request review comment event: 21
- Pull request review event: 39
- Fork event: 1
Committers
Last synced: about 1 year ago
Top Committers
| Name | Commits | |
|---|---|---|
| cqc-melf | 7****f | 65 |
| dependabot[bot] | 4****] | 47 |
| Travis Thompson | 1****o | 20 |
| Alec Edgington | 5****c | 11 |
| Kartik Singhal | k****l@q****m | 2 |
| jbrixon | r****8@g****m | 1 |
| Silas Dilkes | 3****s | 1 |
Committer Domains (Top 20 + Academic)
Issues and Pull Requests
Last synced: 11 months ago
All Time
- Total issues: 6
- Total pull requests: 212
- Average time to close issues: 2 months
- Average time to close pull requests: 4 days
- Total issue authors: 3
- Total pull request authors: 8
- Average comments per issue: 0.33
- Average comments per pull request: 0.61
- Merged pull requests: 148
- Bot issues: 0
- Bot pull requests: 98
Past Year
- Issues: 2
- Pull requests: 64
- Average time to close issues: N/A
- Average time to close pull requests: 7 days
- Issue authors: 2
- Pull request authors: 5
- Average comments per issue: 0.0
- Average comments per pull request: 0.95
- Merged pull requests: 37
- Bot issues: 0
- Bot pull requests: 35
Top Authors
Issue Authors
- cqc-melf (4)
- fg-aqt (1)
- trvto (1)
Pull Request Authors
- dependabot[bot] (98)
- cqc-melf (70)
- trvto (21)
- cqc-alec (17)
- willsimmons1465 (2)
- sjdilkes (2)
- qartik (1)
- jbrixon (1)
Top Labels
Issue Labels
Pull Request Labels
Packages
- Total packages: 1
-
Total downloads:
- pypi 50 last-month
- Total dependent packages: 0
- Total dependent repositories: 1
- Total versions: 39
- Total maintainers: 3
pypi.org: pytket-aqt
Extension for pytket, providing access to AQT backends
- Documentation: https://pytket-aqt.readthedocs.io/
- License: Apache 2
-
Latest release: 0.37.0
published about 1 year ago
Rankings
Dependencies
- sphinx *
- sphinx_rtd_theme *
- pytket *
- hypothesis * test
- pytest * test
- pytest-timeout * test
- requests_mock * test
- actions/checkout v3 composite
- actions/deploy-pages v1 composite
- actions/download-artifact v3 composite
- actions/setup-python v4 composite
- actions/upload-artifact v3 composite
- actions/upload-pages-artifact v1 composite
- pypa/gh-action-pypi-publish release/v1 composite
- actions/checkout v3 composite
- actions/setup-python v4 composite
- actions/upload-artifact v3 composite
- atlassian/gajira-create v3.0.1 composite
- atlassian/gajira-login v3.0.1 composite
- actions/checkout v3 composite
- actions/setup-python v4 composite