Skip to content

Commit d13a35d

Browse files
committed
📝 Add changelog and upgrade guide fragments
Signed-off-by: burgholzer <burgholzer@me.com>
1 parent 18b502a commit d13a35d

2 files changed

Lines changed: 21 additions & 0 deletions

File tree

CHANGELOG.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -25,6 +25,7 @@ This project adheres to [Semantic Versioning], with the exception that minor rel
2525

2626
### Changed
2727

28+
- 📦 Build MLIR by default for C++ library builds ([#1356]) ([**@burgholzer**], [**@denialhaag**])
2829
- 📦🏁 Build Windows x86 wheels on windows-2025 runner for newer compiler ([#1415]) ([**@burgholzer**])
2930
- 👷 Build on `macos-15`/`windows-2025` by default and `macos-14`/`windows-2022` for extensive tests ([#1414]) ([**@burgholzer**])
3031
- 📦🍎 Build macOS arm64 wheels on macos-15 runner for newer compiler ([#1413]) ([**@burgholzer**])

UPGRADING.md

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,26 @@ This document describes breaking changes and how to upgrade. For a complete list
44

55
## [Unreleased]
66

7+
### MLIR enabled by default for C++ builds
8+
9+
The MLIR-based functionality within MQT Core has long been experimental and opt-in.
10+
Starting with this release, MLIR is enabled by default for C++ library builds.
11+
This means that LLVM (including MLIR) is now a required dependency for building MQT Core from source.
12+
13+
We offer pre-built distributions for all supported platforms as part of the `setup-mlir` project at [munich-quantum-software/setup-mlir](https://github.com/munich-quantum-software/setup-mlir).
14+
Please follow the instructions there to install the distribution for your platform.
15+
You can then point CMake to the installation directory using the `-DMLIR_DIR=/path/to/mlir/installation/lib/cmake/mlir` option.
16+
17+
The MLIR components can still be manually disabled by passing `-DBUILD_MQT_CORE_MLIR=OFF` to CMake.
18+
MLIR is also not enabled for the Python package builds because no functionality depends on it yet.
19+
This is expected to change in the future, when we expose the MLIR-based functionality via the Python package.
20+
21+
Known limitations:
22+
23+
- Our pre-built distributions are incompatible with GCC on macOS. Use (Apple)Clang instead or compile LLVM from source using your preferred compiler.
24+
- AppleClang 17+ is required to build MQT Core with MLIR enabled due to some C++20 features being used that are not yet properly supported by older versions.
25+
- Our pre-built distributions are compiled in Release mode. On Windows, this leads to ABI incompatibilities with debug builds. Either build in Release mode or build LLVM from source in Debug mode to resolve this.
26+
727
### QDMI-Qiskit integration
828

929
This release introduces a Qiskit `BackendV2`-compatible interface to QDMI devices.

0 commit comments

Comments
 (0)