qcec

MQT QCEC - A tool for Quantum Circuit Equivalence Checking

https://github.com/munich-quantum-toolkit/qcec

Science Score: 67.0%

This score indicates how likely this project is to be science-related based on various indicators:

  • CITATION.cff file
    Found CITATION.cff file
  • codemeta.json file
    Found codemeta.json file
  • .zenodo.json file
    Found .zenodo.json file
  • DOI references
    Found 2 DOI reference(s) in README
  • Academic publication links
    Links to: arxiv.org
  • Committers with academic emails
  • Institutional organization owner
  • JOSS paper metadata
  • Scientific vocabulary similarity
    Low similarity (11.4%) to scientific vocabulary

Keywords

cpp17 decision-diagrams equivalence-checker jku mqt python quantum-circuits quantum-computing tum verification zx-calculus

Keywords from Contributors

interpretability mesh energy-system-model standardization animations pipeline-testing parallel hacking energy-system exoplanet
Last synced: 6 months ago · JSON representation ·

Repository

MQT QCEC - A tool for Quantum Circuit Equivalence Checking

Basic Info
Statistics
  • Stars: 101
  • Watchers: 5
  • Forks: 24
  • Open Issues: 15
  • Releases: 62
Topics
cpp17 decision-diagrams equivalence-checker jku mqt python quantum-circuits quantum-computing tum verification zx-calculus
Created about 6 years ago · Last pushed 6 months ago
Metadata Files
Readme Changelog Contributing License Citation Security Support

README.md

PyPI OS License: MIT CI CD Documentation codecov

MQT Banner

MQT QCEC - A tool for Quantum Circuit Equivalence Checking

A tool for quantum circuit equivalence checking developed as part of the Munich Quantum Toolkit (MQT). It builds upon MQT Core, which forms the backbone of the MQT.

Documentation

Key Features

  • Comprehensive equivalence checking engines: Decision-diagram construction, Alternating DD, Simulation-based falsification, and ZX-calculus rewriting—coordinated in an automated equivalence checking flow to prove equivalence or quickly find counterexamples.
  • Compilation flow verification: validate transpiled/compiled circuits incl. layout permutations and measurements. Guide
  • Parameterized circuits: prove or refute equivalence with symbolic parameters. Guide
  • Partial equivalence: compare measured output distributions, handling ancillary and garbage qubits. Guide
  • Python-first API and Qiskit integration: pass QuantumCircuit or OpenQASM; one-call verify() or verify_compilation(). QuickstartAPI
  • Efficient and portable: C++20 core with DD engines and ZX backend, prebuilt wheels for Linux/macOS/Windows via PyPI.

If you have any questions, feel free to create a discussion or an issue on GitHub.

Contributors and Supporters

The Munich Quantum Toolkit (MQT) is developed by the Chair for Design Automation at the Technical University of Munich and supported by the Munich Quantum Software Company (MQSC). Among others, it is part of the Munich Quantum Software Stack (MQSS) ecosystem, which is being developed as part of the Munich Quantum Valley (MQV) initiative.

MQT Partner Logos

Thank you to all the contributors who have helped make MQT QCEC a reality!

Contributors to munich-quantum-toolkit/qcec

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)
  • Citing our research in your publications (see 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

Sponsor the MQT

Getting Started

MQT QCEC is available via PyPI for Linux, macOS, and Windows and supports Python 3.9 to 3.14.

console (venv) $ pip install mqt.qcec

The following code gives an example on the usage:

```python3 from mqt import qcec

verify the equivalence of two circuits provided as qasm files

result = qcec.verify("circ1.qasm", "circ2.qasm")

print the result

print(result.equivalence) ```

Detailed documentation on all available methods, options, and input formats is available at ReadTheDocs.

System Requirements and Building

The implementation is compatible with any C++20 compiler, a minimum CMake version of 3.24, and Python 3.9+. Please refer to the documentation on how to build the project.

Building (and running) is continuously tested under Linux, macOS, and Windows using the latest available system versions for GitHub Actions.

Cite This

Please cite the work that best fits your use case.

MQT QCEC (the tool)

When citing the software itself or results produced with it, cite the MQT QCEC paper:

bibtex @article{burgholzerQCECJKQTool2021, title = {{{QCEC}}: {{A JKQ}} tool for quantum circuit equivalence checking}, author = {Burgholzer, Lukas and Wille, Robert}, year = 2021, month = feb, journal = {Software Impacts}, doi = {10.1016/j.simpa.2020.100051} }

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 = {Wille, Robert and Berent, Lucas and Forster, Tobias and Kunasaikaran, Jagatheesan and Mato, Kevin and Peham, Tom and Quetschlich, Nils and Rovara, Damian and Sander, Aaron and Schmid, Ludwig and Schoenberger, Daniel and Stade, Yannick and Burgholzer, Lukas}, 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}} }

