✨ Neutral Atom QDMI Device

.license-tools-config.json

@@ -13,7 +13,8 @@
     ".mlir": "SLASH_STYLE",
     ".td": "SLASH_STYLE",
     ".yaml": "POUND_STYLE",
-    ".toml": "POUND_STYLE"
+    ".toml": "POUND_STYLE",
+    ".proto": "SLASH_STYLE"
   },
   "exclude": [
     "^\\.[^/]+",

cmake/ExternalDependencies.cmake

@@ -59,6 +59,23 @@ else()
   list(APPEND FETCH_PACKAGES boost_mp)
 endif()
 
+# Abseil is required by GTest and Protobuf. To avoid version conflicts, we add this dependency
+# centrally.
+set(ABSL_VERSION
+    20250512.1
+    CACHE STRING "abseil-cpp version")
+set(ABSL_URL https://github.com/abseil/abseil-cpp/archive/refs/tags/${ABSL_VERSION}.tar.gz)
+# The install instruction for re2 cannot be disabled and they require the export targets from
+# abseil.
+set(ABSL_ENABLE_INSTALL
+    ON
+    CACHE BOOL "" FORCE)
+set(ABSL_MSVC_STATIC_RUNTIME
+    OFF
+    CACHE BOOL "" FORCE)
+FetchContent_Declare(abseil-cpp URL ${ABSL_URL} FIND_PACKAGE_ARGS ${ABSL_VERSION} CONFIG NAMES absl)
+list(APPEND FETCH_PACKAGES abseil-cpp)
+
 if(BUILD_MQT_CORE_TESTS)
   set(gtest_force_shared_crt
       ON
@@ -71,5 +88,47 @@ if(BUILD_MQT_CORE_TESTS)
   list(APPEND FETCH_PACKAGES googletest)
 endif()
 
+set(Protobuf_VERSION
+    31.1
+    CACHE STRING "protobuf version")
+set(Protobuf_URL
+    https://github.com/protocolbuffers/protobuf/releases/download/v${Protobuf_VERSION}/protobuf-${Protobuf_VERSION}.tar.gz
+)
+# the default of the following is ON, they are just here to make more explicit that they are
+# required
+set(protobuf_BUILD_PROTOBUF_BINARIES ON)
+set(protobuf_BUILD_PROTOC_BINARIES ON)
+set(protobuf_BUILD_LIBUPB ON)
+# the default of the following is ON, but we do not need the tests
+set(protobuf_BUILD_TESTS OFF)
+set(protobuf_MSVC_STATIC_RUNTIME OFF)
+FetchContent_Declare(protobuf URL ${Protobuf_URL} FIND_PACKAGE_ARGS ${Protobuf_VERSION} CONFIG
+                                  NAMES protobuf)
+list(APPEND FETCH_PACKAGES protobuf)
+
+# cmake-format: off
+set(QDMI_VERSION 1.2.0
+        CACHE STRING "QDMI version")
+set(QDMI_REV "9034e653a6e368579d99e352ecd8390e6e947bc6"
+        CACHE STRING "QDMI identifier (tag, branch or commit hash)")
+set(QDMI_REPO_OWNER "Munich-Quantum-Software-Stack"
+        CACHE STRING "QDMI repository owner (change when using a fork)")
+# cmake-format: on
+FetchContent_Declare(
+  qdmi
+  GIT_REPOSITORY https://github.com/${QDMI_REPO_OWNER}/qdmi.git
+  GIT_TAG ${QDMI_REV}
+  FIND_PACKAGE_ARGS ${QDMI_VERSION})
+list(APPEND FETCH_PACKAGES qdmi)
+
+set(SPDLOG_VERSION
+    1.15.3
+    CACHE STRING "spdlog version")
+set(SPDLOG_URL https://github.com/gabime/spdlog/archive/refs/tags/v${SPDLOG_VERSION}.tar.gz)
+# Add position independent code for spdlog, this is required for python bindings on linux
+set(SPDLOG_BUILD_PIC ON)
+FetchContent_Declare(spdlog URL ${SPDLOG_URL} FIND_PACKAGE_ARGS ${SPDLOG_VERSION})
+list(APPEND FETCH_PACKAGES spdlog)
+
 # Make all declared dependencies available.
 FetchContent_MakeAvailable(${FETCH_PACKAGES})

docs/na_qdmi_device.md

@@ -0,0 +1,115 @@
+---
+file_format: mystnb
+kernelspec:
+  name: python3
+mystnb:
+  number_source_lines: true
+---
+
+# MQT Core Neutral Atom QDMI Device
+
+## Objective
+
+Compilation passes throughout MQT need information about the target device.
+The Neutral Atom QDMI device provides a uniform way to provide the necessary information.
+It defines a representation to easily provide static information in the form of a file.
+
+<!-- todo: Explain how to use the device. -->
+
+## Describing a Device
+
+The basis of a device implementation is a specification in a JSON file.
+These JSON files are defined on the basis of a protocol buffer schema that can be found in `proto/na/device.proto`.
+During compilation, this JSON file is parsed and the corresponding C++ code is produced for the actual QDMI device implementation.
+The C++ code is then compiled to a library that can be used by the QDMI driver.
+
+### JSON Schema
+
+An example instance of a device JSON file can be found in `json/na/device.json`.
+
+#### Top-Level Fields
+
+- **`name`** _(string)_: The name of the device.
+- **`num_qubits`** _(integer)_: The total number of qubits in the device.
+- **`traps`** _(array)_: A list of traps defining the qubit lattice structure.
+- **`minAtomDistance`** _(number)_: The minimum distance between atoms in the lattice.
+- **`globalSingleQubitOperations`** _(array)_: A list of global single-qubit operations supported by the device.
+- **`globalMultiQubitOperations`** _(array)_: A list of global multi-qubit operations supported by the device.
+- **`localSingleQubitOperations`** _(array)_: A list of local single-qubit operations supported by the device.
+- **`localMultiQubitOperations`** _(array)_: A list of local multi-qubit operations supported by the device.
+- **`shuttlingUnits`** _(array)_: A list of shuttling units for moving qubits.
+- **`decoherenceTimes`** _(object)_: Decoherence times for the qubits.
+- **`lengthUnit`** _(object)_: The unit of length used in the file.
+- **`timeUnit`** _(object)_: The unit of time used in the file.
+
+---
+
+#### Detailed Field Descriptions
+
+##### `traps` _(array of objects)_:
+
+- **`latticeOrigin`** _(object)_: The origin of the lattice.
+  - **`x`** _(number)_: X-coordinate of the origin.
+  - **`y`** _(number)_: Y-coordinate of the origin.
+- **`latticeVector1`** _(object)_: Defines one lattice vector.
+  - **`vector`** _(object)_: A vector in the lattice.
+    - **`x`** _(number)_: X-component of the vector.
+    - **`y`** _(number)_: Y-component of the vector.
+  - **`repeat`** _(integer)_: Number of repetitions of the vector.
+- **`latticeVector2`** _(object)_: Defines the other lattice vector.
+  - **`vector`** _(object)_: A vector in the lattice.
+    - **`x`** _(number)_: X-component of the vector.
+    - **`y`** _(number)_: Y-component of the vector.
+  - **`repeat`** _(integer)_: Number of repetitions of the vector.
+- **`sublatticeOffsets`** _(array of objects)_: Offsets for sublattices.
+  - **`x`** _(number)_: X-offset.
+  - **`y`** _(number)_: Y-offset.
+
+##### `globalSingleQubitOperations` and `localSingleQubitOperations` _(array of objects)_:
+
+- **`name`** _(string)_: The name of the operation.
+- **`region`** _(object)_: The region where the operation is applied.
+  - **`origin`** _(object)_: The origin of the region.
+    - **`x`** _(number)_: X-coordinate of the origin.
+    - **`y`** _(number)_: Y-coordinate of the origin.
+  - **`size`** _(object)_: The size of the region.
+    - **`width`** _(number)_: Width of the region.
+    - **`height`** _(number)_: Height of the region.
+- **`duration`** _(number)_: Duration of the operation.
+- **`fidelity`** _(number)_: Fidelity of the operation.
+- **`numParameters`** _(integer)_: Number of parameters for the operation.
+
+##### `globalMultiQubitOperations` and `localMultiQubitOperations` _(array of objects)_:
+
+- **`name`** _(string)_: The name of the operation.
+- **`region`** _(object)_: The region where the operation is applied (same structure as above).
+- **`interactionRadius`** _(number)_: Radius of interaction for the operation.
+- **`blockingRadius`** _(number)_: Blocking radius for the operation.
+- **`numQubits`** _(integer)_: Number of qubits involved in the operation.
+- **`numParameters`** _(integer)_: Number of parameters for the operation.
+- **`duration`** _(number)_: Duration of the operation.
+- **`fidelity`** _(number)_: Fidelity of the operation.
+- **`idlingFidelity`** _(number, optional)_: Fidelity when qubits are idle.
+
+##### `shuttlingUnits` _(array of objects)_:
+
+- **`name`** _(string)_: The name of the shuttling unit.
+- **`region`** _(object)_: The region where the shuttling unit operates (same structure as above).
+- **`numRows`** _(integer)_: Number of rows in the shuttling unit.
+- **`numColumns`** _(integer)_: Number of columns in the shuttling unit.
+- **`movingSpeed`** _(number)_: Speed of movement.
+- **`loadDuration`** _(number)_: Duration to load a qubit.
+- **`storeDuration`** _(number)_: Duration to store a qubit.
+- **`loadFidelity`** _(number)_: Fidelity of loading a qubit.
+- **`storeFidelity`** _(number)_: Fidelity of storing a qubit.
+- **`numParameters`** _(integer)_: Number of parameters for the shuttling unit.
+
+##### `decoherenceTimes` _(object)_:
+
+- **`t1`** _(number)_: Relaxation time (T1) in the specified time unit.
+- **`t2`** _(number)_: Dephasing time (T2) in the specified time unit.
+
+##### `lengthUnit` and `timeUnit` _(objects)_:
+
+- **`value`** _(number)_: The scaling factor for the unit.
+- **`unit`** _(string)_: The unit of measurement (e.g., "um" for micrometers, "us" for microseconds).

include/mqt-core/na/device/Generator.hpp

@@ -0,0 +1,73 @@
+/*
+ * 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
+ */
+
+#pragma once
+
+#include "na/device/device.pb.h"
+
+#include <istream>
+#include <ostream>
+#include <string>
+
+namespace na {
+/**
+ * @brief Writes a JSON schema with default values for the device configuration
+ * to the specified output stream.
+ * @param os is the output stream to write the JSON schema to.
+ * @throws std::runtime_error if the JSON conversion fails.
+ */
+auto writeJSONSchema(std::ostream& os) -> void;
+
+/**
+ * @brief Writes a JSON schema with default values for the device configuration
+ * to the specified path.
+ * @param path The path to write the JSON schema to.
+ * @throws std::runtime_error if the JSON conversion fails or the file cannot be
+ * opened.
+ */
+auto writeJSONSchema(const std::string& path) -> void;
+
+/**
+ * @brief Parses the device configuration from an input stream.
+ * @param is is the input stream containing the JSON representation of the
+ * device configuration.
+ * @returns The parsed device configuration as a Protobuf message.
+ * @throws std::runtime_error if the JSON cannot be parsed.
+ */
+[[nodiscard]] auto readJSON(std::istream& is) -> Device;
+
+/**
+ * @brief Parses the device configuration from a JSON file.
+ * @param path is the path to the JSON file containing the device configuration.
+ * @returns The parsed device configuration as a Protobuf message.
+ * @throws std::runtime_error if the JSON file does not exist, or the JSON file
+ * cannot be parsed.
+ */
+[[nodiscard]] auto readJSON(const std::string& path) -> Device;
+
+/**
+ * @brief Writes a header file with the device configuration to the specified
+ * output stream.
+ * @param device is the protobuf representation of the device.
+ * @param os is the output stream to write the header file to.
+ * @throws std::runtime_error if the file cannot be opened or written to.
+ */
+auto writeHeader(const Device& device, std::ostream& os) -> void;
+
+/**
+ * @brief Writes a header file with the device configuration to the specified
+ * path.
+ * @param device is the protobuf representation of the device.
+ * @param path is the path to write the header file to.
+ * @throws std::runtime_error if the file cannot be opened or written to.
+ */
+auto writeHeader(const Device& device, const std::string& path) -> void;
+
+} // namespace na