🎨 Do not rebuild MQT Core in tests (#606)

## Description

This PR changes the test setup to not rebuild MQT Core from source. 

Related to munich-quantum-toolkit/qcec#661

## Checklist:

- [x] The pull request only contains commits that are focused and
relevant to this change.
- [x] ~~I have added appropriate tests that cover the new/changed
functionality.~~
- [x] ~~I have updated the documentation to reflect these changes.~~
- [x] I have added entries to the changelog for any noteworthy
additions, changes, fixes, or removals.
- [x] I have added migration instructions to the upgrade guide (if
needed).
- [x] The changes follow the project's style guidelines and introduce no
new warnings.
- [x] The changes are fully tested and pass the CI checks.
- [x] I have reviewed my own code changes.

Author: denialhaag

.readthedocs.yaml

@@ -1,8 +1,8 @@
 version: 2
 
 formats:
-  #  - pdf
   - htmlzip
+  # - pdf
 
 sphinx:
   configuration: docs/conf.py
@@ -31,9 +31,9 @@ build:
       - asdf plugin add uv
       - asdf install uv latest
       - asdf global uv latest
-      # Set up build time dependencies including a source distribution of mqt-core.
-      - uv sync --only-group build --only-group docs --no-binary-package mqt-core
-      # The default version of CMake on Ubuntu 24.04 is too old, so we need to install a newer version.
+      # Set up build-time dependencies
+      - uv sync --only-group build --only-group docs
+      # Install CMake because the default version on Ubuntu 24.04 is too old
       - uv pip install cmake
     build:
       html:
@@ -42,8 +42,8 @@ build:
         - uv run --frozen --no-dev --no-build-isolation-package mqt-ddsim -m sphinx -T -b dirhtml -d docs/_build/doctrees -D language=en docs docs/_build/dirhtml
         - mkdir -p $READTHEDOCS_OUTPUT/htmlzip
         - zip -r $READTHEDOCS_OUTPUT/htmlzip/html.zip docs/_build/dirhtml/*
-#      pdf:
-#        - uv run --frozen --no-dev --no-build-isolation-package mqt-ddsim -m sphinx -T -b latex -d docs/_build/doctrees -D language=en docs docs/_build/latex
-#        - cd docs/_build/latex && latexmk -pdf -f -dvi- -ps- -interaction=nonstopmode -jobname=$READTHEDOCS_PROJECT
-#        - mkdir -p $READTHEDOCS_OUTPUT/pdf
-#        - cp docs/_build/latex/$READTHEDOCS_PROJECT.pdf $READTHEDOCS_OUTPUT/pdf/$READTHEDOCS_PROJECT.pdf
+      # pdf:
+      #   - uv run --frozen --no-dev --no-build-isolation-package mqt-ddsim -m sphinx -T -b latex -d docs/_build/doctrees -D language=en docs docs/_build/latex
+      #   - cd docs/_build/latex && latexmk -pdf -f -dvi- -ps- -interaction=nonstopmode -jobname=$READTHEDOCS_PROJECT
+      #   - mkdir -p $READTHEDOCS_OUTPUT/pdf
+      #   - cp docs/_build/latex/$READTHEDOCS_PROJECT.pdf $READTHEDOCS_OUTPUT/pdf/$READTHEDOCS_PROJECT.pdf

CHANGELOG.md

@@ -17,7 +17,7 @@ _If you are upgrading: please see [`UPGRADING.md`](UPGRADING.md#Unreleased)._
 
 ### Changed
 
-- **Breaking**: ⬆️ Bump minimum required MQT Core version to `3.1.0` ([#591]) ([**@denialhaag**])
+- **Breaking**: ⬆️ Bump minimum required `mqt-core` version to `3.1.0` ([#591]) ([**@denialhaag**])
 - **Breaking**: ⬆️ Bump minimum required `pybind11` version to `3.0.0` ([#591]) ([**@denialhaag**])
 - ♻️ Move the C++ code for the Python bindings to the top-level `bindings` directory ([#567]) ([**@denialhaag**])
 - ♻️ Move all Python code (no tests) to the top-level `python` directory ([#567]) ([**@denialhaag**])
@@ -34,6 +34,10 @@ _If you are upgrading: please see [`UPGRADING.md`](UPGRADING.md#Unreleased)._
 - **Breaking**: 🔥 Remove some superfluous C++ executables ([#336]) ([**@burgholzer**])
 - **Breaking**: 🔥 Remove support for `.real`, `.qc`, `.tfc`, and `GRCS` files ([#538]) ([**@burgholzer**])
 
+### Fixed
+
+- 🚸 Increase binary compatibility between `mqt-ddsim` and `mqt-core` ([#606]) ([**@denialhaag**])
+
 ## [1.24.0] - 2024-10-10
 
 _📚 Refer to the [GitHub Release Notes] for previous changelogs._
@@ -45,6 +49,7 @@ _📚 Refer to the [GitHub Release Notes] for previous changelogs._
 
 <!-- PR links -->
 
+[#606]: https://github.com/munich-quantum-toolkit/ddsim/pull/606
 [#591]: https://github.com/munich-quantum-toolkit/ddsim/pull/591
 [#571]: https://github.com/munich-quantum-toolkit/ddsim/pull/571
 [#567]: https://github.com/munich-quantum-toolkit/ddsim/pull/567

UPGRADING.md

@@ -11,16 +11,18 @@ We intend to provide a more comprehensive migration guide for future releases.
 The major change in this major release is the move to the MQT Core Python package.
 This move allows us to make `qiskit` a fully optional dependency and entirely rely on the MQT Core IR for representing circuits.
 Additionally, the `mqt-core` Python package now ships all its C++ libraries as shared libraries so that these need not be fetched or built as part of the build process.
-This was tricky to achieve cross-platform, and you can find some more backstory in the corresponding [PR](https://github.com/munich-quantum-toolkit/ddsim/pulls/336).
-We expect this integration to mature over the next few releases.
+This was tricky to achieve cross-platform, and you can find some more backstory in the corresponding PR [#336].
+The problem was simplified by the latest `pybind11` release (`v3`) that greatly increased binary compatibility.
+It is not necessary to build MQT Core from source, and a simple `uv sync` is enough to successfully run `pytest`.
+We expect the MQT Core integration to mature over the next few releases.
 If you encounter any issues, please let us know.
 
 Support for the tensor network strategy in the path simulator has been removed.
 If you still depend on that method, please use the last version of MQT DDSIM that supports them, which is `1.24.0`.
 
 MQT Core itself dropped support for several parsers in `v3.0.0`, including the `.real`, `.qc`, `.tfc`, and `GRCS` parsers.
 The `.real` parser lives on as part of the [MQT SyReC] project. All others have been removed without replacement.
-Consequently, these input formats are no longer supported in MQT QMAP.
+Consequently, these input formats are no longer supported in MQT DDSIM.
 
 MQT DDSIM has moved to the [munich-quantum-toolkit](https://github.com/munich-quantum-toolkit) GitHub organization under https://github.com/munich-quantum-toolkit/ddsim.
 While most links should be automatically redirected, please update any links in your code to point to the new location.
@@ -36,5 +38,11 @@ As a result, the return values of the `Estimator` and `Sampler` have been change
 To developers of MQT DDSIM, it is worth mentioning that all Python code (except tests) has been moved to the top-level `python` directory.
 Furthermore, the C++ code for the Python bindings has been moved to the top-level `bindings` directory.
 
-[MQT SyReC]: https://github.com/cda-tum/mqt-syrec
+<!-- Version links -->
+
 [unreleased]: https://github.com/munich-quantum-toolkit/qmap/compare/v1.24.0...HEAD
+
+<!-- Other links -->
+
+[#336]: https://github.com/munich-quantum-toolkit/ddsim/pull/336
+[MQT SyReC]: https://github.com/cda-tum/mqt-syrec

noxfile.py

@@ -67,11 +67,6 @@ def _run_tests(
         "build",
         "--only-group",
         "test",
-        # Build mqt-core from source to work around pybind believing that two
-        # compiled extensions might not be binary compatible.
-        # This will be fixed in a new pybind11 release that includes https://github.com/pybind/pybind11/pull/5439.
-        "--no-binary-package",
-        "mqt-core",
         *install_args,
         env=env,
     )
@@ -146,11 +141,6 @@ def docs(session: nox.Session) -> None:
         "build",
         "--only-group",
         "docs",
-        # Build mqt-core from source to work around pybind believing that two
-        # compiled extensions might not be binary compatible.
-        # This will be fixed in a new pybind11 release that includes https://github.com/pybind/pybind11/pull/5439.
-        "--no-binary-package",
-        "mqt-core",
         env=env,
     )