diff --git a/.envrc b/.envrc deleted file mode 100644 index faa8210a..00000000 --- a/.envrc +++ /dev/null @@ -1,3 +0,0 @@ -source_url "https://raw.githubusercontent.com/cachix/devenv/d1f7b48e35e6dee421cfd0f51481d17f77586997/direnvrc" "sha256-YBzqskFZxmNb3kYVoKD9ZixoPXJh1C9ZvTLGFRkauZ0=" - -use devenv diff --git a/.github/change-filters.yml b/.github/change-filters.yml index ba4e0fd0..229fcb10 100644 --- a/.github/change-filters.yml +++ b/.github/change-filters.yml @@ -16,5 +16,6 @@ python: - *rust-core - "tket2-py/**" - "tket2-eccs/**" + - "tket2-exts/**" - "pyproject.toml" - "uv.lock" diff --git a/.github/dependabot.yml b/.github/dependabot.yml index 85ca9310..326bb7de 100644 --- a/.github/dependabot.yml +++ b/.github/dependabot.yml @@ -29,6 +29,7 @@ updates: - "/" - "/tket2-py" - "/tket2-eccs" + - "/tket2-exts" schedule: interval: "weekly" commit-message: diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml index 1a673c73..5e6cb722 100644 --- a/.github/workflows/ci.yml +++ b/.github/workflows/ci.yml @@ -290,10 +290,12 @@ jobs: run: just gen-extensions - name: Check if the declarations are up to date run: | - git diff --exit-code --name-only tket2-py/tket2/extensions/_json_defs + git diff --exit-code --name-only tket2-exts/src/tket2_exts/data if [ $? -ne 0 ]; then echo "The serialized standard extensions are not up to date" - echo "Please run 'just gen-extensions' and commit the changes" + echo "Please run 'just gen-extensions' and commit the changes. + Bump the version of tket2-exts according to semver. + " exit 1 fi diff --git a/.github/workflows/python-pure-wheels.yml b/.github/workflows/python-pure-wheels.yml index 7f2483da..990339cf 100644 --- a/.github/workflows/python-pure-wheels.yml +++ b/.github/workflows/python-pure-wheels.yml @@ -30,6 +30,7 @@ jobs: matrix: target: - { dir: tket2-eccs, name: tket2_eccs, key_secret: PYPI_PUBLISH_TKET2_ECCS } + - { dir: tket2-exts, name: tket2_exts, key_secret: PYPI_PUBLISH_TKET2_EXTS } steps: # Check the release tag against the package name # diff --git a/.gitignore b/.gitignore index a35657ac..6ab0ae6a 100644 --- a/.gitignore +++ b/.gitignore @@ -24,3 +24,4 @@ lcov.info # local cargo config /.cargo/config.toml +.envrc diff --git a/justfile b/justfile index 8b9d0035..c0fc3611 100644 --- a/justfile +++ b/justfile @@ -46,7 +46,7 @@ recompile-eccs: # Generate serialized declarations for the tket2 extensions gen-extensions: - cargo run -p tket2-hseries gen-extensions -o tket2-py/tket2/extensions/_json_defs + cargo run -p tket2-hseries gen-extensions -o tket2-exts/src/tket2_exts/data # Runs a rust and a python command, depending on the `language` variable. # diff --git a/pyproject.toml b/pyproject.toml index 647c130a..a98be24e 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -1,5 +1,5 @@ [tool.uv.workspace] -members = ["tket2-py", "tket2-eccs"] +members = ["tket2-py", "tket2-eccs", "tket2-exts"] [tool.uv] diff --git a/release-please-config.json b/release-please-config.json index ccc34307..821ecd05 100644 --- a/release-please-config.json +++ b/release-please-config.json @@ -24,6 +24,15 @@ "draft": false, "prerelease": false, "draft-pull-request": true + }, + "tket2-exts": { + "release-type": "python", + "component": "tket2-exts", + "package-name": "tket2_exts", + "include-component-in-tag": true, + "draft": false, + "prerelease": false, + "draft-pull-request": true } }, "changelog-sections": [ diff --git a/tket2-eccs/README.md b/tket2-eccs/README.md index 618b0d6e..d4df3a38 100644 --- a/tket2-eccs/README.md +++ b/tket2-eccs/README.md @@ -1,12 +1,12 @@ # tket2-eccs -[![pypi][]](https://pypi.org/project/tket2/) +[![pypi][]](https://pypi.org/project/tket2-eccs/) [![codecov][]](https://codecov.io/gh/CQCL/tket2) -[![py-version][]](https://pypi.org/project/tket2/) +[![py-version][]](https://pypi.org/project/tket2--eccs/) [codecov]: https://img.shields.io/codecov/c/gh/CQCL/tket2?logo=codecov - [py-version]: https://img.shields.io/pypi/pyversions/tket2 - [pypi]: https://img.shields.io/pypi/v/tket2 + [py-version]: https://img.shields.io/pypi/pyversions/tket2-eccs + [pypi]: https://img.shields.io/pypi/v/tket2-eccs This is an auxiliary Python package containing compiler rewrite sets used for `tket2`'s optimisation passes. diff --git a/tket2-exts/.gitignore b/tket2-exts/.gitignore new file mode 100644 index 00000000..a7ea2e93 --- /dev/null +++ b/tket2-exts/.gitignore @@ -0,0 +1,2 @@ +# Python wheel artifacts +dist diff --git a/tket2-exts/CHANGELOG.md b/tket2-exts/CHANGELOG.md new file mode 100644 index 00000000..07012a73 --- /dev/null +++ b/tket2-exts/CHANGELOG.md @@ -0,0 +1,8 @@ +# Changelog + +## 0.1.0 (2024-11-06) + + +### Features + +* Add tket2 extension definitions. diff --git a/tket2-exts/LICENCE b/tket2-exts/LICENCE new file mode 100644 index 00000000..261eeb9e --- /dev/null +++ b/tket2-exts/LICENCE @@ -0,0 +1,201 @@ + Apache License + Version 2.0, January 2004 + http://www.apache.org/licenses/ + + TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION + + 1. Definitions. + + "License" shall mean the terms and conditions for use, reproduction, + and distribution as defined by Sections 1 through 9 of this document. + + "Licensor" shall mean the copyright owner or entity authorized by + the copyright owner that is granting the License. + + "Legal Entity" shall mean the union of the acting entity and all + other entities that control, are controlled by, or are under common + control with that entity. For the purposes of this definition, + "control" means (i) the power, direct or indirect, to cause the + direction or management of such entity, whether by contract or + otherwise, or (ii) ownership of fifty percent (50%) or more of the + outstanding shares, or (iii) beneficial ownership of such entity. + + "You" (or "Your") shall mean an individual or Legal Entity + exercising permissions granted by this License. + + "Source" form shall mean the preferred form for making modifications, + including but not limited to software source code, documentation + source, and configuration files. + + "Object" form shall mean any form resulting from mechanical + transformation or translation of a Source form, including but + not limited to compiled object code, generated documentation, + and conversions to other media types. + + "Work" shall mean the work of authorship, whether in Source or + Object form, made available under the License, as indicated by a + copyright notice that is included in or attached to the work + (an example is provided in the Appendix below). + + "Derivative Works" shall mean any work, whether in Source or Object + form, that is based on (or derived from) the Work and for which the + editorial revisions, annotations, elaborations, or other modifications + represent, as a whole, an original work of authorship. For the purposes + of this License, Derivative Works shall not include works that remain + separable from, or merely link (or bind by name) to the interfaces of, + the Work and Derivative Works thereof. + + "Contribution" shall mean any work of authorship, including + the original version of the Work and any modifications or additions + to that Work or Derivative Works thereof, that is intentionally + submitted to Licensor for inclusion in the Work by the copyright owner + or by an individual or Legal Entity authorized to submit on behalf of + the copyright owner. For the purposes of this definition, "submitted" + means any form of electronic, verbal, or written communication sent + to the Licensor or its representatives, including but not limited to + communication on electronic mailing lists, source code control systems, + and issue tracking systems that are managed by, or on behalf of, the + Licensor for the purpose of discussing and improving the Work, but + excluding communication that is conspicuously marked or otherwise + designated in writing by the copyright owner as "Not a Contribution." + + "Contributor" shall mean Licensor and any individual or Legal Entity + on behalf of whom a Contribution has been received by Licensor and + subsequently incorporated within the Work. + + 2. Grant of Copyright License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + copyright license to reproduce, prepare Derivative Works of, + publicly display, publicly perform, sublicense, and distribute the + Work and such Derivative Works in Source or Object form. + + 3. Grant of Patent License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + (except as stated in this section) patent license to make, have made, + use, offer to sell, sell, import, and otherwise transfer the Work, + where such license applies only to those patent claims licensable + by such Contributor that are necessarily infringed by their + Contribution(s) alone or by combination of their Contribution(s) + with the Work to which such Contribution(s) was submitted. If You + institute patent litigation against any entity (including a + cross-claim or counterclaim in a lawsuit) alleging that the Work + or a Contribution incorporated within the Work constitutes direct + or contributory patent infringement, then any patent licenses + granted to You under this License for that Work shall terminate + as of the date such litigation is filed. + + 4. Redistribution. You may reproduce and distribute copies of the + Work or Derivative Works thereof in any medium, with or without + modifications, and in Source or Object form, provided that You + meet the following conditions: + + (a) You must give any other recipients of the Work or + Derivative Works a copy of this License; and + + (b) You must cause any modified files to carry prominent notices + stating that You changed the files; and + + (c) You must retain, in the Source form of any Derivative Works + that You distribute, all copyright, patent, trademark, and + attribution notices from the Source form of the Work, + excluding those notices that do not pertain to any part of + the Derivative Works; and + + (d) If the Work includes a "NOTICE" text file as part of its + distribution, then any Derivative Works that You distribute must + include a readable copy of the attribution notices contained + within such NOTICE file, excluding those notices that do not + pertain to any part of the Derivative Works, in at least one + of the following places: within a NOTICE text file distributed + as part of the Derivative Works; within the Source form or + documentation, if provided along with the Derivative Works; or, + within a display generated by the Derivative Works, if and + wherever such third-party notices normally appear. The contents + of the NOTICE file are for informational purposes only and + do not modify the License. You may add Your own attribution + notices within Derivative Works that You distribute, alongside + or as an addendum to the NOTICE text from the Work, provided + that such additional attribution notices cannot be construed + as modifying the License. + + You may add Your own copyright statement to Your modifications and + may provide additional or different license terms and conditions + for use, reproduction, or distribution of Your modifications, or + for any such Derivative Works as a whole, provided Your use, + reproduction, and distribution of the Work otherwise complies with + the conditions stated in this License. + + 5. Submission of Contributions. Unless You explicitly state otherwise, + any Contribution intentionally submitted for inclusion in the Work + by You to the Licensor shall be under the terms and conditions of + this License, without any additional terms or conditions. + Notwithstanding the above, nothing herein shall supersede or modify + the terms of any separate license agreement you may have executed + with Licensor regarding such Contributions. + + 6. Trademarks. This License does not grant permission to use the trade + names, trademarks, service marks, or product names of the Licensor, + except as required for reasonable and customary use in describing the + origin of the Work and reproducing the content of the NOTICE file. + + 7. Disclaimer of Warranty. Unless required by applicable law or + agreed to in writing, Licensor provides the Work (and each + Contributor provides its Contributions) on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or + implied, including, without limitation, any warranties or conditions + of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A + PARTICULAR PURPOSE. You are solely responsible for determining the + appropriateness of using or redistributing the Work and assume any + risks associated with Your exercise of permissions under this License. + + 8. Limitation of Liability. In no event and under no legal theory, + whether in tort (including negligence), contract, or otherwise, + unless required by applicable law (such as deliberate and grossly + negligent acts) or agreed to in writing, shall any Contributor be + liable to You for damages, including any direct, indirect, special, + incidental, or consequential damages of any character arising as a + result of this License or out of the use or inability to use the + Work (including but not limited to damages for loss of goodwill, + work stoppage, computer failure or malfunction, or any and all + other commercial damages or losses), even if such Contributor + has been advised of the possibility of such damages. + + 9. Accepting Warranty or Additional Liability. While redistributing + the Work or Derivative Works thereof, You may choose to offer, + and charge a fee for, acceptance of support, warranty, indemnity, + or other liability obligations and/or rights consistent with this + License. However, in accepting such obligations, You may act only + on Your own behalf and on Your sole responsibility, not on behalf + of any other Contributor, and only if You agree to indemnify, + defend, and hold each Contributor harmless for any liability + incurred by, or claims asserted against, such Contributor by reason + of your accepting any such warranty or additional liability. + + END OF TERMS AND CONDITIONS + + APPENDIX: How to apply the Apache License to your work. + + To apply the Apache License to your work, attach the following + boilerplate notice, with the fields enclosed by brackets "[]" + replaced with your own identifying information. (Don't include + the brackets!) The text should be enclosed in the appropriate + comment syntax for the file format. We also recommend that a + file or class name and description of purpose be included on the + same "printed page" as the copyright notice for easier + identification within third-party archives. + + Copyright [yyyy] [name of copyright owner] + + Licensed under the Apache License, Version 2.0 (the "License"); + you may not use this file except in compliance with the License. + You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. diff --git a/tket2-exts/README.md b/tket2-exts/README.md new file mode 100644 index 00000000..72ee91fd --- /dev/null +++ b/tket2-exts/README.md @@ -0,0 +1,36 @@ +# tket2-exts + +[![pypi][]](https://pypi.org/project/tket2-exts/) +[![codecov][]](https://codecov.io/gh/CQCL/tket2) +[![py-version][]](https://pypi.org/project/tket2-exts/) + + [codecov]: https://img.shields.io/codecov/c/gh/CQCL/tket2?logo=codecov + [py-version]: https://img.shields.io/pypi/pyversions/tket2-exts + [pypi]: https://img.shields.io/pypi/v/tket2-exts + +This is an auxiliary Python package containing HUGR extension definitions for `tket2`. + +This package is intended to be used as an internal dependency for `tket2`. +See https://pypi.org/project/tket2/ for the main package. + + +## Install + +TKET2-exts can be installed via `pip`. + +```sh +pip install tket2_exts +``` + +## Development + +See [DEVELOPMENT.md] information on how to develop and contribute to this package. + + [DEVELOPMENT.md]: https://github.com/CQCL/tket2/blob/main/DEVELOPMENT.md + + +## License + +This project is licensed under Apache License, Version 2.0 ([LICENCE][] or http://www.apache.org/licenses/LICENSE-2.0). + + [LICENCE]: https://github.com/CQCL/tket2/blob/main/LICENCE diff --git a/tket2-exts/pyproject.toml b/tket2-exts/pyproject.toml new file mode 100644 index 00000000..47fe6961 --- /dev/null +++ b/tket2-exts/pyproject.toml @@ -0,0 +1,39 @@ +[project] +name = "tket2-exts" +version = "0.1.0" +requires-python = ">=3.10" +description = "HUGR extension definitions for the tket2 compiler." +license = { file = "LICENCE" } +readme = "README.md" +authors = [ + { name = "TKET development team", email = "tket-support@quantinuum.com" }, +] +maintainers = [ + { name = "TKET development team", email = "tket-support@quantinuum.com" }, +] +classifiers = [ + "Environment :: Console", + "Programming Language :: Python :: 3.10", + "Programming Language :: Python :: 3.11", + "Programming Language :: Python :: 3.12", + "Programming Language :: Python :: 3.13", + "License :: OSI Approved :: Apache Software License", + "Operating System :: MacOS :: MacOS X", + "Operating System :: POSIX :: Linux", + "Operating System :: Microsoft :: Windows", + "Intended Audience :: Developers", + "Intended Audience :: Science/Research", + "Topic :: Scientific/Engineering", +] + +dependencies = [ + "hugr>=0.9.0", +] + +[project.urls] +homepage = "https://github.com/CQCL/tket2/tree/main/tket2-exts" +repository = "https://github.com/CQCL/tket2/tree/main/tket2-exts" + +[build-system] +requires = ["hatchling"] +build-backend = "hatchling.build" diff --git a/tket2-exts/src/tket2_exts/__init__.py b/tket2-exts/src/tket2_exts/__init__.py new file mode 100644 index 00000000..3c5e586b --- /dev/null +++ b/tket2-exts/src/tket2_exts/__init__.py @@ -0,0 +1,38 @@ +"""Hugr extension definitions for tket2 circuits.""" + +import pkgutil +import functools + +from hugr.ext import Extension + + +@functools.cache +def rotation() -> Extension: + return load_extension("tket2.rotation") + + +@functools.cache +def futures() -> Extension: + return load_extension("tket2.futures") + + +@functools.cache +def hseries() -> Extension: + return load_extension("tket2.hseries") + + +@functools.cache +def quantum() -> Extension: + return load_extension("tket2.quantum") + + +@functools.cache +def result() -> Extension: + return load_extension("tket2.result") + + +def load_extension(name: str) -> Extension: + replacement = name.replace(".", "/") + json_str = pkgutil.get_data(__name__, f"data/{replacement}.json") + assert json_str is not None, f"Could not load json for extension {name}" + return Extension.from_json(json_str.decode()) diff --git a/tket2-py/tket2/extensions/_json_defs/tket2/futures.json b/tket2-exts/src/tket2_exts/data/tket2/futures.json similarity index 100% rename from tket2-py/tket2/extensions/_json_defs/tket2/futures.json rename to tket2-exts/src/tket2_exts/data/tket2/futures.json diff --git a/tket2-py/tket2/extensions/_json_defs/tket2/hseries.json b/tket2-exts/src/tket2_exts/data/tket2/hseries.json similarity index 100% rename from tket2-py/tket2/extensions/_json_defs/tket2/hseries.json rename to tket2-exts/src/tket2_exts/data/tket2/hseries.json diff --git a/tket2-py/tket2/extensions/_json_defs/tket2/quantum.json b/tket2-exts/src/tket2_exts/data/tket2/quantum.json similarity index 100% rename from tket2-py/tket2/extensions/_json_defs/tket2/quantum.json rename to tket2-exts/src/tket2_exts/data/tket2/quantum.json diff --git a/tket2-py/tket2/extensions/_json_defs/tket2/result.json b/tket2-exts/src/tket2_exts/data/tket2/result.json similarity index 100% rename from tket2-py/tket2/extensions/_json_defs/tket2/result.json rename to tket2-exts/src/tket2_exts/data/tket2/result.json diff --git a/tket2-py/tket2/extensions/_json_defs/tket2/rotation.json b/tket2-exts/src/tket2_exts/data/tket2/rotation.json similarity index 100% rename from tket2-py/tket2/extensions/_json_defs/tket2/rotation.json rename to tket2-exts/src/tket2_exts/data/tket2/rotation.json diff --git a/tket2-exts/src/tket2_exts/py.typed b/tket2-exts/src/tket2_exts/py.typed new file mode 100644 index 00000000..e69de29b diff --git a/tket2-py/pyproject.toml b/tket2-py/pyproject.toml index b62678b9..fb244339 100644 --- a/tket2-py/pyproject.toml +++ b/tket2-py/pyproject.toml @@ -30,10 +30,12 @@ dependencies = [ 'pytket >= 1.34, < 2', 'hugr >= 0.9.0, < 0.10', 'tket2_eccs >= 0.2.0, < 0.3', + 'tket2_exts >= 0.1.0, < 0.2', ] [tool.uv.sources] tket2_eccs = { workspace = true } +tket2_exts = { workspace = true } [project.urls] homepage = "https://github.com/CQCL/tket2/tree/main/tket2-py" diff --git a/tket2-py/tket2/extensions/__init__.py b/tket2-py/tket2/extensions/__init__.py index aeec8f22..c90c382d 100644 --- a/tket2-py/tket2/extensions/__init__.py +++ b/tket2-py/tket2/extensions/__init__.py @@ -1,42 +1,4 @@ -"""Hugr extension definitions for tket2 circuits.""" -# This will be moved to a separate python library soon. +from tket2_exts import rotation, futures, hseries, quantum, result -import pkgutil -import functools -from hugr._serialization.extension import Extension as PdExtension -from hugr.ext import Extension - - -@functools.cache -def rotation() -> Extension: - return load_extension("tket2.rotation") - - -@functools.cache -def futures() -> Extension: - return load_extension("tket2.futures") - - -@functools.cache -def hseries() -> Extension: - return load_extension("tket2.hseries") - - -@functools.cache -def quantum() -> Extension: - return load_extension("tket2.quantum") - - -@functools.cache -def result() -> Extension: - return load_extension("tket2.result") - - -def load_extension(name: str) -> Extension: - replacement = name.replace(".", "/") - json_str = pkgutil.get_data(__name__, f"_json_defs/{replacement}.json") - assert json_str is not None, f"Could not load json for extension {name}" - # TODO: Replace with `Extension.from_json` once that is implemented - # https://github.com/CQCL/hugr/issues/1523 - return PdExtension.model_validate_json(json_str).deserialize() +__all__ = ["rotation", "futures", "hseries", "quantum", "result"] diff --git a/uv.lock b/uv.lock index 5ff96b06..a11c8bb6 100644 --- a/uv.lock +++ b/uv.lock @@ -9,6 +9,7 @@ resolution-markers = [ members = [ "tket2", "tket2-eccs", + "tket2-exts", ] requirements = [ { name = "graphviz", specifier = ">=0.20,<0.21" }, @@ -795,6 +796,7 @@ dependencies = [ { name = "hugr" }, { name = "pytket" }, { name = "tket2-eccs" }, + { name = "tket2-exts" }, ] [package.metadata] @@ -802,6 +804,7 @@ requires-dist = [ { name = "hugr", specifier = ">=0.9.0,<0.10" }, { name = "pytket", specifier = ">=1.34,<2" }, { name = "tket2-eccs", editable = "tket2-eccs" }, + { name = "tket2-exts", editable = "tket2-exts" }, ] [[package]] @@ -809,6 +812,17 @@ name = "tket2-eccs" version = "0.2.0" source = { editable = "tket2-eccs" } +[[package]] +name = "tket2-exts" +version = "0.1.0" +source = { editable = "tket2-exts" } +dependencies = [ + { name = "hugr" }, +] + +[package.metadata] +requires-dist = [{ name = "hugr", specifier = ">=0.9.0" }] + [[package]] name = "tomli" version = "2.0.1"