pasqal-qdmi 1.0.0__tar.gz

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -0,0 +1,49 @@
1
+ # Pasqal QDMI Device Agent Guide
2
+
3
+ Read [the development policy](docs/development.md) for code, testing and
4
+ contribution guidance. Read [capabilities](docs/capabilities.md) before changing
5
+ a QDMI or Pasqal boundary. [Maintenance](docs/maintenance.md) owns build,
6
+ release and documentation setup.
7
+
8
+ ## Repository layout
9
+
10
+ - `include/pasqal-qdmi-device/` and `src/` contain the C++ implementation and
11
+ Pasqal-specific constants; `cmake/` contains build support and the catalogue.
12
+ - `python/pasqal/qdmi/` exposes installed package paths and Core discovery.
13
+ - `test/` contains native tests, local HTTP fixtures and installed-package
14
+ tests.
15
+ - `docs/` contains Sphinx documentation and executable MyST-NB examples.
16
+ - Keep generated output in `build/` and `docs/_build/`, outside commits.
17
+
18
+ ## Working principles
19
+
20
+ - Inspect the worktree first and preserve unrelated changes. Complete authorized
21
+ work and relevant checks without routine confirmation questions.
22
+ - Trace producers, shared helpers and consumers before changing contracts. Reuse
23
+ C++20, existing dependencies and MQT Core's shared Python API.
24
+ - Keep C++ exceptions inside the QDMI C boundary. Preserve validation,
25
+ ownership, result ordering and accepted job identifiers. Never retry a cloud
26
+ submission automatically.
27
+ - Test observable behavior and concrete regressions. Diagnose failed checks
28
+ before changing code or weakening an assertion.
29
+ - Use short sentences and established terms. Document the current design,
30
+ contracts and useful examples; keep review history out of product docs.
31
+ - Use `///` for Doxygen and `//` for ordinary C++ comments. Follow configured
32
+ formatting, lint, typing and license-header checks.
33
+ - Keep exploratory scripts, machine setup and task reports outside the checkout.
34
+ Never print or commit credentials or authentication responses.
35
+ - Ordinary tests and documentation use EMU_FREE, the free cloud emulator. Keep
36
+ workloads small and waits bounded. Local HTTP fixtures test failures. Other
37
+ emulators may be billed; hardware and paid execution need authorization.
38
+ - Use signed, gitmoji-led commits. Preserve human attribution; record AI
39
+ assistance with `Assisted-by`, never `Co-authored-by`. Follow the development
40
+ policy for pull requests.
41
+ - Separate local checks, hosted CI, publication and hardware validation in
42
+ reports.
43
+
44
+ ## Validation
45
+
46
+ Run focused checks while developing and `uvx nox -s lint` before submission. Use
47
+ `uvx nox -s tests-3.14` for one Python version, `uvx nox -s tests` for the
48
+ supported matrix, `uvx nox -s native` for CTest, and
49
+ `uvx nox --non-interactive -s docs` for executable documentation.
@@ -0,0 +1,64 @@
1
+ <!-- Entries in each category are sorted by merge time, with the latest PRs appearing first. -->
2
+
3
+ # Changelog
4
+
5
+ All notable changes to this project will be documented in this file.
6
+
7
+ The format is based on a mixture of [Keep a Changelog] and [Common Changelog].
8
+ This project adheres to [Semantic Versioning], with the exception that minor
9
+ releases may include breaking changes.
10
+
11
+ ## [Unreleased]
12
+
13
+ ## [1.0.0] - 2026-10-27
14
+
15
+ ### Added
16
+
17
+ - ✨ Add a Pulser remote connection for `QPUBackend` ([#2])
18
+ ([**@awennersteen**]).
19
+
20
+ ### Changed
21
+
22
+ - 📚 Document installation from PyPI and link to the hosted documentation ([#5])
23
+ ([**@burgholzer**]).
24
+ - ⚡️ Serialize repeated concrete Pulser sequences once per batch ([#3])
25
+ ([**@burgholzer**]).
26
+ - ⚡️ Avoid rescanning batches during indexed status and result reads ([#3])
27
+ ([**@burgholzer**]).
28
+ - ⬆️ Require uv 0.13.4 for development ([#1]) ([**@denialhaag**]).
29
+
30
+ ### Fixed
31
+
32
+ - 🐛 Limit concurrent cloud tests across CI runs to respect EMU_FREE capacity
33
+ ([#9]) ([**@burgholzer**]).
34
+ - 🐛 Use GitHub CI for credentialed PR documentation builds ([#5])
35
+ ([**@burgholzer**]).
36
+ - 🐛 Propagate Windows macro protection to native unit tests ([#5])
37
+ ([**@burgholzer**]).
38
+ - 🐛 Enable PyPI uploads when a GitHub release is published ([#5])
39
+ ([**@burgholzer**]).
40
+
41
+ <!-- Versions -->
42
+
43
+ [Unreleased]: https://github.com/munich-quantum-software/pasqal-qdmi-device/compare/v1.0.0...main
44
+ [1.0.0]: https://github.com/munich-quantum-software/pasqal-qdmi-device/releases/tag/v1.0.0
45
+
46
+ <!-- Pull requests -->
47
+
48
+ [#9]: https://github.com/munich-quantum-software/pasqal-qdmi-device/pull/9
49
+ [#5]: https://github.com/munich-quantum-software/pasqal-qdmi-device/pull/5
50
+ [#3]: https://github.com/munich-quantum-software/pasqal-qdmi-device/pull/3
51
+ [#2]: https://github.com/munich-quantum-software/pasqal-qdmi-device/pull/2
52
+ [#1]: https://github.com/munich-quantum-software/pasqal-qdmi-device/pull/1
53
+
54
+ <!-- Contributors -->
55
+
56
+ [**@awennersteen**]: https://github.com/awennersteen
57
+ [**@burgholzer**]: https://github.com/burgholzer
58
+ [**@denialhaag**]: https://github.com/denialhaag
59
+
60
+ <!-- General links -->
61
+
62
+ [Keep a Changelog]: https://keepachangelog.com/en/1.1.0/
63
+ [Common Changelog]: https://common-changelog.org/
64
+ [Semantic Versioning]: https://semver.org/spec/v2.0.0.html
@@ -0,0 +1,92 @@
1
+ # Copyright (c) 2026 Munich Quantum Software Company GmbH
2
+ # Copyright (c) 2026 Pasqal SAS
3
+ # All rights reserved.
4
+ #
5
+ # Licensed under the Apache License v2.0 with LLVM Exceptions (the "License");
6
+ # you may not use this file except in compliance with the License.
7
+ # You may obtain a copy of the License at
8
+ #
9
+ # https://llvm.org/LICENSE.txt
10
+ #
11
+ # Unless required by applicable law or agreed to in writing, software
12
+ # distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
13
+ # WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
14
+ # License for the specific language governing permissions and limitations under
15
+ # the License.
16
+ #
17
+ # SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
18
+
19
+ cmake_minimum_required(VERSION 3.24...4.4)
20
+
21
+ project(
22
+ pasqal-qdmi-device
23
+ LANGUAGES C CXX
24
+ VERSION 1.0.0
25
+ DESCRIPTION "Pasqal QDMI Device Implementation")
26
+
27
+ if(NOT CMAKE_BUILD_TYPE AND NOT CMAKE_CONFIGURATION_TYPES)
28
+ set(CMAKE_BUILD_TYPE
29
+ Release
30
+ CACHE STRING "Choose the type of build." FORCE)
31
+ set_property(CACHE CMAKE_BUILD_TYPE PROPERTY STRINGS "Debug" "Release" "MinSizeRel"
32
+ "RelWithDebInfo")
33
+ endif()
34
+
35
+ set(CMAKE_CXX_STANDARD 20)
36
+ set(CMAKE_CXX_STANDARD_REQUIRED ON)
37
+ set(CMAKE_CXX_EXTENSIONS OFF)
38
+ set(CMAKE_CXX_SCAN_FOR_MODULES OFF)
39
+
40
+ include(CMakeDependentOption)
41
+
42
+ option(USE_INSTALLED_PASQAL_QDMI_DEVICE
43
+ "Use an installed version of the Pasqal QDMI Device to build tests" OFF)
44
+
45
+ if(USE_INSTALLED_PASQAL_QDMI_DEVICE)
46
+ find_package(pasqal-qdmi-device ${PROJECT_VERSION} REQUIRED CONFIG)
47
+ endif()
48
+
49
+ set(CMAKE_EXPORT_COMPILE_COMMANDS
50
+ ON
51
+ CACHE BOOL "Export compile commands" FORCE)
52
+
53
+ set(CMAKE_VERIFY_INTERFACE_HEADER_SETS
54
+ ON
55
+ CACHE BOOL "Verify interface header sets" FORCE)
56
+
57
+ set(QDMI_PREFIX "PASQAL")
58
+ set(PASQAL_QDMI_DEVICE_ID
59
+ "pasqal.default"
60
+ CACHE STRING "Stable identifier for the Pasqal QDMI Device")
61
+
62
+ cmake_dependent_option(
63
+ INSTALL_PASQAL_QDMI_DEVICE "Generate installation instructions for the Pasqal QDMI Device"
64
+ ${PROJECT_IS_TOP_LEVEL} "NOT USE_INSTALLED_PASQAL_QDMI_DEVICE" OFF)
65
+ option(BUILD_PASQAL_QDMI_TESTS "Build tests for the Pasqal QDMI device" ${PROJECT_IS_TOP_LEVEL})
66
+
67
+ include(cmake/ExternalDependencies.cmake)
68
+
69
+ set(QDMI_TARGET_NAME "pasqal-qdmi-device")
70
+
71
+ if(NOT USE_INSTALLED_PASQAL_QDMI_DEVICE)
72
+ add_subdirectory(src)
73
+ endif()
74
+
75
+ if(BUILD_PASQAL_QDMI_TESTS)
76
+ get_target_property(EXPORTED_QDMI_DEVICE_ID ${QDMI_TARGET_NAME} QDMI_DEVICE_ID)
77
+ get_target_property(EXPORTED_QDMI_DEVICE_PREFIX ${QDMI_TARGET_NAME} QDMI_DEVICE_PREFIX)
78
+ get_target_property(EXPORTED_QDMI_MANIFEST_NAME ${QDMI_TARGET_NAME} QDMI_MANIFEST_NAME)
79
+ if(NOT EXPORTED_QDMI_DEVICE_ID STREQUAL "${PASQAL_QDMI_DEVICE_ID}")
80
+ message(FATAL_ERROR "The Pasqal QDMI target does not export its stable ID")
81
+ endif()
82
+ if(NOT EXPORTED_QDMI_DEVICE_PREFIX STREQUAL "${QDMI_PREFIX}")
83
+ message(FATAL_ERROR "The Pasqal QDMI target does not export its symbol prefix")
84
+ endif()
85
+ if(NOT EXPORTED_QDMI_MANIFEST_NAME STREQUAL "${QDMI_TARGET_NAME}.qdmi.json")
86
+ message(FATAL_ERROR "The Pasqal QDMI target does not export its device catalog")
87
+ endif()
88
+
89
+ enable_testing()
90
+ include(GoogleTest)
91
+ add_subdirectory(test)
92
+ endif()
@@ -0,0 +1,217 @@
1
+ Apache License
2
+ Version 2.0, January 2004
3
+ http://www.apache.org/licenses/
4
+
5
+ TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
6
+
7
+ 1. Definitions.
8
+
9
+ "License" shall mean the terms and conditions for use, reproduction,
10
+ and distribution as defined by Sections 1 through 9 of this document.
11
+
12
+ "Licensor" shall mean the copyright owner or entity authorized by
13
+ the copyright owner that is granting the License.
14
+
15
+ "Legal Entity" shall mean the union of the acting entity and all
16
+ other entities that control, are controlled by, or are under common
17
+ control with that entity. For the purposes of this definition,
18
+ "control" means (i) the power, direct or indirect, to cause the
19
+ direction or management of such entity, whether by contract or
20
+ otherwise, or (ii) ownership of fifty percent (50%) or more of the
21
+ outstanding shares, or (iii) beneficial ownership of such entity.
22
+
23
+ "You" (or "Your") shall mean an individual or Legal Entity
24
+ exercising permissions granted by this License.
25
+
26
+ "Source" form shall mean the preferred form for making modifications,
27
+ including but not limited to software source code, documentation
28
+ source, and configuration files.
29
+
30
+ "Object" form shall mean any form resulting from mechanical
31
+ transformation or translation of a Source form, including but
32
+ not limited to compiled object code, generated documentation,
33
+ and conversions to other media types.
34
+
35
+ "Work" shall mean the work of authorship, whether in Source or
36
+ Object form, made available under the License, as indicated by a
37
+ copyright notice that is included in or attached to the work
38
+ (an example is provided in the Appendix below).
39
+
40
+ "Derivative Works" shall mean any work, whether in Source or Object
41
+ form, that is based on (or derived from) the Work and for which the
42
+ editorial revisions, annotations, elaborations, or other modifications
43
+ represent, as a whole, an original work of authorship. For the purposes
44
+ of this License, Derivative Works shall not include works that remain
45
+ separable from, or merely link (or bind by name) to the interfaces of,
46
+ the Work and Derivative Works thereof.
47
+
48
+ "Contribution" shall mean any work of authorship, including
49
+ the original version of the Work and any modifications or additions
50
+ to that Work or Derivative Works thereof, that is intentionally
51
+ submitted to Licensor for inclusion in the Work by the copyright owner
52
+ or by an individual or Legal Entity authorized to submit on behalf of
53
+ the copyright owner. For the purposes of this definition, "submitted"
54
+ means any form of electronic, verbal, or written communication sent
55
+ to the Licensor or its representatives, including but not limited to
56
+ communication on electronic mailing lists, source code control systems,
57
+ and issue tracking systems that are managed by, or on behalf of, the
58
+ Licensor for the purpose of discussing and improving the Work, but
59
+ excluding communication that is conspicuously marked or otherwise
60
+ designated in writing by the copyright owner as "Not a Contribution."
61
+
62
+ "Contributor" shall mean Licensor and any individual or Legal Entity
63
+ on behalf of whom a Contribution has been received by Licensor and
64
+ subsequently incorporated within the Work.
65
+
66
+ 2. Grant of Copyright License. Subject to the terms and conditions of
67
+ this License, each Contributor hereby grants to You a perpetual,
68
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
69
+ copyright license to reproduce, prepare Derivative Works of,
70
+ publicly display, publicly perform, sublicense, and distribute the
71
+ Work and such Derivative Works in Source or Object form.
72
+
73
+ 3. Grant of Patent License. Subject to the terms and conditions of
74
+ this License, each Contributor hereby grants to You a perpetual,
75
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
76
+ (except as stated in this section) patent license to make, have made,
77
+ use, offer to sell, sell, import, and otherwise transfer the Work,
78
+ where such license applies only to those patent claims licensable
79
+ by such Contributor that are necessarily infringed by their
80
+ Contribution(s) alone or by combination of their Contribution(s)
81
+ with the Work to which such Contribution(s) was submitted. If You
82
+ institute patent litigation against any entity (including a
83
+ cross-claim or counterclaim in a lawsuit) alleging that the Work
84
+ or a Contribution incorporated within the Work constitutes direct
85
+ or contributory patent infringement, then any patent licenses
86
+ granted to You under this License for that Work shall terminate
87
+ as of the date such litigation is filed.
88
+
89
+ 4. Redistribution. You may reproduce and distribute copies of the
90
+ Work or Derivative Works thereof in any medium, with or without
91
+ modifications, and in Source or Object form, provided that You
92
+ meet the following conditions:
93
+
94
+ (a) You must give any other recipients of the Work or
95
+ Derivative Works a copy of this License; and
96
+
97
+ (b) You must cause any modified files to carry prominent notices
98
+ stating that You changed the files; and
99
+
100
+ (c) You must retain, in the Source form of any Derivative Works
101
+ that You distribute, all copyright, patent, trademark, and
102
+ attribution notices from the Source form of the Work,
103
+ excluding those notices that do not pertain to any part of
104
+ the Derivative Works; and
105
+
106
+ (d) If the Work includes a "NOTICE" text file as part of its
107
+ distribution, then any Derivative Works that You distribute must
108
+ include a readable copy of the attribution notices contained
109
+ within such NOTICE file, excluding those notices that do not
110
+ pertain to any part of the Derivative Works, in at least one
111
+ of the following places: within a NOTICE text file distributed
112
+ as part of the Derivative Works; within the Source form or
113
+ documentation, if provided along with the Derivative Works; or,
114
+ within a display generated by the Derivative Works, if and
115
+ wherever such third-party notices normally appear. The contents
116
+ of the NOTICE file are for informational purposes only and
117
+ do not modify the License. You may add Your own attribution
118
+ notices within Derivative Works that You distribute, alongside
119
+ or as an addendum to the NOTICE text from the Work, provided
120
+ that such additional attribution notices cannot be construed
121
+ as modifying the License.
122
+
123
+ You may add Your own copyright statement to Your modifications and
124
+ may provide additional or different license terms and conditions
125
+ for use, reproduction, or distribution of Your modifications, or
126
+ for any such Derivative Works as a whole, provided Your use,
127
+ reproduction, and distribution of the Work otherwise complies with
128
+ the conditions stated in this License.
129
+
130
+ 5. Submission of Contributions. Unless You explicitly state otherwise,
131
+ any Contribution intentionally submitted for inclusion in the Work
132
+ by You to the Licensor shall be under the terms and conditions of
133
+ this License, without any additional terms or conditions.
134
+ Notwithstanding the above, nothing herein shall supersede or modify
135
+ the terms of any separate license agreement you may have executed
136
+ with Licensor regarding such Contributions.
137
+
138
+ 6. Trademarks. This License does not grant permission to use the trade
139
+ names, trademarks, service marks, or product names of the Licensor,
140
+ except as required for reasonable and customary use in describing the
141
+ origin of the Work and reproducing the content of the NOTICE file.
142
+
143
+ 7. Disclaimer of Warranty. Unless required by applicable law or
144
+ agreed to in writing, Licensor provides the Work (and each
145
+ Contributor provides its Contributions) on an "AS IS" BASIS,
146
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
147
+ implied, including, without limitation, any warranties or conditions
148
+ of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
149
+ PARTICULAR PURPOSE. You are solely responsible for determining the
150
+ appropriateness of using or redistributing the Work and assume any
151
+ risks associated with Your exercise of permissions under this License.
152
+
153
+ 8. Limitation of Liability. In no event and under no legal theory,
154
+ whether in tort (including negligence), contract, or otherwise,
155
+ unless required by applicable law (such as deliberate and grossly
156
+ negligent acts) or agreed to in writing, shall any Contributor be
157
+ liable to You for damages, including any direct, indirect, special,
158
+ incidental, or consequential damages of any character arising as a
159
+ result of this License or out of the use or inability to use the
160
+ Work (including but not limited to damages for loss of goodwill,
161
+ work stoppage, computer failure or malfunction, or any and all
162
+ other commercial damages or losses), even if such Contributor
163
+ has been advised of the possibility of such damages.
164
+
165
+ 9. Accepting Warranty or Additional Liability. While redistributing
166
+ the Work or Derivative Works thereof, You may choose to offer,
167
+ and charge a fee for, acceptance of support, warranty, indemnity,
168
+ or other liability obligations and/or rights consistent with this
169
+ License. However, in accepting such obligations, You may act only
170
+ on Your own behalf and on Your sole responsibility, not on behalf
171
+ of any other Contributor, and only if You agree to indemnify,
172
+ defend, and hold each Contributor harmless for any liability
173
+ incurred by, or claims asserted against, such Contributor by reason
174
+ of your accepting any such warranty or additional liability.
175
+
176
+ END OF TERMS AND CONDITIONS
177
+
178
+ APPENDIX: How to apply the Apache License to your work.
179
+
180
+ To apply the Apache License to your work, attach the following
181
+ boilerplate notice, with the fields enclosed by brackets "[]"
182
+ replaced with your own identifying information. (Don't include
183
+ the brackets!) The text should be enclosed in the appropriate
184
+ comment syntax for the file format. We also recommend that a
185
+ file or class name and description of purpose be included on the
186
+ same "printed page" as the copyright notice for easier
187
+ identification within third-party archives.
188
+
189
+ Copyright [yyyy] [name of copyright owner]
190
+
191
+ Licensed under the Apache License, Version 2.0 (the "License");
192
+ you may not use this file except in compliance with the License.
193
+ You may obtain a copy of the License at
194
+
195
+ http://www.apache.org/licenses/LICENSE-2.0
196
+
197
+ Unless required by applicable law or agreed to in writing, software
198
+ distributed under the License is distributed on an "AS IS" BASIS,
199
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
200
+ See the License for the specific language governing permissions and
201
+ limitations under the License.
202
+
203
+ ---- LLVM Exceptions to the Apache 2.0 License ----
204
+
205
+ As an exception, if, as a result of your compiling your source code, portions
206
+ of this Software are embedded into an Object form of such source code, you
207
+ may redistribute such embedded portions in such Object form without complying
208
+ with the conditions of Sections 4(a), 4(b) and 4(d) of the License.
209
+
210
+ In addition, if you combine or link compiled forms of this Software with
211
+ software that is licensed under the GPLv2 ("Combined Software") and if a
212
+ court of competent jurisdiction determines that the patent provision (Section
213
+ 3), the indemnity provision (Section 9) or other Section of the License
214
+ conflicts with the conditions of the GPLv2, you may retroactively and
215
+ prospectively choose to deem waived or otherwise exclude such Section(s) of
216
+ the License, but only in their entirety and only with respect to the Combined
217
+ Software.
@@ -0,0 +1,131 @@
1
+ Metadata-Version: 2.5
2
+ Name: pasqal-qdmi
3
+ Version: 1.0.0
4
+ Summary: Pasqal QDMI Device Implementation
5
+ Author-Email: Lukas Burgholzer <burgholzer@me.com>, Aleksander Wennersteen <aleksander.wennersteen@pasqal.com>
6
+ License-Expression: Apache-2.0 WITH LLVM-exception
7
+ License-File: LICENSE
8
+ Classifier: Development Status :: 5 - Production/Stable
9
+ Classifier: Intended Audience :: Information Technology
10
+ Classifier: Intended Audience :: Science/Research
11
+ Classifier: Natural Language :: English
12
+ Classifier: Operating System :: MacOS
13
+ Classifier: Operating System :: Microsoft :: Windows
14
+ Classifier: Operating System :: POSIX :: Linux
15
+ Classifier: Programming Language :: C++
16
+ Classifier: Programming Language :: Python
17
+ Classifier: Programming Language :: Python :: 3
18
+ Classifier: Programming Language :: Python :: 3 :: Only
19
+ Classifier: Programming Language :: Python :: 3.11
20
+ Classifier: Programming Language :: Python :: 3.12
21
+ Classifier: Programming Language :: Python :: 3.13
22
+ Classifier: Programming Language :: Python :: 3.14
23
+ Classifier: Programming Language :: Python :: 3.15
24
+ Classifier: Topic :: Scientific/Engineering :: Quantum Computing
25
+ Classifier: Typing :: Typed
26
+ Project-URL: Homepage, https://github.com/munich-quantum-software/pasqal-qdmi-device
27
+ Project-URL: Documentation, https://pasqal-qdmi-device.readthedocs.io/en/stable/
28
+ Project-URL: Issues, https://github.com/munich-quantum-software/pasqal-qdmi-device/issues
29
+ Requires-Python: >=3.11
30
+ Provides-Extra: core
31
+ Requires-Dist: mqt-core>=4.1.1; extra == "core"
32
+ Provides-Extra: pulser
33
+ Requires-Dist: pulser>=1.9.1; extra == "pulser"
34
+ Description-Content-Type: text/markdown
35
+ Import-Name: pasqal.qdmi
36
+ Import-Namespace: pasqal
37
+
38
+ ![Python](https://img.shields.io/badge/python-3.11%2B-blue?style=flat-square&logo=python)
39
+ ![OS](https://img.shields.io/badge/os-linux%20%7C%20macos%20%7C%20windows-blue?style=flat-square)
40
+ [![License](https://img.shields.io/badge/license-Apache--2.0%20WITH%20LLVM--exception-blue.svg?style=flat-square)](https://github.com/munich-quantum-software/pasqal-qdmi-device/blob/main/LICENSE)
41
+ [![CI](https://img.shields.io/github/actions/workflow/status/munich-quantum-software/pasqal-qdmi-device/ci.yml?branch=main&style=flat-square&logo=github&label=ci)](https://github.com/munich-quantum-software/pasqal-qdmi-device/actions/workflows/ci.yml)
42
+ [![Documentation](https://img.shields.io/readthedocs/pasqal-qdmi-device?logo=readthedocs&style=flat-square)](https://pasqal-qdmi-device.readthedocs.io/en/stable/)
43
+
44
+ # Pasqal QDMI Device
45
+
46
+ An implementation of the
47
+ [Quantum Device Management Interface (QDMI)](https://github.com/Munich-Quantum-Software-Stack/QDMI)
48
+ for Pasqal neutral-atom quantum processors and emulators.
49
+
50
+ The library exposes Pasqal Cloud through the vendor-neutral QDMI C interface. It
51
+ submits [Pulser](https://pulser.readthedocs.io/) pulse sequences, queries device
52
+ capabilities and queue information, and retrieves measurement results. Python
53
+ applications can use the shared [MQT Core](https://mqt.readthedocs.io/) QDMI
54
+ API.
55
+
56
+ <!-- rumdl-disable MD033 -->
57
+ <p align="center">
58
+ <a href="https://www.pasqal.com/">
59
+ <picture>
60
+ <source media="(prefers-color-scheme: dark)" srcset="https://raw.githubusercontent.com/munich-quantum-software/pasqal-qdmi-device/refs/heads/main/docs/_static/logo-pasqal-dark.svg">
61
+ <img src="https://raw.githubusercontent.com/munich-quantum-software/pasqal-qdmi-device/refs/heads/main/docs/_static/logo-pasqal-light.svg" width="260" alt="Pasqal">
62
+ </picture>
63
+ </a>
64
+ </p>
65
+ <p align="center">
66
+ <a href="https://pasqal-qdmi-device.readthedocs.io/en/stable/">
67
+ <img width="30%" src="https://img.shields.io/badge/documentation-blue?style=for-the-badge&logo=read%20the%20docs" alt="Documentation" />
68
+ </a>
69
+ </p>
70
+ <!-- rumdl-enable MD033 -->
71
+
72
+ ## Key Features
73
+
74
+ - A stable generic device, `pasqal.default`, for runtime configuration.
75
+ - An installed catalogue of stable IDs for Pasqal Cloud systems.
76
+ - Native Pulser programs and ordered batches through QDMI 1.4.
77
+ - Device metadata, queue length, indexed counts, job retrieval and cancellation.
78
+ - Password-realm authentication with automatic token refresh.
79
+ - A native C++ library and optional Python integration through MQT Core.
80
+
81
+ The provider accepts built, measured Pulser sequences. It does not compile gate
82
+ circuits into pulses. EMU_FREE is validated end to end; access to other
83
+ emulators and quantum processors depends on your Pasqal account and region.
84
+
85
+ ## Getting Started
86
+
87
+ Install the Python package with the optional Core and Pulser integrations:
88
+
89
+ ```console
90
+ uv pip install 'pasqal-qdmi[core,pulser]'
91
+ ```
92
+
93
+ Building from source requires a C++20 compiler, CMake 3.24 or newer, and OpenSSL
94
+ 3 development files on Linux. macOS uses Apple's curl and Windows uses Schannel.
95
+ CMake builds CPR and, outside macOS, curl; installed compression libraries are
96
+ detected automatically. A native installation does not require Python:
97
+
98
+ ```console
99
+ cmake -S . -B build -DCMAKE_BUILD_TYPE=Release -DBUILD_PASQAL_QDMI_TESTS=OFF
100
+ cmake --build build --config Release
101
+ cmake --install build --prefix /path/to/install
102
+ ```
103
+
104
+ See
105
+ [installation](https://pasqal-qdmi-device.readthedocs.io/en/stable/installation.html)
106
+ for wheel installation and platform support.
107
+
108
+ ## Where to Start
109
+
110
+ | I want to... | Read... |
111
+ | ----------------------------------------------------- | -------------------------------------------------------------------------------------------- |
112
+ | install the package or build from source | [Installation](https://pasqal-qdmi-device.readthedocs.io/en/stable/installation.html) |
113
+ | configure my account and project | [Authentication](https://pasqal-qdmi-device.readthedocs.io/en/stable/authentication.html) |
114
+ | choose a cloud system and understand its capabilities | [Device capabilities](https://pasqal-qdmi-device.readthedocs.io/en/stable/capabilities.html) |
115
+ | submit Pulser sequences and retrieve results | [Usage](https://pasqal-qdmi-device.readthedocs.io/en/stable/usage.html) |
116
+ | diagnose authentication or job failures | [Troubleshooting](https://pasqal-qdmi-device.readthedocs.io/en/stable/troubleshooting.html) |
117
+ | develop and test the provider | [Development](https://pasqal-qdmi-device.readthedocs.io/en/stable/development.html) |
118
+
119
+ ## Contributors and Support
120
+
121
+ The Pasqal QDMI Device is developed by [MQSC](https://mq.sc) and
122
+ [Pasqal](https://www.pasqal.com/).
123
+
124
+ Please use
125
+ [GitHub Issues](https://github.com/munich-quantum-software/pasqal-qdmi-device/issues)
126
+ for bug reports and feature requests.
127
+
128
+ ## License
129
+
130
+ The project is licensed under the Apache License 2.0 with LLVM exceptions; see
131
+ [LICENSE](https://github.com/munich-quantum-software/pasqal-qdmi-device/blob/main/LICENSE).
@@ -0,0 +1,94 @@
1
+ ![Python](https://img.shields.io/badge/python-3.11%2B-blue?style=flat-square&logo=python)
2
+ ![OS](https://img.shields.io/badge/os-linux%20%7C%20macos%20%7C%20windows-blue?style=flat-square)
3
+ [![License](https://img.shields.io/badge/license-Apache--2.0%20WITH%20LLVM--exception-blue.svg?style=flat-square)](https://github.com/munich-quantum-software/pasqal-qdmi-device/blob/main/LICENSE)
4
+ [![CI](https://img.shields.io/github/actions/workflow/status/munich-quantum-software/pasqal-qdmi-device/ci.yml?branch=main&style=flat-square&logo=github&label=ci)](https://github.com/munich-quantum-software/pasqal-qdmi-device/actions/workflows/ci.yml)
5
+ [![Documentation](https://img.shields.io/readthedocs/pasqal-qdmi-device?logo=readthedocs&style=flat-square)](https://pasqal-qdmi-device.readthedocs.io/en/stable/)
6
+
7
+ # Pasqal QDMI Device
8
+
9
+ An implementation of the
10
+ [Quantum Device Management Interface (QDMI)](https://github.com/Munich-Quantum-Software-Stack/QDMI)
11
+ for Pasqal neutral-atom quantum processors and emulators.
12
+
13
+ The library exposes Pasqal Cloud through the vendor-neutral QDMI C interface. It
14
+ submits [Pulser](https://pulser.readthedocs.io/) pulse sequences, queries device
15
+ capabilities and queue information, and retrieves measurement results. Python
16
+ applications can use the shared [MQT Core](https://mqt.readthedocs.io/) QDMI
17
+ API.
18
+
19
+ <!-- rumdl-disable MD033 -->
20
+ <p align="center">
21
+ <a href="https://www.pasqal.com/">
22
+ <picture>
23
+ <source media="(prefers-color-scheme: dark)" srcset="https://raw.githubusercontent.com/munich-quantum-software/pasqal-qdmi-device/refs/heads/main/docs/_static/logo-pasqal-dark.svg">
24
+ <img src="https://raw.githubusercontent.com/munich-quantum-software/pasqal-qdmi-device/refs/heads/main/docs/_static/logo-pasqal-light.svg" width="260" alt="Pasqal">
25
+ </picture>
26
+ </a>
27
+ </p>
28
+ <p align="center">
29
+ <a href="https://pasqal-qdmi-device.readthedocs.io/en/stable/">
30
+ <img width="30%" src="https://img.shields.io/badge/documentation-blue?style=for-the-badge&logo=read%20the%20docs" alt="Documentation" />
31
+ </a>
32
+ </p>
33
+ <!-- rumdl-enable MD033 -->
34
+
35
+ ## Key Features
36
+
37
+ - A stable generic device, `pasqal.default`, for runtime configuration.
38
+ - An installed catalogue of stable IDs for Pasqal Cloud systems.
39
+ - Native Pulser programs and ordered batches through QDMI 1.4.
40
+ - Device metadata, queue length, indexed counts, job retrieval and cancellation.
41
+ - Password-realm authentication with automatic token refresh.
42
+ - A native C++ library and optional Python integration through MQT Core.
43
+
44
+ The provider accepts built, measured Pulser sequences. It does not compile gate
45
+ circuits into pulses. EMU_FREE is validated end to end; access to other
46
+ emulators and quantum processors depends on your Pasqal account and region.
47
+
48
+ ## Getting Started
49
+
50
+ Install the Python package with the optional Core and Pulser integrations:
51
+
52
+ ```console
53
+ uv pip install 'pasqal-qdmi[core,pulser]'
54
+ ```
55
+
56
+ Building from source requires a C++20 compiler, CMake 3.24 or newer, and OpenSSL
57
+ 3 development files on Linux. macOS uses Apple's curl and Windows uses Schannel.
58
+ CMake builds CPR and, outside macOS, curl; installed compression libraries are
59
+ detected automatically. A native installation does not require Python:
60
+
61
+ ```console
62
+ cmake -S . -B build -DCMAKE_BUILD_TYPE=Release -DBUILD_PASQAL_QDMI_TESTS=OFF
63
+ cmake --build build --config Release
64
+ cmake --install build --prefix /path/to/install
65
+ ```
66
+
67
+ See
68
+ [installation](https://pasqal-qdmi-device.readthedocs.io/en/stable/installation.html)
69
+ for wheel installation and platform support.
70
+
71
+ ## Where to Start
72
+
73
+ | I want to... | Read... |
74
+ | ----------------------------------------------------- | -------------------------------------------------------------------------------------------- |
75
+ | install the package or build from source | [Installation](https://pasqal-qdmi-device.readthedocs.io/en/stable/installation.html) |
76
+ | configure my account and project | [Authentication](https://pasqal-qdmi-device.readthedocs.io/en/stable/authentication.html) |
77
+ | choose a cloud system and understand its capabilities | [Device capabilities](https://pasqal-qdmi-device.readthedocs.io/en/stable/capabilities.html) |
78
+ | submit Pulser sequences and retrieve results | [Usage](https://pasqal-qdmi-device.readthedocs.io/en/stable/usage.html) |
79
+ | diagnose authentication or job failures | [Troubleshooting](https://pasqal-qdmi-device.readthedocs.io/en/stable/troubleshooting.html) |
80
+ | develop and test the provider | [Development](https://pasqal-qdmi-device.readthedocs.io/en/stable/development.html) |
81
+
82
+ ## Contributors and Support
83
+
84
+ The Pasqal QDMI Device is developed by [MQSC](https://mq.sc) and
85
+ [Pasqal](https://www.pasqal.com/).
86
+
87
+ Please use
88
+ [GitHub Issues](https://github.com/munich-quantum-software/pasqal-qdmi-device/issues)
89
+ for bug reports and feature requests.
90
+
91
+ ## License
92
+
93
+ The project is licensed under the Apache License 2.0 with LLVM exceptions; see
94
+ [LICENSE](https://github.com/munich-quantum-software/pasqal-qdmi-device/blob/main/LICENSE).