{"id":22882496,"url":"https://github.com/cqcl/pytket-qujax","last_synced_at":"2025-05-07T04:48:08.105Z","repository":{"id":48179646,"uuid":"516673265","full_name":"CQCL/pytket-qujax","owner":"CQCL","description":null,"archived":false,"fork":false,"pushed_at":"2025-05-06T08:38:17.000Z","size":18845,"stargazers_count":10,"open_issues_count":7,"forks_count":3,"subscribers_count":9,"default_branch":"main","last_synced_at":"2025-05-07T04:47:57.746Z","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}},"created_at":"2022-07-22T08:35:19.000Z","updated_at":"2025-04-02T12:06:43.000Z","dependencies_parsed_at":"2023-02-10T10:16:00.604Z","dependency_job_id":"4948c78d-0ac1-4f14-bb6a-507add61beca","html_url":"https://github.com/CQCL/pytket-qujax","commit_stats":{"total_commits":56,"total_committers":5,"mean_commits":11.2,"dds":0.6428571428571428,"last_synced_commit":"1e2fec4d7a2399431e57f8243f104d8a62c0796f"},"previous_names":[],"tags_count":29,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/CQCL%2Fpytket-qujax","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/CQCL%2Fpytket-qujax/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/CQCL%2Fpytket-qujax/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/CQCL%2Fpytket-qujax/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/CQCL","download_url":"https://codeload.github.com/CQCL/pytket-qujax/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":252816523,"owners_count":21808702,"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:00.865Z","updated_at":"2025-05-07T04:48:08.083Z","avatar_url":"https://github.com/CQCL.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"# pytket-qujax\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#)\n[![Stack Exchange](https://img.shields.io/badge/StackExchange-%23ffffff.svg?style=for-the-badge\u0026logo=StackExchange)](https://quantumcomputing.stackexchange.com/tags/pytket)\n\nThis repository contains the pytket-qujax extension, using CQC's\n[pytket](https://tket.quantinuum.com/api-docs/index.html) quantum SDK.\nThe other pytket extensions can be found [here](https://tket.quantinuum.com/api-docs/extensions)\n\n[Pytket](https://tket.quantinuum.com/api-docs/index.html) is a Python module for interfacing\nwith CQC tket, a set of quantum programming tools.\n\n[qujax](https://github.com/CQCL/qujax) is a pure [JAX](https://github.com/google/jax)\nquantum simulator. pytket-qujax is an extension to [pytket](https://tket.quantinuum.com/api-docs/index.html)\nthat allows [pytket](https://tket.quantinuum.com/api-docs/index.html) circuits to\nbe converted to [qujax](https://github.com/CQCL/qujax) for fast (classical) simulation and automatic differentiation.\n\nSome useful links:\n- [Documentation](https://tket.quantinuum.com/extensions/pytket-qujax/index.html)\n- [PyPI](https://pypi.org/project/pytket-qujax/)\n- [qujax](https://github.com/CQCL/qujax)\n- [pytket-qujax example notebook (VQE)](https://github.com/CQCL/pytket/blob/main/examples/pytket-qujax_heisenberg_vqe.ipynb)\n- [pytket-qujax example notebook (QAOA with `symbol_map`)](https://github.com/CQCL/pytket/blob/main/examples/pytket-qujax_qaoa.ipynb)\n- [pytket-qujax example notebook (classifier)](https://github.com/CQCL/pytket/blob/main/examples/pytket-qujax-classification.ipynb)\n- [qujax example notebooks](https://github.com/CQCL/qujax/tree/main/examples)\n\n\n## Getting started\n\n`pytket-qujax` is available for Python 3.10, 3.11 and 3.12, on Linux and MacOS.\nTo install, run:\n\n```shell\npip install pytket-qujax\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## Bugs and feature requests\n\nPlease file bugs and feature requests on the Github\n[issue tracker](https://github.com/CQCL/pytket-qujax/issues).\n\n## Development\n\nTo install an extension in editable mode, simply change to its subdirectory\nwithin the `modules` directory, and run:\n\n```shell\npip install -e .\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\n\nAll code should be formatted using\n[black](https://black.readthedocs.io/en/stable/), with default options. This is\nchecked on the CI. The CI is currently using version 20.8b1.\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. Because of the way\nextension modules embed themselves into the `pytket` namespace this is a little\ncomplicated, but it should be sufficient to run the script `modules/mypy-check`\n(passing as a single argument the root directory of the module to test). The\nscript requires `mypy` 0.800 or above.\n\n#### Linting\n\nWe use [pylint](https://pypi.org/project/pylint/) on the CI to check compliance\nwith a set of style requirements (listed in `.pylintrc`). You should run\n`pylint` over any changed files before submitting a PR, to catch any issues.\n\n### Tests\n\nTo run the tests for a module:\n\n1. `cd` into that module's `tests` directory;\n2. ensure you have installed `pytest`, `hypothesis`, and any modules listed in\nthe `test-requirements.txt` file (all via `pip`);\n3. run `pytest`.\n\nWhen adding a new feature, please add a test for it. 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-qujax","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fcqcl%2Fpytket-qujax","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcqcl%2Fpytket-qujax/lists"}