mqt-qcec

This small release improves/fixes the internal equivalence checking flow logic for inferring a final result from the results of all individual checkers (fixes #240).
It also features more useful logging messages in some corner cases and issues a warning if the compilation flow verification scheme is used, but the circuits under consideration contain no measurements.

What's Changed

• 🚸 Warning for missing measurements by @burgholzer in https://github.com/cda-tum/qcec/pull/239
• 💡♻️ Improve corner-case logic for infering check result by @burgholzer in https://github.com/cda-tum/qcec/pull/241

Full Changelog: https://github.com/cda-tum/qcec/compare/v2.2.0...v2.2.1

This release drops support for Python 3.7 (in accordance with its deprecation in Qiskit).
Furthermore, it contains some internal usability updates and resolves a couple of outstanding issues.

What's Changed

• 🐍🔥 Drop Python 3.7 support by @burgholzer in https://github.com/cda-tum/qcec/pull/229
• 🔧 Pre-Commit Updates by @burgholzer in https://github.com/cda-tum/qcec/pull/230
• 🚸 Improved Python Typing by @burgholzer in https://github.com/cda-tum/qcec/pull/231
• ♻️ Simplify Timeout Handling by @burgholzer in https://github.com/cda-tum/qcec/pull/232
• 🚸♻️ Streamline C++-Python Interface for EquivalenceCheckingManager by @burgholzer in https://github.com/cda-tum/qcec/pull/233
• 🐛 Fix compatibility check in alternating checker by @burgholzer in https://github.com/cda-tum/qcec/pull/237

Full Changelog: https://github.com/cda-tum/qcec/compare/v2.1.3...v2.2.0

This release brings some quality of life improvements to the internals of the QCEC library.
First of all, it updates the core/intermediate-representation library (QFR) to its latest version, which is now much more independent from the underlying DD package thanks to cda-tum/qfr#244. The core library itself has seen quite some internal updates and code quality fixes.
Secondly, this PR adds better templating to the DD-related functions that allows for better IDE/autocompletion support.
Last but not least, it updates the CMake structure of the project based on cda-tum/dd_package/pull/125 as well as cda-tum/qfr/pull/246 to include more warnings, a simpler structure, unified compilation options and much more.

What's Changed

• 🚑 Fixup for newest QFR version by @burgholzer in https://github.com/cda-tum/qcec/pull/221
• 🚸 Better DD package templating by @burgholzer in https://github.com/cda-tum/qcec/pull/222
• ♻️ Refactor CMake Configuration by @burgholzer in https://github.com/cda-tum/qcec/pull/223

Full Changelog: https://github.com/cda-tum/qcec/compare/v2.1.2...v2.1.3

What's Changed

• 🚨 Type stubs and better mypy integration by @burgholzer in https://github.com/cda-tum/qcec/pull/203
• 🔧 Only cancel repeated CI jobs for Pull Requests by @burgholzer in https://github.com/cda-tum/qcec/pull/204
• 🍱 Add MQT Logo and support Dark-Mode on RtD by @burgholzer in https://github.com/cda-tum/qcec/pull/214

Full Changelog: https://github.com/cda-tum/qcec/compare/v2.1.1...v2.1.2

This tiny release fixes a bug in the ZX-checker that led to false positives (fix by @pehamTom in https://github.com/cda-tum/qcec/pull/201).

Full Changelog: https://github.com/cda-tum/qcec/compare/v2.1.0...v2.1.1

This release brings lots of CI/CD improvements to QCEC. Most importantly, with this release QCEC offers binary wheels for all platforms that Qiskit offers them. Furthermore, it drops the superfluous retworkx requirement from QCEC.

Additions

• 👷 CI workflow for (emulated) s390x and ppc64le wheels by @burgholzer in https://github.com/cda-tum/qcec/pull/198
• ✨ Cirrus CI for natively building Apple Silicon and Linux ARM wheels by @burgholzer in https://github.com/cda-tum/qcec/pull/192
• 📦 Support Versioning in Git Archives by @burgholzer in https://github.com/cda-tum/qcec/pull/187
• 🐍 Python 3.11 tests by @burgholzer in https://github.com/cda-tum/qcec/pull/193

Removals

• 🔥Remove retworkx requirement by @dependabot in https://github.com/cda-tum/qcec/pull/186
• 🔥Drop LGTM by @burgholzer in https://github.com/cda-tum/qcec/pull/194
• 🔥Drop deprecated JKQ shim by @burgholzer in https://github.com/cda-tum/qcec/pull/195
• 🔥musllinux wheels are no longer available as of this release since Qiskit does not provide them as well

Full Changelog: https://github.com/cda-tum/qcec/compare/v2.0.0...v2.1.0

Should be good now.

Another try for publishing.

As expected, this might take a few tries.

This is a pre-release to test the new Cirrus CI infrastructure for publishing Apple Silicon and Linux ARM wheels.

What's Changed

• 📦 Support Versioning in Git Archives by @burgholzer in https://github.com/cda-tum/qcec/pull/187
• ❄️ Potential fix for flaky Python test by @burgholzer in https://github.com/cda-tum/qcec/pull/189
• 🐍⚡🔧 Improve Python Testing Configuration by @burgholzer in https://github.com/cda-tum/qcec/pull/190
• 🔥 Remove retworkx requirement by @dependabot in https://github.com/cda-tum/qcec/pull/186
• ✨ Cirrus CI by @burgholzer in https://github.com/cda-tum/qcec/pull/192

Full Changelog: https://github.com/cda-tum/qcec/compare/v2.0.0...v2.1.0-rc1

Long time in the making, but now it's finally here: QCEC 2.0.0 🥳

What's Changed

This major release refactors and improves many aspects of QCEC in order to make it more scalable, efficient, and extendable.
At the same time, lots of effort has gone into ensuring proper code quality and providing informative documentation.

✨ New Features

• Automated Equivalence Checking Flow (including parallelization 🧵) envisioned in

  Lukas Burgholzer and Robert Wille. Advanced equivalence checking for quantum circuits. IEEE Transactions on CAD of Integrated Circuits and Systems, 2021. (arXiv:2004.08420)

• Automated generation of compilation flow profiles as good oracles for equivalence checking based on

  Lukas Burgholzer, Rudy Raymond, and Robert Wille. Verifying results of the IBM Qiskit quantum circuit compilation flow. In International Conference on Quantum Computing and Engineering. 2020. (arXiv:2009.02376)

• ZX-Calculus Equivalence Checker based on

  Tom Peham, Lukas Burgholzer, and Robert Wille. Equivalence checking of quantum circuits with the ZX-calculus. Journal of Emerging and Selected Topics in Circuits and Systems, 2022. (arXiv:2208.12820)

• Equivalence Checking of Parameterized Quantum Circuits based on

  Tom Peham, Lukas Burgholzer, and Robert Wille. Equivalence checking of parameterized quantum circuits: Verifying the compilation of variational quantum algorithms. In Asia and South Pacific Design Automation Conference. 2023. (arXiv:2210.12166)

♿ Accessibility

• ⚙️ Push-button solution for equivalence checking of quantum circuits
• 🐧/🍎/🏁 pre-built Python wheels for Linux, macOS (incl. Apple Silicon), and Windows
• 🐍 Python 3.7 to 3.11 support
• ⚛️ Seamless integration with Qiskit

🎨 Code Quality

• 🗃️ follow the LLVM coding standards for C++
• 🐍 follows best practices for developing Python projects and packages from the popular Scikit-HEP project
• 🧪 extensive unit tests for C++ and Python
• 🪝 pre-commit checks

📝 Project documentation hosted at ReadTheDocs.

• 🚀 Quickstart and User Guide
• 🧑‍💻 Development Guide
• 👥 Contributing Guide
• 📄 API documentation

New Contributors

• @pehamTom made their first contribution in https://github.com/cda-tum/qcec/pull/73
• @pre-commit-ci made their first contribution in https://github.com/cda-tum/qcec/pull/107

Full Changelog: https://github.com/cda-tum/qcec/compare/v1.10.5...v2.0.0

What's Changed

• 📌 More leniency on the qiskit-terra version by @burgholzer in https://github.com/cda-tum/qcec/pull/135
• 🐛 fix cpp-linter silently failing by @burgholzer in https://github.com/cda-tum/qcec/pull/136
• Bump extern/qfr from d550522 to ef83c0f by @dependabot in https://github.com/cda-tum/qcec/pull/137
• 🔧 Update CI with latest best practices by @burgholzer in https://github.com/cda-tum/qcec/pull/138
• 🚨 Further flake8 checks by @burgholzer in https://github.com/cda-tum/qcec/pull/139
• 🔧 Update nox sessions by @burgholzer in https://github.com/cda-tum/qcec/pull/140
• Bump pypa/cibuildwheel from 2.9.0 to 2.10.0 by @dependabot in https://github.com/cda-tum/qcec/pull/141
• Bump extern/qfr from ef83c0f to ae0b7c0 by @dependabot in https://github.com/cda-tum/qcec/pull/142
• 🐛 Fix potential underflow bug in max simulation computation by @burgholzer in https://github.com/cda-tum/qcec/pull/144
• ⬆️🪝 update pre-commit hooks by @pre-commit-ci in https://github.com/cda-tum/qcec/pull/145
• Documentation update by @burgholzer in https://github.com/cda-tum/qcec/pull/143

Full Changelog: https://github.com/cda-tum/qcec/compare/v2.0.0-rc8...V2.0.0-rc9

What's Changed

• 🐍🔧 Specify Metadata via PEP 621 by @burgholzer in https://github.com/cda-tum/qcec/pull/124
• 🔧 Add Issue and PR templates by @burgholzer in https://github.com/cda-tum/qcec/pull/125
• 📝 Updated docs with the JETCAS Publication. by @pehamTom in https://github.com/cda-tum/qcec/pull/127
• ⚗️ Updates to cpp-linter to v2 by @burgholzer in #130, #132
• 🔧 Update CodeQL configuration by @burgholzer in https://github.com/cda-tum/qcec/pull/133
• 🪝 Fix and update flake8 config by @burgholzer in https://github.com/cda-tum/qcec/pull/122
• ⬆️🪝 update pre-commit hooks by @pre-commit-ci in #114, #126, #134
• 🔧 Update dependabot config by @burgholzer in https://github.com/cda-tum/qcec/pull/123

Full Changelog: https://github.com/cda-tum/qcec/compare/v2.0.0-rc7...v2.0.0-rc8

What's Changed

• ✨ The ZXChecker is now capable of discriminating differences in global phase (by @pehamTom in https://github.com/cda-tum/qcec/pull/111)
• 🐍 Python 3.11 wheels are now built by default (by @dependabot in https://github.com/cda-tum/qcec/pull/109)
• 🚸 better Python bindings exceptions (by @burgholzer in https://github.com/cda-tum/qcec/pull/116)
• 🐛 small bugfixes and improved support for dynamic quantum circuits (by @dependabot in https://github.com/cda-tum/qcec/pull/118)
• 🚸♻️ improved verify functions (by @burgholzer in https://github.com/cda-tum/qcec/pull/117)

Full Changelog: https://github.com/cda-tum/qcec/compare/v2.0.0-rc6...v2.0.0-rc7

This release mostly concerns the internal library and contains almost no user facing changes (besides some bugfixes 🐛).

It significantly improves the code quality and its assurance. To this end,

• the project now follows and enforces (most of) LLVM's code format style and coding guidelines for the C++ part, including consistent naming schemes and source code width limits
• several improvements reported by the SonarLint tool and various clang-tidy checks have been incorporated
• similar to the C++ workflow which has been quite well monitored, the Python side of the project now adopts the best practices from https://scikit-hep.org/developer in order to maintain a consistent and high quality

All these changes ensure that future contributions to QCEC can follow predefined guidelines and rules, whether it's for developing the core C++ library or the Python package.

What's Changed

• 🚨 Incorporate SonarLint Suggestions by @burgholzer in https://github.com/cda-tum/qcec/pull/88
• 👷🚨 Add new workflow run for checking clang-tidy and clang-format by @burgholzer in https://github.com/cda-tum/qcec/pull/89
• 🚸 Improve Python Compatibility of Documentation Building by @burgholzer in https://github.com/cda-tum/qcec/pull/90
• 📝 Small documentation update by @burgholzer in https://github.com/cda-tum/qcec/pull/91
• ⚡🔧 Faster CI by @burgholzer in https://github.com/cda-tum/qcec/pull/94
• 🎨🔧 Adopt (most of) LLVM's Code Format Style by @burgholzer in https://github.com/cda-tum/qcec/pull/97
• ⚡ Avoid vtable Copy by @burgholzer in https://github.com/cda-tum/qcec/pull/98
• 🎨🔧 Further clang-tidy Setup by @burgholzer in https://github.com/cda-tum/qcec/pull/99
• 🐍🔧 Python Development Setup by @burgholzer in https://github.com/cda-tum/qcec/pull/100
• 🐛 Fix Potential Endless Loop by @burgholzer in https://github.com/cda-tum/qcec/pull/102

Full Changelog: https://github.com/cda-tum/qcec/compare/v2.0.0-rc5...v2.0.0-rc6

This release marks the addition of the first equivalence checker not based on decision diagrams to QCEC: the ZX checker.
It tries to use the rules of the ZX-Calculus to reduce the ZX-Diagram corresponding to the circuit $G^{\prime -1}\cdot G$ to the identity diagram.
Performance-wise, it represent a complementary alternative to all existing checkers and is employed per default when invoking QCEC.

Furthermore, this release makes qiskit-terra a project dependency (in order to ease integration) and provides easy configuration files for CLion users.

What's Changed

• ✨ Equivalence Checking with the ZX-Calculus by @pehamTom in https://github.com/cda-tum/qcec/pull/73 (+fixes in #81 and #82)
• 🔧🐍 Add qiskit-terra to project dependencies by @burgholzer in https://github.com/cda-tum/qcec/pull/79
• 🚸🔧 Easy CLion configuration by @burgholzer in https://github.com/cda-tum/qcec/pull/78

New Contributors

• @pehamTom made their first contribution in https://github.com/cda-tum/qcec/pull/73

Full Changelog: https://github.com/cda-tum/qcec/compare/v2.0.0-rc4...v2.0.0-rc5

This is a quick release to incorporate a fix from the QFR library (cda-tum/qfr#133).
Furthermore it brings some documentation updates for developers.

What's Changed

• 🚨 fix LGTM warning by @burgholzer in https://github.com/cda-tum/qcec/pull/72
• Bump pypa/cibuildwheel from 2.6.1 to 2.7.0 by @dependabot in https://github.com/cda-tum/qcec/pull/74
• 🐛 Small bugfix update by @burgholzer in https://github.com/cda-tum/qcec/pull/76
• 📝 Documentation update by @burgholzer in https://github.com/cda-tum/qcec/pull/77

Full Changelog: https://github.com/cda-tum/qcec/compare/v2.0.0-rc3...v2.0.0-rc4

What's Changed

• 🐛 fix editable installs by @burgholzer in https://github.com/cda-tum/qcec/pull/61
• ✨ compilation flow profile generation by @burgholzer in https://github.com/cda-tum/qcec/pull/54
• 📝 improved documentation on RtD
• 🚸 convenience verify and verify_compilation functions

Full Changelog: https://github.com/cda-tum/qcec/compare/v2.0.0-rc2...v2.0.0-rc3

What's Changed

• Update qiskit-terra requirement from ~=0.19.2 to ~=0.20.0 in /test/python by @dependabot in https://github.com/cda-tum/qcec/pull/42
• Bump extern/qfr from cd15b3e to 7abe363 by @dependabot in https://github.com/cda-tum/qcec/pull/41
• ⚡ Loosen Requirements for Classical Stimuli Generation by @burgholzer in https://github.com/cda-tum/qcec/pull/44
• Modernize Build and Deploy by @burgholzer in https://github.com/cda-tum/qcec/pull/43

Full Changelog: https://github.com/cda-tum/qcec/compare/v2.0.0-rc1...v2.0.0-rc2

This release refactors many aspects of QCEC in order to make it more scaleable, efficient, and extendable.
The resulting equivalence checking flow now more closely resembles a parallel version of the flow proposed in the "Advanced Equivalence Checking for Quantum Circuits" paper.
Furthermore, this release adds project documentation to the QCEC project which is hosted at ReadTheDocs.

With this release, the rewrite is 99% complete and quite well documented as well as tested. It will undergo some more testing until the final v2.0 will be released.