mqt-core 3.3.2__cp314-cp314t-macosx_11_0_x86_64.whl

mqt/core/__init__.py

@@ -0,0 +1,77 @@
+# Copyright (c) 2023 - 2025 Chair for Design Automation, TUM
+# Copyright (c) 2025 Munich Quantum Software Company GmbH
+# All rights reserved.
+#
+# SPDX-License-Identifier: MIT
+#
+# Licensed under the MIT License
+
+"""MQT Core - The Backbone of the Munich Quantum Toolkit."""
+
+from __future__ import annotations
+
+import os
+import sys
+from pathlib import Path
+
+# under Windows, make sure to add the appropriate DLL directory to the PATH
+if sys.platform == "win32":
+
+    def _dll_patch() -> None:
+        """Add the DLL directory to the PATH."""
+        import sysconfig
+
+        bin_dir = Path(sysconfig.get_paths()["purelib"]) / "mqt" / "core" / "bin"
+        os.add_dll_directory(str(bin_dir))
+
+    _dll_patch()
+    del _dll_patch
+
+from typing import TYPE_CHECKING
+
+from ._version import version as __version__
+from ._version import version_tuple as version_info
+from .ir import QuantumComputation
+
+if TYPE_CHECKING:
+    from qiskit.circuit import QuantumCircuit
+
+
+def load(input_circuit: QuantumComputation | str | os.PathLike[str] | QuantumCircuit) -> QuantumComputation:
+    """Load a quantum circuit from any supported format as a :class:`~mqt.core.ir.QuantumComputation`.
+
+    Args:
+        input_circuit: The input circuit to translate to a :class:`~mqt.core.ir.QuantumComputation`.
+                       This can be a :class:`~mqt.core.ir.QuantumComputation` itself,
+                       a file name to any of the supported file formats,
+                       an OpenQASM (2.0 or 3.0) string, or
+                       a Qiskit :class:`~qiskit.circuit.QuantumCircuit`.
+
+    Returns:
+        The :class:`~mqt.core.ir.QuantumComputation`.
+
+    Raises:
+        FileNotFoundError: If the input circuit is a file name and the file does not exist.
+    """
+    if isinstance(input_circuit, QuantumComputation):
+        return input_circuit
+
+    if isinstance(input_circuit, (str, os.PathLike)):
+        input_str = str(input_circuit)
+        max_filename_length = 255 if os.name == "nt" else os.pathconf("/", "PC_NAME_MAX")
+        if len(input_str) > max_filename_length or not Path(input_circuit).is_file():
+            if isinstance(input_circuit, os.PathLike) or "OPENQASM" not in input_circuit:
+                msg = f"File {input_circuit} does not exist."
+                raise FileNotFoundError(msg)
+            # otherwise, we assume that this is a QASM string
+            return QuantumComputation.from_qasm_str(input_str)
+
+        return QuantumComputation.from_qasm(input_str)
+
+    # At this point, we know that the input is a Qiskit QuantumCircuit
+    from .plugins.qiskit import qiskit_to_mqt
+
+    return qiskit_to_mqt(input_circuit)
+
+
+__all__ = ["__version__", "load", "version_info"]

mqt/core/__main__.py

@@ -0,0 +1,55 @@
+# Copyright (c) 2023 - 2025 Chair for Design Automation, TUM
+# Copyright (c) 2025 Munich Quantum Software Company GmbH
+# All rights reserved.
+#
+# SPDX-License-Identifier: MIT
+#
+# Licensed under the MIT License
+
+"""Command line interface for mqt-core."""
+
+from __future__ import annotations
+
+import argparse
+import sys
+
+from ._commands import cmake_dir, include_dir
+from ._version import version as __version__
+
+
+def main() -> None:
+    """Entry point for the mqt-core command line interface.
+
+    This function is called when running the `mqt-core-cli` script.
+
+    .. code-block:: bash
+
+        mqt-core-cli [--version] [--include_dir] [--cmake_dir]
+
+    It provides the following command line options:
+
+    - :code:`--version`: Print the version and exit.
+    - :code:`--include_dir`: Print the path to the mqt-core C++ include directory.
+    - :code:`--cmake_dir`: Print the path to the mqt-core CMake module directory.
+
+    """
+    parser = argparse.ArgumentParser()
+    parser.add_argument("--version", action="version", version=__version__, help="Print version and exit.")
+
+    parser.add_argument(
+        "--include_dir", action="store_true", help="Print the path to the mqt-core C++ include directory."
+    )
+    parser.add_argument(
+        "--cmake_dir", action="store_true", help="Print the path to the mqt-core CMake module directory."
+    )
+    args = parser.parse_args()
+    if not sys.argv[1:]:
+        parser.print_help()
+    if args.include_dir:
+        print(include_dir().resolve())
+    if args.cmake_dir:
+        print(cmake_dir().resolve())
+
+
+if __name__ == "__main__":
+    main()

