Merge remote-tracking branch 'origin/main' into ystade/qdmi-device-add-features

Author: ystade

.github/workflows/ci_mlir.yml

@@ -30,7 +30,7 @@ jobs:
       FORCE_COLOR: 3
     steps:
       # check out the repository
-      - uses: actions/checkout@v4
+      - uses: actions/checkout@v5
         with:
           fetch-depth: 0
 
@@ -116,7 +116,7 @@ jobs:
       llvm-latest-tag: ${{ steps.get-latest.outputs.latest }}
     steps:
       # check out the repository
-      - uses: actions/checkout@v4
+      - uses: actions/checkout@v5
         with:
           fetch-depth: 0
 
@@ -228,7 +228,7 @@ jobs:
       FORCE_COLOR: 3
     steps:
       # Check out the repository
-      - uses: actions/checkout@v4
+      - uses: actions/checkout@v5
         with:
           fetch-depth: 0
 
@@ -303,7 +303,7 @@ jobs:
       id-token: write
     steps:
       # check out the repository
-      - uses: actions/checkout@v4
+      - uses: actions/checkout@v5
         with:
           fetch-depth: 0
 

.pre-commit-config.yaml

@@ -66,7 +66,7 @@ repos:
 
   # Python linting using ruff
   - repo: https://github.com/astral-sh/ruff-pre-commit
-    rev: v0.12.8
+    rev: v0.12.9
     hooks:
       - id: ruff
         args: ["--fix", "--show-fixes"]
@@ -122,7 +122,7 @@ repos:
 
   # Check for spelling
   - repo: https://github.com/crate-ci/typos
-    rev: v1.35.3
+    rev: v1.35.4
     hooks:
       - id: typos
 

CHANGELOG.md

@@ -11,6 +11,7 @@ This project adheres to [Semantic Versioning], with the exception that minor rel
 
 ### Added
 
