{"id":22882547,"url":"https://github.com/cqcl/pytket-docs","last_synced_at":"2025-05-15T23:08:33.477Z","repository":{"id":32743088,"uuid":"140554016","full_name":"CQCL/pytket-docs","owner":"CQCL","description":"User manual and example notebooks for the pytket quantum computing toolkit","archived":false,"fork":false,"pushed_at":"2025-04-18T04:47:10.000Z","size":151845,"stargazers_count":333,"open_issues_count":24,"forks_count":89,"subscribers_count":30,"default_branch":"main","last_synced_at":"2025-05-01T15:44:00.751Z","etag":null,"topics":["compilers","documentation","jupyter-notebook","quantum-algorithms","quantum-computing","user-guide"],"latest_commit_sha":null,"homepage":"https://docs.quantinuum.com/tket/user-guide/","language":"Shell","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":null,"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}},"created_at":"2018-07-11T09:39:17.000Z","updated_at":"2025-03-19T15:47:16.000Z","dependencies_parsed_at":"2023-12-12T18:43:04.848Z","dependency_job_id":"ac845421-ecb6-4d6d-8903-5ea06d2975fb","html_url":"https://github.com/CQCL/pytket-docs","commit_stats":null,"previous_names":["cqcl/pytket-docs","cqcl/pytket"],"tags_count":11,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/CQCL%2Fpytket-docs","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/CQCL%2Fpytket-docs/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/CQCL%2Fpytket-docs/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/CQCL%2Fpytket-docs/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/CQCL","download_url":"https://codeload.github.com/CQCL/pytket-docs/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":254436949,"owners_count":22070947,"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":["compilers","documentation","jupyter-notebook","quantum-algorithms","quantum-computing","user-guide"],"created_at":"2024-12-13T18:18:15.271Z","updated_at":"2025-05-15T23:08:27.660Z","avatar_url":"https://github.com/CQCL.png","language":"Shell","readme":"# pytket-docs\n\n[![Slack](https://img.shields.io/badge/Slack-4A154B?style=for-the-badge\u0026logo=slack\u0026logoColor=white)](https://tketusers.slack.com/join/shared_invite/zt-18qmsamj9-UqQFVdkRzxnXCcKtcarLRA#/shared-invite/email)\n[![PyPI version](https://badge.fury.io/py/pytket.svg)](https://badge.fury.io/py/pytket)\n\nPytket is a python module for interfacing with tket, a quantum computing toolkit and optimising compiler developed by Quantinuum.\n\nThis repository contains the pytket user manual and example notebooks content in the `docs` directory. It does not contain source code for pytket itself. The source code is maintained on the [tket repository](https://github.com/CQCL/tket).\n\nThe manual and examples are built and deployed as html pages using the [myst-nb](https://myst-nb.readthedocs.io/en/latest/) library. Instructions on building the docs locally can be found [here](https://github.com/CQCL/pytket-docs/blob/main/docs/README.md).\n\nNote that the TKET website is not deployed from this repository. This repository just contains the content for the documentation.\n \n\n## Getting started\n\nPytket is available for Python 3.10, 3.11 and 3.12 on Linux, MacOS and Windows.\nTo install, run:\n\n```shell\npip install pytket\n```\n\nAPI documentation can be found at https://docs.quantinuum.com/tket/api-docs.\n\n\n## Maintenance and support\n\nIf you think you've found a bug or have an idea for a feature then please raise an issue [here](https://github.com/CQCL/tket/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### Pytket 0.x.y\n\nPytket underwent rapid development from 2018 to 2022, with frequent changes of\nAPI. Our policy has been to maintain only the latest 0.x relase, and not to port\nbugfixes to older releases. Since version 0.7 (February 2021) we have been\nreleasing new versions (0.x.0) on a 4-week cycle, with occasional patch releases\n(0.x.y) for important hotfixes.\n\n### Pytket 1.x.y\n\nWith the release of pytket 1.0 in early 2022, we are moving to a different\nprocess, to facilitate long-term stability. Following the [semver](https://semver.org/)\nconventions, we will not introduce incompatible API changes in the 1.x.y series;\nthe minor version (x) will be incremented whenever new functionality is\nintroduced; and the patch version (y) will be incremented for bug fixes.\n\nPytket 1 will be maintained according to this policy for at least a year\nfollowing the release of pytket 2.0. There will be no further maintenance of\n0.x.y versions.\n\n### Pytket 2.x.y\n\nDevelopment work on pytket 2 will begin soon after the release of pytket 1.0.\nThis will have a different API. Only pre-release versions will be uploaded to\npypi until the API has stabilized enough to make a 2.0 release. Thereafter we\nwill continue according to the same policy as for pytket 1.x.y.\n\n## How to cite\n\nIf you wish to cite tket in any academic publications, we generally recommend citing our [software overview paper](https://doi.org/10.1088/2058-9565/ab8e92) for most cases.\n\nIf your work is on the topic of specific compilation tasks, it may be more appropriate to cite one of our other papers:\n\n- [\"On the qubit routing problem\"](https://doi.org/10.4230/LIPIcs.TQC.2019.5) for qubit placement (a.k.a. allocation) and routing (a.k.a. swap network insertion, connectivity solving).\n- [\"Phase Gadget Synthesis for Shallow Circuits\"](https://doi.org/10.4204/EPTCS.318.13) for representing exponentiated Pauli operators in the ZX calculus and their circuit decompositions.\n- [\"A Generic Compilation Strategy for the Unitary Coupled Cluster Ansatz\"](https://arxiv.org/abs/2007.10515) for sequencing of terms in Trotterisation and Pauli diagonalisation.\n\nWe are also keen for others to benchmark their compilation techniques against us. We recommend checking our [benchmark repository](https://github.com/CQCL/tket_benchmarking) for examples on how to run basic benchmarks with the latest version of pytket. Please list the release version of pytket with any benchmarks you give, and feel free to get in touch for any assistance needed in setting up fair and representative tests.\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcqcl%2Fpytket-docs","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fcqcl%2Fpytket-docs","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcqcl%2Fpytket-docs/lists"}