mqt/core/_commands.py

@@ -0,0 +1,52 @@
+# Copyright (c) 2023 - 2025 Chair for Design Automation, TUM
+# Copyright (c) 2025 Munich Quantum Software Company GmbH
+# All rights reserved.
+#
+# SPDX-License-Identifier: MIT
+#
+# Licensed under the MIT License
+
+"""Useful commands for obtaining information about mqt-core."""
+
+from __future__ import annotations
+
+from importlib.metadata import PackageNotFoundError, distribution
+from pathlib import Path
+
+
+def include_dir() -> Path:
+    """Return the path to the mqt-core include directory.
+
+    Raises:
+        FileNotFoundError: If the include directory is not found.
+        ImportError: If mqt-core is not installed.
+    """
+    try:
+        dist = distribution("mqt-core")
+        located_include_dir = Path(str(dist.locate_file("mqt/core/include/mqt-core")))
+        if located_include_dir.exists() and located_include_dir.is_dir():
+            return located_include_dir
+        msg = "mqt-core include files not found."
+        raise FileNotFoundError(msg)
+    except PackageNotFoundError:
+        msg = "mqt-core not installed, installation required to access the include files."
+        raise ImportError(msg) from None
+
+
+def cmake_dir() -> Path:
+    """Return the path to the mqt-core CMake module directory.
+
+    Raises:
+        FileNotFoundError: If the CMake module directory is not found.
+        ImportError: If mqt-core is not installed.
+    """
+    try:
+        dist = distribution("mqt-core")
+        located_cmake_dir = Path(str(dist.locate_file("mqt/core/share/cmake")))
+        if located_cmake_dir.exists() and located_cmake_dir.is_dir():
+            return located_cmake_dir
+        msg = "mqt-core CMake files not found."
+        raise FileNotFoundError(msg)
+    except PackageNotFoundError:
+        msg = "mqt-core not installed, installation required to access the CMake files."
+        raise ImportError(msg) from None

mqt/core/_compat/__init__.py

@@ -0,0 +1,11 @@
+# Copyright (c) 2023 - 2025 Chair for Design Automation, TUM
+# Copyright (c) 2025 Munich Quantum Software Company GmbH
+# All rights reserved.
+#
+# SPDX-License-Identifier: MIT
+#
+# Licensed under the MIT License
+
+from __future__ import annotations
+
+__all__: list[str] = []

mqt/core/_compat/typing.py

@@ -0,0 +1,29 @@
+# Copyright (c) 2023 - 2025 Chair for Design Automation, TUM
+# Copyright (c) 2025 Munich Quantum Software Company GmbH
+# All rights reserved.
+#
+# SPDX-License-Identifier: MIT
+#
+# Licensed under the MIT License
+
+from __future__ import annotations
+
+import sys
+from typing import TYPE_CHECKING
+
+if sys.version_info >= (3, 11):
+    from typing import assert_never
+elif TYPE_CHECKING:
+    from typing_extensions import assert_never
+else:
+
+    def assert_never(_: object) -> None:
+        msg = "Expected code to be unreachable"
+        raise AssertionError(msg)
+
+
+__all__ = ["assert_never"]
+
+
+def __dir__() -> list[str]:
+    return __all__

mqt/core/_version.py

@@ -0,0 +1,34 @@
+# file generated by setuptools-scm
+# don't change, don't track in version control
+
+__all__ = [
+    "__version__",
+    "__version_tuple__",
+    "version",
+    "version_tuple",
+    "__commit_id__",
+    "commit_id",
+]
+
+TYPE_CHECKING = False
+if TYPE_CHECKING:
+    from typing import Tuple
+    from typing import Union
+
+    VERSION_TUPLE = Tuple[Union[int, str], ...]
+    COMMIT_ID = Union[str, None]
+else:
+    VERSION_TUPLE = object
+    COMMIT_ID = object
+
+version: str
+__version__: str
+__version_tuple__: VERSION_TUPLE
+version_tuple: VERSION_TUPLE
+commit_id: COMMIT_ID
+__commit_id__: COMMIT_ID
+
+__version__ = version = '3.3.2'
+__version_tuple__ = version_tuple = (3, 3, 2)
+
+__commit_id__ = commit_id = 'gb823d66aa'

mqt/core/_version.pyi

@@ -0,0 +1,12 @@
+# Copyright (c) 2023 - 2025 Chair for Design Automation, TUM
+# Copyright (c) 2025 Munich Quantum Software Company GmbH
+# All rights reserved.
+#
+# SPDX-License-Identifier: MIT
+#
+# Licensed under the MIT License
+
+__version__: str
+version: str
+__version_tuple__: tuple[int, int, int, str, str] | tuple[int, int, int]
+version_tuple: tuple[int, int, int, str, str] | tuple[int, int, int]