Peer-Reviewed Research

When citing the underlying methods and research, please reference the most relevant peer-reviewed publications from the list below:

[1] L. Burgholzer and R. Wille. Advanced Equivalence Checking for Quantum Circuits. IEEE Transactions on Computer-Aided Design of Integrated Circuits and Systems (TCAD), 2021.

[2] L. Burgholzer, R. Raymond, and R. Wille. Verifying Results of the IBM Qiskit Quantum Circuit Compilation Flow. In IEEE International Conference on Quantum Computing and Engineering (QCE), 2020.

[3] L. Burgholzer, R. Kueng, and R. Wille. Random Stimuli Generation for the Verification of Quantum Circuits. In Asia and South Pacific Design Automation Conference (ASP-DAC), 2021.

[4] L. Burgholzer and R. Wille. Handling Non-Unitaries in Quantum Circuit Equivalence Checking. In Design Automation Conference (DAC), 2022.

[5] T. Peham, L. Burgholzer, and R. Wille. Equivalence Checking of Quantum Circuits with the ZX-Calculus. IEEE Journal on Emerging and Selected Topics in Circuits and Systems (JETCAS), 2022.

[6] T. Peham, L. Burgholzer, and R. Wille. Equivalence Checking of Parameterized Quantum Circuits: Verifying the Compilation of Variational Quantum Algorithms. In Asia and South Pacific Design Automation Conference (ASP-DAC), 2023.


Acknowledgements

The Munich Quantum Toolkit has been supported by the European Research Council (ERC) under the European Union's Horizon 2020 research and innovation program (grant agreement No. 101001318), the Bavarian State Ministry for Science and Arts through the Distinguished Professorship Program, as well as the Munich Quantum Valley, which is supported by the Bavarian state government with funds from the Hightech Agenda Bayern Plus.

MQT Funding Footer

Owner

  • Name: The Munich Quantum Toolkit (MQT)
  • Login: munich-quantum-toolkit
  • Kind: organization
  • Email: lukas@munichquantum.software
  • Location: Germany

A collection of design automation tools and software for quantum computing

Citation (CITATION.cff)

cff-version: 1.2.0
title: MQT QCEC - A tool for Quantum Circuit Equivalence Checking
message: >-
  If you use this software, please cite both the article from preferred-citation and the software itself.
type: software
authors:
  - given-names: Lukas
    family-names: Burgholzer
    email: lukas.burgholzer@tum.de
    affiliation: 'Technical University of Munich, Germany'
    orcid: 'https://orcid.org/0000-0003-4699-1316'
  - given-names: Tom
    family-names: Peham
    email: tom.peham@tum.de
    affiliation: 'Technical University of Munich, Germany'
    orcid: 'https://orcid.org/0000-0003-3434-7881'
  - given-names: Robert
    family-names: Wille
    email: robert.wille@tum.de
    affiliation: 'Technical University of Munich, Germany'
    orcid: 'https://orcid.org/0000-0002-4993-7860'

identifiers:
  - type: doi
    value: 10.1109/TCAD.2020.3032630
  - type: url
    value: 'https://arxiv.org/abs/2004.08420'
url: 'https://mqt.readthedocs.io/projects/qcec'
license: MIT
preferred-citation:
    type: article
    title: "Advanced equivalence checking for quantum circuits"
    journal: "IEEE Transactions on CAD of Integrated Circuits and Systems"
    year: 2021
    month: 9
    doi: "10.1109/TCAD.2020.3032630"
    authors:
      - given-names: Lukas
        family-names: Burgholzer
        email: lukas.burgholzer@tum.de
        affiliation: 'Technical University of Munich, Germany'
        orcid: 'https://orcid.org/0000-0003-4699-1316'
      - given-names: Robert
        family-names: Wille
        email: robert.wille@tum.de
        affiliation: 'Technical University of Munich, Germany'
        orcid: 'https://orcid.org/0000-0002-4993-7860'

GitHub Events

Total
  • Create event: 57
  • Issues event: 7
  • Release event: 3
  • Watch event: 4
  • Delete event: 62
  • Issue comment event: 40
  • Push event: 153
  • Pull request review event: 64
  • Pull request review comment event: 46
  • Pull request event: 122
  • Fork event: 1
