flagquantum-compiler-qsteed 0.1.0__tar.gz

flagquantum_compiler_qsteed-0.1.0/LICENSE

@@ -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.

flagquantum_compiler_qsteed-0.1.0/MANIFEST.in

@@ -0,0 +1,3 @@
+include requirements-qsteed.txt
+include RELEASING.md
+recursive-include tests *.py

flagquantum_compiler_qsteed-0.1.0/PKG-INFO

@@ -0,0 +1,122 @@
+Metadata-Version: 2.4
+Name: flagquantum-compiler-qsteed
+Version: 0.1.0
+Summary: QSteed circuit compiler plugin for FlagQuantum
+License-Expression: Apache-2.0
+Project-URL: Repository, https://github.com/FlagQuantum/FlagQuantum-Compiler-QSteed
+Project-URL: Issues, https://github.com/FlagQuantum/FlagQuantum-Compiler-QSteed/issues
+Requires-Python: <3.13,>=3.10
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: flagquantum<0.3,>=0.2
+Requires-Dist: qsteed==0.2.3+quafu.sqc
+Provides-Extra: test
+Requires-Dist: pytest>=7; extra == "test"
+Dynamic: license-file
+
+# FlagQuantum Compiler QSteed
+
+`flagquantum-compiler-qsteed` is an independently installed circuit compiler
+plugin for FlagQuantum. It translates FlagQuantum `CircuitIR` to a PyQuafu
+`QuantumCircuit`, invokes QSteed's real transpiler, and translates the compiled
+circuit back to `CircuitIR`.
+
+The first release deliberately supports one closed, testable slice:
+
+- static `h`, `x`, `rx`, `ry`, `rz`, and `cx` instructions with numeric angles;
+- basis lowering to a selected subset of those gates, with topology routing on
+  the fixed six-gate basis;
+- an optional undirected coupling map over the circuit's existing wires;
+- deterministic QSteed basis lowering and SABRE routing;
+- restoration of QSteed's final physical layout to FlagQuantum's logical wire
+  order.
+- Quafu calibration targets with automatic or explicitly ordered physical
+  subgraph selection and a `target_qubits` result; physical identifiers never
+  replace logical QASM wires.
+
+Measurements, observables, symbolic parameters, custom matrices, dynamic
+operations, additional target fields, and larger physical topologies are
+rejected. There is no compiler substitution or fallback. Omitting
+`coupling_map` explicitly requests basis compilation without topology routing.
+For a Quafu `chip_info` target, omitting `target_qubits` lets QSteed choose the
+subgraph. Supplying it locks the logical-to-physical order after existence,
+uniqueness, and connectivity validation; the plugin never substitutes another
+mapping.
+
+## Installation
+
+This release candidate requires FlagQuantum `>=0.2,<0.3` and the verified
+QSteed build `0.2.3+quafu.sqc`. It is not yet a one-command PyPI installation:
+FlagQuantum 0.2 and this QSteed build must be installed first. PyPI QSteed 0.2.2
+is not a supported substitute. Python 3.12 was used for the release checks;
+the declared Python 3.10–3.12 range still needs a full compatibility matrix.
+
+From this repository, after installing a compatible FlagQuantum checkout:
+
+```bash
+python -m pip install -r requirements-qsteed.txt
+python -m pip install -e ".[test]"
+python -m pytest -q
+```
+
+The dependency file pins the verified upstream commit. The wheel declares its
+exact package version without embedding a Git URL. Once the plugin is published,
+users with both prerequisites already installed can use
+`python -m pip install flagquantum-compiler-qsteed==0.1.0`.
+
+## Compile a circuit
+
+This offline example needs no provider credentials and submits no hardware job:
+
+```python
+import flagquantum as fq
+
+circuit = fq.Circuit(3).h(0).cx(0, 2)
+compiled = fq.compile(
+    circuit,
+    compiler="qsteed",
+    target={
+        "basis_gates": ("h", "x", "rx", "ry", "rz", "cx"),
+        "coupling_map": ((0, 1), (1, 2)),
+    },
+)
+print(compiled.instructions)
+```
+
+See [release preparation](RELEASING.md) for publication prerequisites and
+artifact checks.
+
+## Advanced extension lifecycle
+
+```python
+from flagquantum.ecosystem.extensions import (
+    CapabilityRequest,
+    ExtensionConfig,
+    discover_extensions,
+)
+
+import flagquantum as fq
+
+source_ir = fq.Circuit(3).h(0).cx(0, 2).to_ir()
+registry = discover_extensions("compiler")
+handle = registry.negotiate(
+    "compiler",
+    "qsteed",
+    CapabilityRequest(required=frozenset({"circuit_ir"})),
+)
+handle.start(ExtensionConfig())
+try:
+    compiled = handle.invoke(
+        "compile",
+        source_ir,
+        target={
+            "basis_gates": ("h", "x", "rx", "ry", "rz", "cx"),
+            "coupling_map": ((0, 1), (1, 2)),
+        },
+    )
+finally:
+    handle.close()
+```
+
+QSteed treats the coupling graph as bidirectional in this compiler path. The
+plugin therefore validates two-wire instructions against undirected edges.