+- ✨ Add `qubit` operation to the `MQTOpt` dialect for static qubit addressing ([#1116]) ([**@MatthiasReumann**])
 - ✨ Add MQT's implementation of a QDMI Driver ([#1010]) ([**@ystade**])
 - ✨ Add a copy of the NA QDMI Device that is always a shared library ([#1010]) ([**@ystade**])
 - ✨ Add translation from `QuantumComputation` to the `MQTRef` MLIR dialect ([#1099]) ([**@denialhaag**], [**@burgholzer**])
@@ -168,6 +169,7 @@ _📚 Refer to the [GitHub Release Notes](https://github.com/munich-quantum-tool
 
 <!-- PR links -->
 
+[#1116]: https://github.com/munich-quantum-toolkit/core/pull/1116
 [#1106]: https://github.com/munich-quantum-toolkit/core/pull/1106
 [#1099]: https://github.com/munich-quantum-toolkit/core/pull/1099
 [#1098]: https://github.com/munich-quantum-toolkit/core/pull/1098

README.md

@@ -9,10 +9,10 @@
 
 <p align="center">
   <a href="https://mqt.readthedocs.io">
-   <picture>
-     <source media="(prefers-color-scheme: dark)" srcset="https://raw.githubusercontent.com/munich-quantum-toolkit/.github/refs/heads/main/docs/_static/logo-mqt-dark.svg" width="60%">
-     <img src="https://raw.githubusercontent.com/munich-quantum-toolkit/.github/refs/heads/main/docs/_static/logo-mqt-light.svg" width="60%" alt="MQT Logo">
-   </picture>
+    <picture>
+      <source media="(prefers-color-scheme: dark)" srcset="https://raw.githubusercontent.com/munich-quantum-toolkit/.github/refs/heads/main/docs/_static/logo-mqt-dark.svg" width="60%">
+      <img src="https://raw.githubusercontent.com/munich-quantum-toolkit/.github/refs/heads/main/docs/_static/logo-mqt-light.svg" width="60%" alt="MQT Logo">
+    </picture>
   </a>
 </p>
 
@@ -41,17 +41,35 @@ Among others, it is part of the [Munich Quantum Software Stack (MQSS)](https://w
 
 <p align="center">
   <picture>
-   <source media="(prefers-color-scheme: dark)" srcset="https://raw.githubusercontent.com/munich-quantum-toolkit/.github/refs/heads/main/docs/_static/mqt-logo-banner-dark.svg" width="90%">
-   <img src="https://raw.githubusercontent.com/munich-quantum-toolkit/.github/refs/heads/main/docs/_static/mqt-logo-banner-light.svg" width="90%" alt="MQT Partner Logos">
+    <source media="(prefers-color-scheme: dark)" srcset="https://raw.githubusercontent.com/munich-quantum-toolkit/.github/refs/heads/main/docs/_static/mqt-logo-banner-dark.svg" width="90%">
+    <img src="https://raw.githubusercontent.com/munich-quantum-toolkit/.github/refs/heads/main/docs/_static/mqt-logo-banner-light.svg" width="90%" alt="MQT Partner Logos">
   </picture>
 </p>
 
 Thank you to all the contributors who have helped make MQT Core a reality!
 
 <p align="center">
-<a href="https://github.com/munich-quantum-toolkit/core/graphs/contributors">
+  <a href="https://github.com/munich-quantum-toolkit/core/graphs/contributors">
   <img src="https://contrib.rocks/image?repo=munich-quantum-toolkit/core" />
-</a>
+  </a>
+</p>
+
+The MQT will remain free, open-source, and permissively licensed—now and in the future.
+We are firmly committed to keeping it open and actively maintained for the quantum computing community.
+
+To support this endeavor, please consider:
+
+- Starring and sharing our repositories: https://github.com/munich-quantum-toolkit
+- Contributing code, documentation, tests, or examples via issues and pull requests
+- Citing the MQT in your publications (see [Cite This](#cite-this))
+- Citing our research in your publications (see [References](https://mqt.readthedocs.io/projects/core/en/latest/references.html))
+- Using the MQT in research and teaching, and sharing feedback and use cases
+- Sponsoring us on GitHub: https://github.com/sponsors/munich-quantum-toolkit
+
+<p align="center">
+  <a href="https://github.com/sponsors/munich-quantum-toolkit">
+  <img width=20% src="https://img.shields.io/badge/Sponsor-white?style=for-the-badge&logo=githubsponsors&labelColor=black&color=blue" alt="Sponsor the MQT" />
+  </a>
 </p>
 
 ## Getting Started
@@ -97,20 +115,43 @@ If you want to use the ZX library, it is recommended (although not strictly nece
 
 ## Cite This
 
-If you want to cite MQT Core, please use the following BibTeX entry:
+Please cite the work that best fits your use case.
+If both apply, include both references.
+
+### MQT Core (the tool)
+
+When citing the software itself or results produced with it, cite the MQT Core paper:
 
 ```bibtex
 @article{burgholzer2025MQTCore,
-    title     = {{{MQT Core}}: {{The}} Backbone of the {{Munich Quantum Toolkit (MQT)}}},
-    author    = {Lukas Burgholzer and Yannick Stade and Tom Peham and Robert Wille},
-    year      = {2025},
-    journal   = {Journal of Open Source Software},
-    publisher = {The Open Journal},
-    volume    = {10},
-    number    = {108},
-    pages     = {7478},
-    doi       = {10.21105/joss.07478},
-    url       = {https://doi.org/10.21105/joss.07478},
+    title        = {{{MQT Core}}: {{The}} Backbone of the {{Munich Quantum Toolkit (MQT)}}},
+    author       = {Lukas Burgholzer and Yannick Stade and Tom Peham and Robert Wille},
+    year         = 2025,
+    journal      = {Journal of Open Source Software},
+    publisher    = {The Open Journal},
+    volume       = 10,
+    number       = 108,
+    pages        = 7478,
+    doi          = {10.21105/joss.07478},
+    url          = {https://doi.org/10.21105/joss.07478},
+}
+```
+
+### The Munich Quantum Toolkit (the project)
+
+When discussing the overall MQT project or its ecosystem, cite the MQT Handbook:
+
+```bibtex
+@inproceedings{mqt,
+    title        = {The {{MQT}} Handbook: {{A}} Summary of Design Automation Tools and Software for Quantum Computing},
+    shorttitle   = {{The MQT Handbook}},
+    author       = {Robert Wille and Lucas Berent and Tobias Forster and Jagatheesan Kunasaikaran and Kevin Mato and Tom Peham and Nils Quetschlich and Damian Rovara and Aaron Sander and Ludwig Schmid and Daniel Schoenberger and Yannick Stade and Lukas Burgholzer},
+    booktitle    = {IEEE International Conference on Quantum Software (QSW)},
+    doi          = {10.1109/QSW62656.2024.00013},
+    year         = 2024,
+    eprint       = {2405.17543},
+    eprinttype   = {arxiv},
+    addendum     = {A live version of this document is available at \url{https://mqt.readthedocs.io}},
 }
 ```
 

docs/index.md

@@ -84,13 +84,11 @@ api/mqt/core/index
 api/cpp/namespacelist
 ```
 
-````{only} html
+```{only} html
 ## Contributors and Supporters
 
-The _[Munich Quantum Toolkit (MQT)](https://mqt.readthedocs.io)_ is developed by the [Chair for Design Automation](https://www.cda.cit.tum.de/) at the [Technical University of Munich](https://www.tum.de/)
-and supported by the [Munich Quantum Software Company (MQSC)](https://munichquantum.software).
-Among others, it is part of the [Munich Quantum Software Stack (MQSS)](https://www.munich-quantum-valley.de/research/research-areas/mqss) ecosystem,
-which is being developed as part of the [Munich Quantum Valley (MQV)](https://www.munich-quantum-valley.de) initiative.
+The _[Munich Quantum Toolkit (MQT)](https://mqt.readthedocs.io)_ is developed by the [Chair for Design Automation](https://www.cda.cit.tum.de/) at the [Technical University of Munich](https://www.tum.de/) and supported by the [Munich Quantum Software Company (MQSC)](https://munichquantum.software).
+Among others, it is part of the [Munich Quantum Software Stack (MQSS)](https://www.munich-quantum-valley.de/research/research-areas/mqss) ecosystem, which is being developed as part of the [Munich Quantum Valley (MQV)](https://www.munich-quantum-valley.de) initiative.
 
 <div style="margin-top: 0.5em">
 <div class="only-light" align="center">
@@ -109,22 +107,18 @@ Thank you to all the contributors who have helped make MQT Core a reality!
 </a>
 </p>
 
-## Cite This
-
-If you want to cite MQT Core, please use the following BibTeX entry:
-
-```bibtex
-@article{burgholzer2025MQTCore,
-  title     = {{{MQT Core}}: {{The}} Backbone of the {{Munich Quantum Toolkit (MQT)}}},
-  author    = {Lukas Burgholzer and Yannick Stade and Tom Peham and Robert Wille},
-  year      = {2025},
-  journal   = {Journal of Open Source Software},
-  publisher = {The Open Journal},
-  volume    = {10},
-  number    = {108},
-  pages     = {7478},
-  doi       = {10.21105/joss.07478},
-  url       = {https://doi.org/10.21105/joss.07478},
-}
+The MQT will remain free, open-source, and permissively licensed—now and in the future.
+We are firmly committed to keeping it open and actively maintained for the quantum computing community.
+
+To support this endeavor, please consider:
+
+- Starring and sharing our repositories: [https://github.com/munich-quantum-toolkit](https://github.com/munich-quantum-toolkit)
+- Contributing code, documentation, tests, or examples via issues and pull requests
+- Citing the MQT in your publications (see {doc}`References <references>`)
+- Using the MQT in research and teaching, and sharing feedback and use cases
+- Sponsoring us on GitHub: [https://github.com/sponsors/munich-quantum-toolkit](https://github.com/sponsors/munich-quantum-toolkit)
+
+<p align="center">
+<iframe src="https://github.com/sponsors/munich-quantum-toolkit/button" title="Sponsor munich-quantum-toolkit" height="32" width="114" style="border: 0; border-radius: 6px;"></iframe>
+</p>
 ```
-````

docs/references.md

@@ -4,14 +4,47 @@
 \phantomsection
 ```
 
-```{only} html
+````{only} html
 # References
+*MQT Core* is academic software. Thus, many of its built-in algorithms have been published as scientific papers.
+See {cite:p}`burgholzer2025MQTCore` for a general overview of *MQT Core* and its features.
+If you want to cite this article, please use the following BibTeX entry:
 
-If you use *MQT Core* in your work, we would appreciate if you cited {cite:p}`burgholzer2025MQTCore`.
+```bibtex
+@article{burgholzer2025MQTCore,
+    title        = {{{MQT Core}}: {{The}} Backbone of the {{Munich Quantum Toolkit (MQT)}}},
+    author       = {Lukas Burgholzer and Yannick Stade and Tom Peham and Robert Wille},
+    year         = 2025,
+    journal      = {Journal of Open Source Software},
+    publisher    = {The Open Journal},
+    volume       = 10,
+    number       = 108,
+    pages        = 7478,
+    doi          = {10.21105/joss.07478},
+    url          = {https://doi.org/10.21105/joss.07478},
+}
+```
 
-A full list of references is given below.
+*MQT Core* is part of the Munich Quantum Toolkit, which is described in {cite:p}`mqt`.
+If you want to cite the Munich Quantum Toolkit, please use the following BibTeX entry:
+
+```bibtex
+@inproceedings{mqt,
+    title        = {The {{MQT}} Handbook: {{A}} Summary of Design Automation Tools and Software for Quantum Computing},
+    shorttitle   = {{The MQT Handbook}},
+    author       = {Robert Wille and Lucas Berent and Tobias Forster and Jagatheesan Kunasaikaran and Kevin Mato and Tom Peham and Nils Quetschlich and Damian Rovara and Aaron Sander and Ludwig Schmid and Daniel Schoenberger and Yannick Stade and Lukas Burgholzer},
+    booktitle    = {IEEE International Conference on Quantum Software (QSW)},
+    doi          = {10.1109/QSW62656.2024.00013},
+    year         = 2024,
+    eprint       = {2405.17543},
+    eprinttype   = {arxiv},
+    addendum     = {A live version of this document is available at \url{https://mqt.readthedocs.io}},
+}
 ```
 
+A full list of references is given below.
+````
+
 ```{bibliography}
 
 ```

docs/refs.bib

@@ -211,6 +211,18 @@ @inproceedings{minatoZerosuppressedBDDsSet1993
   doi                 = {10.1145/157485.164890},
 }
 
+@inproceedings{mqt,
+  title               = {The {{MQT}} Handbook: {{A}} Summary of Design Automation Tools and Software for Quantum Computing},
+  shorttitle          = {The MQT Handbook},
+  author              = {Robert Wille and Lucas Berent and Tobias Forster and Jagatheesan Kunasaikaran and Kevin Mato and Tom Peham and Nils Quetschlich and Damian Rovara and Aaron Sander and Ludwig Schmid and Daniel Schoenberger and Yannick Stade and Lukas Burgholzer},
+  year                = {2024},
+  booktitle           = {IEEE International Conference on Quantum Software (QSW)},
+  doi                 = {10.1109/QSW62656.2024.00013},
+  eprint              = {2405.17543},
+  eprinttype          = {arxiv},
+  addendum            = {A live version of this document is available at \url{https://mqt.readthedocs.io}},
+}
+
 @inproceedings{niemannEfficientSynthesisQuantum2014,
   title               = {Efficient synthesis of quantum circuits implementing {{Clifford}} group operations},
   author              = {Niemann, Philipp and Wille, Robert and Drechsler, Rolf},

mlir/include/mlir/Dialect/MQTOpt/IR/MQTOptOps.td

@@ -49,6 +49,9 @@ def MQTOptDialect : Dialect {
         For more information, see the paper "QIRO:A Static Single Assignment
         based Quantum Program Representation for Optimization"
         (https://doi.org/10.1145/3491247)
+
+        The `mqtopt` dialect supports dynamic as well as static qubit
+        addressing.
     }];
 
     // The C++ namespace that the dialect, and all sub-components, get placed
@@ -71,7 +74,7 @@ class MQTOptType<string name, string typeMnemonic, list<Trait> traits = []>
 }
 
 def QubitType : MQTOptType<"Qubit", "Qubit"> {
-    let summary = "A value-semantic qubit (state).";
+    let summary = "A value-semantic (dynamic or static) qubit (state).";
 }
 
 def QregType : MQTOptType<"QubitRegister", "QubitRegister"> {
@@ -250,8 +253,10 @@ def InsertOp : ResourceOp<"insertQubit", [UniqueIndexDefinition]> {
         This class represents an operation that inserts a qubit back into a qubit
         register. Before, the same underlying qubit must have been extracted
         from the same register at the same index. However, this property is not
-        enforced by the dialect. It is naturally satisfied when a program in the
-        mqt input dialect is converted to the mqto dialect.
+        enforced by the dialect. Moreover, the dialect permits the (invalid) insertion
+        of static qubits into registers. The dialect avoids these issues by relying on
+        the fact that the conversion from `mqtref` to `mqtopt` will never produce these
+        invalid operations.
     }];
 
     let arguments = (ins
@@ -266,4 +271,24 @@ def InsertOp : ResourceOp<"insertQubit", [UniqueIndexDefinition]> {
     );
 }
 
+def QubitOp : ResourceOp<"qubit"> {
+    let summary = "Retrieve static qubit";
+    let description = [{
+        The `mqtopt.qubit` operation produces an SSA value from the given index
+        to a static (hardware) qubit.
+
+        Example:
+        ```mlir
+        // Static (hardware) qubit with address '0'.
+        %q = "mqtopt.qubit"() <{index = 0 : i64}> : () -> !mqtopt.Qubit
+
+        // Using custom assembly.
+        %q = mqtopt.qubit 0
+        ```
+    }];
+    let arguments = (ins ConfinedAttr<I64Attr, [IntNonNegative]>:$index);
+    let results = (outs QubitType:$qubit);
+    let assemblyFormat = " attr-dict $index ";
+}
+
 #endif // MQTOPT_OPS

mlir/lib/Conversion/MQTOptToMQTRef/MQTOptToMQTRef.cpp

@@ -173,6 +173,18 @@ struct ConvertMQTOptReset final : OpConversionPattern<opt::ResetOp> {
   }
 };
 
+struct ConvertMQTOptQubit final : OpConversionPattern<opt::QubitOp> {
+  using OpConversionPattern::OpConversionPattern;
+
+  LogicalResult
+  matchAndRewrite(opt::QubitOp op, OpAdaptor /*adaptor*/,
+                  ConversionPatternRewriter& rewriter) const override {
+    const auto& qubitType = ref::QubitType::get(rewriter.getContext());
+    rewriter.replaceOpWithNewOp<ref::QubitOp>(op, qubitType, op.getIndex());
+    return success();
+  }
+};
+
 template <typename MQTGateOptOp, typename MQTGateRefOp>
 struct ConvertMQTOptGateOp final : OpConversionPattern<MQTGateOptOp> {
   using OpConversionPattern<MQTGateOptOp>::OpConversionPattern;
@@ -232,10 +244,9 @@ struct MQTOptToMQTRef final : impl::MQTOptToMQTRefBase<MQTOptToMQTRef> {
     target.addIllegalDialect<opt::MQTOptDialect>();
     target.addLegalDialect<ref::MQTRefDialect>();
 
-    patterns
-        .add<ConvertMQTOptAlloc, ConvertMQTOptDealloc, ConvertMQTOptInsert,
-             ConvertMQTOptExtract, ConvertMQTOptMeasure, ConvertMQTOptReset>(
-            typeConverter, context);
+    patterns.add<ConvertMQTOptAlloc, ConvertMQTOptDealloc, ConvertMQTOptInsert,
+                 ConvertMQTOptExtract, ConvertMQTOptMeasure, ConvertMQTOptReset,
+                 ConvertMQTOptQubit>(typeConverter, context);
 
     ADD_CONVERT_PATTERN(GPhaseOp)
     ADD_CONVERT_PATTERN(IOp)