✨ switch to mqt-core Python package

.pre-commit-config.yaml

@@ -100,6 +100,7 @@ repos:
           - importlib_resources
           - numpy
           - pytest
+          - mqt-core @ git+https://github.com/cda-tum/mqt-core.git@installation-improvements
 
   # Check for spelling
   - repo: https://github.com/codespell-project/codespell

cmake/ExternalDependencies.cmake

@@ -4,6 +4,19 @@ include(FetchContent)
 set(FETCH_PACKAGES "")
 
 if(BUILD_MQT_QCEC_BINDINGS)
+  # Manually detect the installed mqt-core package.
+  execute_process(
+    COMMAND "${Python_EXECUTABLE}" -m mqt.core --cmake_dir
+    OUTPUT_STRIP_TRAILING_WHITESPACE
+    OUTPUT_VARIABLE mqt-core_DIR
+    ERROR_QUIET)
+
+  # Add the detected directory to the CMake prefix path.
+  if(mqt-core_DIR)
+    list(APPEND CMAKE_PREFIX_PATH "${mqt-core_DIR}")
+    message(STATUS "Found mqt-core package: ${mqt-core_DIR}")
+  endif()
+
   if(NOT SKBUILD)
     # Manually detect the installed pybind11 package.
     execute_process(
@@ -19,20 +32,14 @@ if(BUILD_MQT_QCEC_BINDINGS)
   find_package(pybind11 CONFIG REQUIRED)
 endif()
 
-set(FETCHCONTENT_SOURCE_DIR_MQT-CORE
-    ${PROJECT_SOURCE_DIR}/extern/mqt-core
-    CACHE
-      PATH
-      "Path to the source directory of the mqt-core library. This variable is used by FetchContent to download the library if it is not already available."
-)
 set(MQT_CORE_VERSION
     2.2.2
     CACHE STRING "MQT Core version")
 if(CMAKE_VERSION VERSION_GREATER_EQUAL 3.24)
   FetchContent_Declare(
     mqt-core
     GIT_REPOSITORY https://github.com/cda-tum/mqt-core.git
-    GIT_TAG v${MQT_CORE_VERSION}
+    GIT_TAG installation-improvements
     FIND_PACKAGE_ARGS ${MQT_CORE_VERSION})
   list(APPEND FETCH_PACKAGES mqt-core)
 else()
@@ -41,7 +48,7 @@ else()
     FetchContent_Declare(
       mqt-core
       GIT_REPOSITORY https://github.com/cda-tum/mqt-core.git
-      GIT_TAG v${MQT_CORE_VERSION})
+      GIT_TAG installation-improvements)
     list(APPEND FETCH_PACKAGES mqt-core)
   endif()
 endif()

noxfile.py

@@ -17,6 +17,7 @@
 PYTHON_ALL_VERSIONS = ["3.8", "3.9", "3.10", "3.11", "3.12"]
 
 BUILD_REQUIREMENTS = [
+    "mqt.core @ git+https://github.com/cda-tum/mqt-core.git@installation-improvements",
     "scikit-build-core[pyproject]>=0.6.1",
     "setuptools_scm>=7",
     "pybind11>=2.11",
@@ -54,7 +55,12 @@ def _run_tests(
         _extras.append("coverage")
         posargs.append("--cov-config=pyproject.toml")
 
-    session.install(*BUILD_REQUIREMENTS, *install_args, env=env)
+    # On Linux, `mqt-core` needs to be installed with `--no-binary` to avoid ABI
+    # incompatibility issues caused by compiling with different GCC versions.
+    if sys.platform == "linux":
+        install_args = ["--no-binary", "mqt.core", *install_args]
+
+    session.install("-v", *BUILD_REQUIREMENTS, *install_args, env=env)
     install_arg = f"-ve.[{','.join(_extras)}]"
     session.install("--no-build-isolation", install_arg, *install_args, env=env)
     session.run("pytest", *run_args, *posargs, env=env)
@@ -89,8 +95,11 @@ def docs(session: nox.Session) -> None:
         session.error("Must not specify non-HTML builder with --serve")
 
     extra_installs = ["sphinx-autobuild"] if args.serve else []
-    session.install(*BUILD_REQUIREMENTS, *extra_installs)
-    session.install("--no-build-isolation", "-ve.[docs]")
+    # On Linux, `mqt-core` needs to be installed with `--no-binary` to avoid ABI
+    # incompatibility issues caused by compiling with different GCC versions.
+    install_args = ["--no-binary", "mqt.core"] if sys.platform == "linux" else []
+    session.install(*BUILD_REQUIREMENTS, *extra_installs, *install_args)
+    session.install("--no-build-isolation", "-ve.[docs]", *install_args)
     session.chdir("docs")
 
     if args.builder == "linkcheck":

pyproject.toml

@@ -1,5 +1,10 @@
 [build-system]
-requires = ["scikit-build-core>=0.6.1", "setuptools-scm>=7", "pybind11>=2.11"]
+requires = [
+    "scikit-build-core>=0.6.1",
+    "setuptools-scm>=7",
+    "pybind11>=2.11",
+    "mqt.core @ git+https://github.com/cda-tum/mqt-core.git@installation-improvements",
+]
 build-backend = "scikit_build_core.build"
 
 [project]
@@ -35,9 +40,9 @@ classifiers = [
 ]
 requires-python = ">=3.8"
 dependencies = [
+    "mqt.core[qiskit] @ git+https://github.com/cda-tum/mqt-core.git@installation-improvements",
     "importlib_resources>=5.0; python_version < '3.10'",
     "typing_extensions>=4.2",
-    "qiskit[qasm3-import]>=0.45.0",
 ]
 dynamic = ["version"]
 
@@ -100,7 +105,6 @@ sdist.exclude = [
 [tool.scikit-build.cmake.define]
 BUILD_MQT_QCEC_TESTS = "OFF"
 BUILD_MQT_QCEC_BINDINGS = "ON"
-ENABLE_IPO = "ON"
 
 
 [tool.check-sdist]

src/mqt/qcec/__init__.py

@@ -6,6 +6,17 @@
 
 from __future__ import annotations
 
+import sys
+
+# under Windows, make sure to add the appropriate DLL directory to the PATH
+if sys.platform == "win32":  # pragma: no cover
+    import os
+    import sysconfig
+    from pathlib import Path
+
+    bin_dir = Path(sysconfig.get_paths()["purelib"]) / "mqt" / "core" / "bin"
+    os.add_dll_directory(str(bin_dir))
+
 from ._version import version as __version__
 from .compilation_flow_profiles import AncillaMode, generate_profile
 from .pyqcec import (