flagquantum_compiler_qsteed-0.1.0/README.md

@@ -0,0 +1,106 @@
+# FlagQuantum Compiler QSteed
+
+`flagquantum-compiler-qsteed` is an independently installed circuit compiler
+plugin for FlagQuantum. It translates FlagQuantum `CircuitIR` to a PyQuafu
+`QuantumCircuit`, invokes QSteed's real transpiler, and translates the compiled
+circuit back to `CircuitIR`.
+
+The first release deliberately supports one closed, testable slice:
+
+- static `h`, `x`, `rx`, `ry`, `rz`, and `cx` instructions with numeric angles;
+- basis lowering to a selected subset of those gates, with topology routing on
+  the fixed six-gate basis;
+- an optional undirected coupling map over the circuit's existing wires;
+- deterministic QSteed basis lowering and SABRE routing;
+- restoration of QSteed's final physical layout to FlagQuantum's logical wire
+  order.
+- Quafu calibration targets with automatic or explicitly ordered physical
+  subgraph selection and a `target_qubits` result; physical identifiers never
+  replace logical QASM wires.
+
+Measurements, observables, symbolic parameters, custom matrices, dynamic
+operations, additional target fields, and larger physical topologies are
+rejected. There is no compiler substitution or fallback. Omitting
+`coupling_map` explicitly requests basis compilation without topology routing.
+For a Quafu `chip_info` target, omitting `target_qubits` lets QSteed choose the
+subgraph. Supplying it locks the logical-to-physical order after existence,
+uniqueness, and connectivity validation; the plugin never substitutes another
+mapping.
+
+## Installation
+
+This release candidate requires FlagQuantum `>=0.2,<0.3` and the verified
+QSteed build `0.2.3+quafu.sqc`. It is not yet a one-command PyPI installation:
+FlagQuantum 0.2 and this QSteed build must be installed first. PyPI QSteed 0.2.2
+is not a supported substitute. Python 3.12 was used for the release checks;
+the declared Python 3.10–3.12 range still needs a full compatibility matrix.
+
+From this repository, after installing a compatible FlagQuantum checkout:
+
+```bash
+python -m pip install -r requirements-qsteed.txt
+python -m pip install -e ".[test]"
+python -m pytest -q
+```
+
+The dependency file pins the verified upstream commit. The wheel declares its
+exact package version without embedding a Git URL. Once the plugin is published,
+users with both prerequisites already installed can use
+`python -m pip install flagquantum-compiler-qsteed==0.1.0`.
+
+## Compile a circuit
+
+This offline example needs no provider credentials and submits no hardware job:
+
+```python
+import flagquantum as fq
+
+circuit = fq.Circuit(3).h(0).cx(0, 2)
+compiled = fq.compile(
+    circuit,
+    compiler="qsteed",
+    target={
+        "basis_gates": ("h", "x", "rx", "ry", "rz", "cx"),
+        "coupling_map": ((0, 1), (1, 2)),
+    },
+)
+print(compiled.instructions)
+```
+
+See [release preparation](RELEASING.md) for publication prerequisites and
+artifact checks.
+
+## Advanced extension lifecycle
+
+```python
+from flagquantum.ecosystem.extensions import (
+    CapabilityRequest,
+    ExtensionConfig,
+    discover_extensions,
+)
+
+import flagquantum as fq
+
+source_ir = fq.Circuit(3).h(0).cx(0, 2).to_ir()
+registry = discover_extensions("compiler")
+handle = registry.negotiate(
+    "compiler",
+    "qsteed",
+    CapabilityRequest(required=frozenset({"circuit_ir"})),
+)
+handle.start(ExtensionConfig())
+try:
+    compiled = handle.invoke(
+        "compile",
+        source_ir,
+        target={
+            "basis_gates": ("h", "x", "rx", "ry", "rz", "cx"),
+            "coupling_map": ((0, 1), (1, 2)),
+        },
+    )
+finally:
+    handle.close()
+```
+
+QSteed treats the coupling graph as bidirectional in this compiler path. The
+plugin therefore validates two-wire instructions against undirected edges.

