Munich-Quantum-Software-Stack · ystade · Feb 11, 2026 · Feb 11, 2026 · Feb 11, 2026 · Feb 11, 2026
diff --git a/.github/codecov.yml b/.github/codecov.yml
@@ -1,5 +1,5 @@
 ignore:
-  - "test/**/*"
+  - "**/test/**/*"
 
 coverage:
   range: 60..90
@@ -23,7 +23,10 @@ flag_management:
     - name: cpp
       paths:
         - "include"
-        - "examples"
+        - "examples/device/src"
+        - "examples/driver"
+        - "examples/fomac"
+        - "examples/tool"
 
 parsers:
   gcov:

diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml
@@ -49,8 +49,7 @@ jobs:
     with:
       clang-version: 21
       cpp-linter-extra-args: "-std=c++20"
-      # do not try to build docs in linter builds
-      cmake-args: "-DBUILD_QDMI_DOCS=OFF"
+      cmake-args: "-DBUILD_CXX_QDMI_TESTS=ON"
 
   template:
     name: 🏗️ Build and Test Templates

diff --git a/.github/workflows/release-docs.yml b/.github/workflows/release-docs.yml
@@ -36,7 +36,7 @@ jobs:
       - name: Install and Build 🔧
         run: |
           cmake -S . -B build -DBUILD_QDMI_DOCS=ON
-          cmake --build build --target qdmi_docs
+          cmake --build build --target qdmi-docs
           mv build/docs/html/ static
 
       - name: Set version variable

diff --git a/.github/workflows/reusable-cpp-ci.yml b/.github/workflows/reusable-cpp-ci.yml
@@ -61,7 +61,7 @@ jobs:
         run: pipx install ninja
       - name: Configure CMake
         run: |
-          cmake -G Ninja -S . -B build -DCMAKE_BUILD_TYPE=Debug -DENABLE_COVERAGE=ON -DBUILD_QDMI_DOCS=OFF
+          cmake -G Ninja -S . -B build -DCMAKE_BUILD_TYPE=Debug -DENABLE_COVERAGE=ON -DBUILD_CXX_QDMI_TESTS=ON
       - name: Build
         run: cmake --build build --config Debug
       - name: Test

diff --git a/.github/workflows/reusable-cpp-install-tests.yml b/.github/workflows/reusable-cpp-install-tests.yml
@@ -58,7 +58,7 @@ jobs:
       # configure CMake for using the installed QDMI
       - name: Configure CMake for use of installed QDMI
         run:
-          cmake -S . -B build -DCMAKE_BUILD_TYPE=Release -DUSE_INSTALLED_QDMI=ON
+          cmake -S . -B build -DCMAKE_BUILD_TYPE=Release -DUSE_INSTALLED_QDMI=ON -DBUILD_CXX_QDMI_TESTS=ON
           -DCMAKE_PREFIX_PATH=install-dir ${{ inputs.cmake-args }}
       # build the project
       - name: Build QDMI examples, templates, and tests with installed QDMI

diff --git a/.github/workflows/reusable-docs.yml b/.github/workflows/reusable-docs.yml
@@ -20,7 +20,7 @@ jobs:
         if: github.event.action != 'closed'
         run: |
           cmake -S . -B build -DBUILD_QDMI_DOCS=ON
-          cmake --build build --target qdmi_docs
+          cmake --build build --target qdmi-docs
           mv build/docs/html/ static
       - name: Inject version selector
         if: github.event.action != 'closed'