Last Year
  • Create event: 57
  • Issues event: 7
  • Release event: 3
  • Watch event: 4
  • Delete event: 62
  • Issue comment event: 40
  • Push event: 153
  • Pull request review event: 64
  • Pull request review comment event: 46
  • Pull request event: 122
  • Fork event: 1

Committers

Last synced: 9 months ago

All Time
  • Total Commits: 1,029
  • Total Committers: 9
  • Avg Commits per committer: 114.333
  • Development Distribution Score (DDS): 0.343
Past Year
  • Commits: 261
  • Committers: 5
  • Avg Commits per committer: 52.2
  • Development Distribution Score (DDS): 0.548
Top Committers
Name Email Commits
Lukas Burgholzer l****r@j****t 676
dependabot[bot] 4****] 120
renovate[bot] 2****] 118
pre-commit-ci[bot] 6****] 96
Tom Peham p****m@g****t 10
github-actions[bot] 4****] 5
Rebecca Ghidini 6****m 2
TeWas 6****s 1
Stefan Hillmich h****h 1
Committer Domains (Top 20 + Academic)
gmx.at: 1 jku.at: 1

Issues and Pull Requests

Last synced: 6 months ago

All Time
  • Total issues: 6
  • Total pull requests: 129
  • Average time to close issues: about 6 hours
  • Average time to close pull requests: 3 days
  • Total issue authors: 4
  • Total pull request authors: 6
  • Average comments per issue: 0.0
  • Average comments per pull request: 0.55
  • Merged pull requests: 113
  • Bot issues: 2
  • Bot pull requests: 102
Past Year
  • Issues: 6
  • Pull requests: 129
  • Average time to close issues: about 6 hours
  • Average time to close pull requests: 3 days
  • Issue authors: 4
  • Pull request authors: 6
  • Average comments per issue: 0.0
  • Average comments per pull request: 0.55
  • Merged pull requests: 113
  • Bot issues: 2
  • Bot pull requests: 102
Top Authors
Issue Authors
  • denialhaag (3)
  • burgholzer (1)
  • github-actions[bot] (1)
Pull Request Authors
  • renovate[bot] (94)
  • denialhaag (16)
  • burgholzer (10)
  • mqt-app[bot] (3)
  • github-actions[bot] (1)
  • pre-commit-ci[bot] (1)
Top Labels
Issue Labels
dependencies (4) python (4) minor (2) usability (1) packaging (1) bug (1) continuous integration (1) c++ (1)
Pull Request Labels
dependencies (103) pre-commit (60) python (29) documentation (11) github-actions (10) c++ (8) fix (4) code quality (2) usability (2) continuous integration (1)

Dependencies

setup.py pypi
  • qiskit-terra >=0.20.2,<0.22.0
.github/workflows/ci.yml actions
  • actions/checkout v3 composite
  • codecov/codecov-action v3.1.4 composite
.github/workflows/codeql-analysis.yml actions
  • actions/checkout v3 composite
  • advanced-security/filter-sarif main composite
  • github/codeql-action/analyze v2 composite
  • github/codeql-action/init v2 composite
  • github/codeql-action/upload-sarif v2 composite
.github/workflows/cpp-linter.yml actions
  • actions/checkout v3 composite
.github/workflows/deploy.yml actions
  • actions/checkout v3 composite
  • actions/download-artifact v3 composite
  • actions/setup-python v4 composite
  • actions/upload-artifact v3 composite
  • ilammy/msvc-dev-cmd v1 composite
  • pypa/cibuildwheel v2.14 composite
  • pypa/gh-action-pypi-publish release/v1 composite
.github/workflows/emulated-wheels.yml actions
  • actions/checkout v3 composite
  • actions/download-artifact v3 composite
  • actions/upload-artifact v3 composite
  • docker/setup-qemu-action v2 composite
  • pypa/cibuildwheel v2.14 composite
  • pypa/gh-action-pypi-publish release/v1 composite
.github/workflows/python-ci.yml actions
  • actions/checkout v3 composite
  • actions/setup-python v4 composite
  • codecov/codecov-action v3.1.4 composite
.github/workflows/release-drafter.yml actions
  • release-drafter/release-drafter v5 composite
pyproject.toml pypi
  • importlib_resources >=5.0; python_version < '3.10'
  • qiskit-terra >=0.20
  • typing_extensions >=4.2