flagquantum_compiler_qsteed-0.1.0/RELEASING.md

@@ -0,0 +1,42 @@
+# Release preparation
+
+Distribution: `flagquantum-compiler-qsteed` 0.1.0.
+Entry point: `flagquantum.extensions` / `compiler.qsteed`.
+
+## Prerequisites
+
+- Publish or otherwise provide the compatible FlagQuantum 0.2 release first.
+  PyPI FlagQuantum 0.1.1 does not satisfy this plugin's dependency.
+- The verified QSteed build is 0.2.3+quafu.sqc at the commit in
+  `requirements-qsteed.txt`. PyPI 0.2.2 failed the offline compilation suite
+  with an upstream `NameError` during import in the Python 3.12 check.
+- For now, users must install the pinned QSteed build separately. A complete
+  index-only installation requires an upstream indexed release that passes
+  these same tests. Do not widen the dependency just to make resolution succeed.
+- Create the intended GitHub repository before advertising its URL. Configure
+  the PyPI project and publisher using the maintainer's account; never commit
+  API tokens. Repository creation and package publication are separate actions.
+- Complete Python 3.10 and 3.11 compatibility runs before claiming that the
+  entire declared range is verified. Python 3.12 is the current tested baseline.
+
+## Validate and build
+
+Use a fresh environment with the compatible FlagQuantum release installed:
+
+```bash
+python -m pip install -r requirements-qsteed.txt
+python -m pip install -e '.[test]' build twine
+python -m pytest -q
+python -m build
+python -m twine check --strict dist/*
+```
+
+Install the wheel in another environment with the same dependencies. Run the
+README offline circuit compilation example from outside the source tree and
+confirm discovery through `fq.compile(..., compiler="qsteed")`. Check the
+sdist contains the license, README, dependency file, and tests. Inspect wheel
+metadata for the correct version, dependency constraints, and entry point.
+No test or release check needs to submit a real QPU task.
+
+Publish only the exact validated wheel and sdist. Publishing the plugin alone
+does not make its unavailable prerequisite releases appear on PyPI.

flagquantum_compiler_qsteed-0.1.0/pyproject.toml

@@ -0,0 +1,44 @@
+[build-system]
+requires = ["setuptools>=77", "wheel"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "flagquantum-compiler-qsteed"
+version = "0.1.0"
+description = "QSteed circuit compiler plugin for FlagQuantum"
+readme = "README.md"
+requires-python = ">=3.10,<3.13"
+license = "Apache-2.0"
+license-files = ["LICENSE"]
+dependencies = [
+    "flagquantum>=0.2,<0.3",
+    "qsteed==0.2.3+quafu.sqc",
+]
+
+[project.urls]
+Repository = "https://github.com/FlagQuantum/FlagQuantum-Compiler-QSteed"
+Issues = "https://github.com/FlagQuantum/FlagQuantum-Compiler-QSteed/issues"
+
+[project.optional-dependencies]
+test = [
+    "pytest>=7",
+]
+
+[project.entry-points."flagquantum.extensions"]
+"compiler.qsteed" = "flagquantum_compiler_qsteed:create_extension"
+
+[tool.setuptools.packages.find]
+where = ["src"]
+
+[tool.black]
+line-length = 88
+
+[tool.ruff]
+line-length = 88
+
+[tool.ruff.lint]
+select = ["E", "F", "I", "N", "W"]
+ignore = ["E501"]
+
+[tool.pytest.ini_options]
+testpaths = ["tests"]

flagquantum_compiler_qsteed-0.1.0/requirements-qsteed.txt

@@ -0,0 +1,2 @@
+# Verified upstream build; install before the plugin.
+qsteed @ git+https://github.com/BAQIS-Quantum/qsteed.git@46584efde731aea9eec27b5466919b76fe5f3184

flagquantum_compiler_qsteed-0.1.0/setup.cfg

@@ -0,0 +1,4 @@
+[egg_info]
+tag_build = 
+tag_date = 0
+

flagquantum_compiler_qsteed-0.1.0/src/flagquantum_compiler_qsteed/__init__.py

@@ -0,0 +1,5 @@
+"""QSteed compiler extension for FlagQuantum."""
+
+from .extension import QSteedCompiler, create_extension
+
+__all__ = ("QSteedCompiler", "create_extension")