diff --git a/.license-tools-config.json b/.license-tools-config.json
@@ -1,10 +1,10 @@
 {
   "author": {
-    "name": "Munich Quantum Software Stack Project",
-    "years": [2024, 2025]
+    "name": "QDMI Maintainers",
+    "years": [2024, 2026]
   },
   "force_author": true,
-  "custom_license": "Licensed under the Apache License v2.0 with LLVM Exceptions (the \"License\");\nyou may not use this file except in compliance with the License.\nYou may obtain a copy of the License at\n\nhttps://github.com/Munich-Quantum-Software-Stack/QDMI/blob/develop/LICENSE.md\n\nUnless required by applicable law or agreed to in writing, software\ndistributed under the License is distributed on an \"AS IS\" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the\nLicense for the specific language governing permissions and limitations under the License.\n\nSPDX-License-Identifier: Apache-2.0 WITH LLVM-exception",
+  "custom_license": "Licensed under the Apache License v2.0 with LLVM Exceptions (the \"License\");\nyou may not use this file except in compliance with the License.\nYou may obtain a copy of the License at\n\nhttps://llvm.org/LICENSE.txt\n\nUnless required by applicable law or agreed to in writing, software\ndistributed under the License is distributed on an \"AS IS\" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the\nLicense for the specific language governing permissions and limitations under the License.\n\nSPDX-License-Identifier: Apache-2.0 WITH LLVM-exception",
   "force_license": true,
   "title": false,
   "include": ["**/*"],
@@ -17,6 +17,7 @@
     ".toml": "POUND_STYLE",
     ".proto": "SLASH_STYLE",
     ".ts": "C_STYLE",
+    ".css": "C_STYLE",
     ".ps1": "POUND_STYLE"
   },
   "exclude": [
@@ -27,7 +28,6 @@
     ".*\\.md",
     ".*\\.bib",
     ".*\\.cff",
-    ".*\\.css",
     ".*\\.json",
     ".*\\.html",
     ".*\\.tfc",

diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml
@@ -79,7 +79,7 @@ repos:
     hooks:
       - id: prettier
         types_or: [yaml, markdown, html, css, scss, javascript, json]
-        exclude: ^docs/header\.html$
+        exclude: docs/header\.html$
 
   # Catch common capitalization mistakes
   - repo: local

diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -11,11 +11,16 @@ clients compiled against a different minor or major version.
 
 ## [Unreleased]
 
+### Added
+
+- 👨‍💻 Add an option to disable installation instructions for QDMI (example and template) device ([#326]) ([\@ystade])
+
 ### Changed
 
-- 🚸 Export _all_ device headers (incl. `constants.h`) as part of device implementations such that they do not need to link against the header-only QDMI library anymore ([#325]) ([\@ystade], [\@burgholzer])
+- 👨‍💻 Base the example device implementation on the device template ([#326]) ([\@ystade])
 - 🚸 Increase robustness of the QDMI device template (complete install instructions, uv caching, code cleanup) ([#333]) ([\@burgholzer])
 - 🚸 Add a symbol-export header for compiling devices with hidden symbol visibility ([#334]) ([\@burgholzer])
+- 🚸 Export _all_ device headers (incl. `constants.h`) as part of device implementations such that they do not need to link against the header-only QDMI library anymore ([#325]) ([\@ystade], [\@burgholzer])
 
 ## [1.2.1] - 2025-12-22
 
@@ -120,6 +125,7 @@ changelogs._
 
 [#334]: https://github.com/Munich-Quantum-Software-Stack/QDMI/pull/334
 [#333]: https://github.com/Munich-Quantum-Software-Stack/QDMI/pull/333
+[#326]: https://github.com/Munich-Quantum-Software-Stack/QDMI/pull/326
 [#325]: https://github.com/Munich-Quantum-Software-Stack/QDMI/pull/325
 [#285]: https://github.com/Munich-Quantum-Software-Stack/QDMI/pull/285
 [#275]: https://github.com/Munich-Quantum-Software-Stack/QDMI/pull/275

diff --git a/CMakeLists.txt b/CMakeLists.txt
@@ -1,11 +1,11 @@
-# Copyright (c) 2024 - 2025 Munich Quantum Software Stack Project
+# Copyright (c) 2024 - 2026 QDMI Maintainers
 # All rights reserved.
 #
 # Licensed under the Apache License v2.0 with LLVM Exceptions (the "License");
 # you may not use this file except in compliance with the License.
 # You may obtain a copy of the License at
 #
-# https://github.com/Munich-Quantum-Software-Stack/QDMI/blob/develop/LICENSE.md
+# https://llvm.org/LICENSE.txt
 #
 # Unless required by applicable law or agreed to in writing, software
 # distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
@@ -54,7 +54,7 @@ option(
 
 include(CMakeDependentOption)
 cmake_dependent_option(
-  QDMI_INSTALL "Generate installation instructions for QDMI"
+  INSTALL_QDMI "Generate installation instructions for QDMI"
   ${QDMI_MASTER_PROJECT} "NOT USE_INSTALLED_QDMI" OFF)
 option(BUILD_QDMI_TESTS "Also build tests for the QDMI project"
        ${QDMI_MASTER_PROJECT})
@@ -178,7 +178,7 @@ if(BUILD_QDMI_TESTS)
 endif()
 
 # Installation instructions for the main library
-if(QDMI_INSTALL)
+if(INSTALL_QDMI)
   set(QDMI_CONFIG_INSTALL_DIR
       "${CMAKE_INSTALL_DATADIR}/cmake/${PROJECT_NAME}"
       CACHE INTERNAL "Config install directory")

diff --git a/cmake/Cache.cmake b/cmake/Cache.cmake
@@ -1,11 +1,11 @@
-# Copyright (c) 2024 - 2025 Munich Quantum Software Stack Project
+# Copyright (c) 2024 - 2026 QDMI Maintainers
 # All rights reserved.
 #
 # Licensed under the Apache License v2.0 with LLVM Exceptions (the "License");
 # you may not use this file except in compliance with the License.
 # You may obtain a copy of the License at
 #
-# https://github.com/Munich-Quantum-Software-Stack/QDMI/blob/develop/LICENSE.md
+# https://llvm.org/LICENSE.txt
 #
 # Unless required by applicable law or agreed to in writing, software
 # distributed under the License is distributed on an "AS IS" BASIS, WITHOUT

diff --git a/cmake/CompilerWarnings.cmake b/cmake/CompilerWarnings.cmake
@@ -1,11 +1,11 @@
-# Copyright (c) 2024 - 2025 Munich Quantum Software Stack Project
+# Copyright (c) 2024 - 2026 QDMI Maintainers
 # All rights reserved.
 #
 # Licensed under the Apache License v2.0 with LLVM Exceptions (the "License");
 # you may not use this file except in compliance with the License.
 # You may obtain a copy of the License at
 #
-# https://github.com/Munich-Quantum-Software-Stack/QDMI/blob/develop/LICENSE.md
+# https://llvm.org/LICENSE.txt
 #
 # Unless required by applicable law or agreed to in writing, software
 # distributed under the License is distributed on an "AS IS" BASIS, WITHOUT

diff --git a/cmake/ExternalDependencies.cmake b/cmake/ExternalDependencies.cmake
@@ -1,11 +1,11 @@
-# Copyright (c) 2024 - 2025 Munich Quantum Software Stack Project
+# Copyright (c) 2024 - 2026 QDMI Maintainers
 # All rights reserved.
 #
 # Licensed under the Apache License v2.0 with LLVM Exceptions (the "License");
 # you may not use this file except in compliance with the License.
 # You may obtain a copy of the License at
 #
-# https://github.com/Munich-Quantum-Software-Stack/QDMI/blob/develop/LICENSE.md
+# https://llvm.org/LICENSE.txt
 #
 # Unless required by applicable law or agreed to in writing, software
 # distributed under the License is distributed on an "AS IS" BASIS, WITHOUT

diff --git a/cmake/GenerateTemplate.cmake b/cmake/GenerateTemplate.cmake
@@ -1,11 +1,11 @@
-# Copyright (c) 2024 - 2025 Munich Quantum Software Stack Project
+# Copyright (c) 2024 - 2026 QDMI Maintainers
 # All rights reserved.
 #
 # Licensed under the Apache License v2.0 with LLVM Exceptions (the "License");
 # you may not use this file except in compliance with the License.
 # You may obtain a copy of the License at
 #
-# https://github.com/Munich-Quantum-Software-Stack/QDMI/blob/develop/LICENSE.md
+# https://llvm.org/LICENSE.txt
 #
 # Unless required by applicable law or agreed to in writing, software
 # distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
@@ -42,8 +42,22 @@ if("${QDMI_TEMPLATE_CLEAN}" STREQUAL "")
   set(QDMI_TEMPLATE_CLEAN OFF)
 endif()
 
-file(REAL_PATH "${QDMI_TEMPLATE_SOURCE_DIR}" QDMI_TEMPLATE_SOURCE_DIR)
-file(REAL_PATH "${QDMI_TEMPLATE_OUTPUT_DIR}" QDMI_TEMPLATE_OUTPUT_DIR)
+# file(REAL_PATH ...) fails if the path doesn't (yet) exist on some
+# platforms/CMakes. Use REAL_PATH only when the path exists; otherwise compute
+# an absolute path which does not require the target to exist.
+if(EXISTS "${QDMI_TEMPLATE_SOURCE_DIR}")
+  file(REAL_PATH "${QDMI_TEMPLATE_SOURCE_DIR}" QDMI_TEMPLATE_SOURCE_DIR)
+else()
+  get_filename_component(QDMI_TEMPLATE_SOURCE_DIR "${QDMI_TEMPLATE_SOURCE_DIR}"
+                         ABSOLUTE)
+endif()
+
+if(EXISTS "${QDMI_TEMPLATE_OUTPUT_DIR}")
+  file(REAL_PATH "${QDMI_TEMPLATE_OUTPUT_DIR}" QDMI_TEMPLATE_OUTPUT_DIR)
+else()
+  get_filename_component(QDMI_TEMPLATE_OUTPUT_DIR "${QDMI_TEMPLATE_OUTPUT_DIR}"
+                         ABSOLUTE)
+endif()
 
 string(TOLOWER "${QDMI_TEMPLATE_PREFIX}" QDMI_TEMPLATE_prefix)
 

diff --git a/cmake/PrefixHandling.cmake b/cmake/PrefixHandling.cmake
@@ -1,11 +1,11 @@
-# Copyright (c) 2024 - 2025 Munich Quantum Software Stack Project
+# Copyright (c) 2024 - 2026 QDMI Maintainers
 # All rights reserved.
 #
 # Licensed under the Apache License v2.0 with LLVM Exceptions (the "License");
 # you may not use this file except in compliance with the License.
 # You may obtain a copy of the License at
 #
-# https://github.com/Munich-Quantum-Software-Stack/QDMI/blob/develop/LICENSE.md
+# https://llvm.org/LICENSE.txt
 #
 # Unless required by applicable law or agreed to in writing, software
 # distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
@@ -117,5 +117,5 @@ function(generate_device_defs_executable prefix)
     qdmi_test_${QDMI_prefix}_device_defs PRIVATE qdmi::qdmi ${DEVICE_TARGET}
                                                  qdmi::qdmi_project_warnings)
   target_compile_features(qdmi_test_${QDMI_prefix}_device_defs
-                          PRIVATE cxx_std_17)
+                          PRIVATE cxx_std_20)
 endfunction()
diff --git a/cmake/qdmi-config.cmake.in b/cmake/qdmi-config.cmake.in
@@ -1,11 +1,11 @@
-# Copyright (c) 2024 - 2025 Munich Quantum Software Stack Project
+# Copyright (c) 2024 - 2026 QDMI Maintainers
 # All rights reserved.
 #
 # Licensed under the Apache License v2.0 with LLVM Exceptions (the "License");
 # you may not use this file except in compliance with the License.
 # You may obtain a copy of the License at
 #
-# https://github.com/Munich-Quantum-Software-Stack/QDMI/blob/develop/LICENSE.md
+# https://llvm.org/LICENSE.txt
 #
 # Unless required by applicable law or agreed to in writing, software
 # distributed under the License is distributed on an "AS IS" BASIS, WITHOUT

diff --git a/docs/CMakeLists.txt b/docs/CMakeLists.txt
@@ -1,11 +1,11 @@
-# Copyright (c) 2024 - 2025 Munich Quantum Software Stack Project
+# Copyright (c) 2024 - 2026 QDMI Maintainers
 # All rights reserved.
 #
 # Licensed under the Apache License v2.0 with LLVM Exceptions (the "License");
 # you may not use this file except in compliance with the License.
 # You may obtain a copy of the License at
 #
-# https://github.com/Munich-Quantum-Software-Stack/QDMI/blob/develop/LICENSE.md
+# https://llvm.org/LICENSE.txt
 #
 # Unless required by applicable law or agreed to in writing, software
 # distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
@@ -26,9 +26,15 @@ set(DOXYGEN_INPUT_DIRS ${PROJECT_SOURCE_DIR}/include)
 # This variable is only needed to setup the dependency tracking of CMake
 # correctly and is not passed to Doxygen. Whenever such a file is modified,
 # CMake detects that change and will rerun the Doxygen command instead of using
-# the cached result when the target `qdmi_docs` is built.
-file(GLOB_RECURSE DOXYGEN_INPUT_FILES ${PROJECT_SOURCE_DIR}/include/*.h
-     ${CMAKE_CURRENT_SOURCE_DIR}/*.md)
+# the cached result when the target `qdmi-docs` is built.
+file(
+  GLOB_RECURSE
+  DOXYGEN_INPUT_FILES
+  ${PROJECT_SOURCE_DIR}/include/*.h
+  ${CMAKE_CURRENT_SOURCE_DIR}/*.md
+  ${PROJECT_SOURCE_DIR}/CHANGELOG.md
+  ${PROJECT_SOURCE_DIR}/UPGRADING.md
+  ${PROJECT_SOURCE_DIR}/README.md)
 # After the variable above is correctly initialized, we can add the additional
 # files that are not source code but still part of the documentation. IMPORTANT:
 # The order the files with the static content are added here influences their
@@ -52,8 +58,13 @@ string(REPLACE ";" " " DOXYGEN_INPUT_DIRS "${DOXYGEN_INPUT_DIRS}")
 # can be included with the `\include`or `\snippet` command, we need to add the
 # directories where these files are located.
 set(DOXYGEN_EXAMPLE_DIRS
-    ${PROJECT_SOURCE_DIR}/examples ${PROJECT_SOURCE_DIR}/.github
-    ${PROJECT_SOURCE_DIR}/CHANGELOG.md ${PROJECT_SOURCE_DIR}/UPGRADING.md
+    ${PROJECT_SOURCE_DIR}/examples/device/src
+    ${PROJECT_SOURCE_DIR}/examples/driver
+    ${PROJECT_SOURCE_DIR}/examples/fomac
+    ${PROJECT_SOURCE_DIR}/examples/tool
+    ${PROJECT_SOURCE_DIR}/.github
+    ${PROJECT_SOURCE_DIR}/CHANGELOG.md
+    ${PROJECT_SOURCE_DIR}/UPGRADING.md
     ${PROJECT_SOURCE_DIR}/README.md)
 # Again, replace the semicolon with a space such that Doxygen can handle it.
 string(REPLACE ";" " " DOXYGEN_EXAMPLE_DIRS "${DOXYGEN_EXAMPLE_DIRS}")
@@ -113,4 +124,4 @@ add_custom_command(
   VERBATIM)
 
 # Create a custom target
-add_custom_target(qdmi_docs ALL DEPENDS ${DOXYGEN_OUTPUT_DIR}/html/index.html)
+add_custom_target(qdmi-docs ALL DEPENDS ${DOXYGEN_OUTPUT_DIR}/html/index.html)
diff --git a/docs/Doxyfile.in b/docs/Doxyfile.in
@@ -1,11 +1,11 @@
-# Copyright (c) 2024 - 2025 Munich Quantum Software Stack Project
+# Copyright (c) 2024 - 2026 QDMI Maintainers
 # All rights reserved.
 #
 # Licensed under the Apache License v2.0 with LLVM Exceptions (the "License");
 # you may not use this file except in compliance with the License.
 # You may obtain a copy of the License at
 #
-# https://github.com/Munich-Quantum-Software-Stack/QDMI/blob/develop/LICENSE.md
+# https://llvm.org/LICENSE.txt
 #
 # Unless required by applicable law or agreed to in writing, software
 # distributed under the License is distributed on an "AS IS" BASIS, WITHOUT

diff --git a/docs/_static/mqss_logo.svg b/docs/_static/mqss_logo.svg
diff --git a/docs/_static/mqss_logo_dark.svg b/docs/_static/mqss_logo_dark.svg
diff --git a/docs/_static/qdmi.svg b/docs/_static/qdmi.svg