ibm-qdmi 0.1.0__tar.gz

ibm_qdmi-0.1.0/AGENTS.md

@@ -0,0 +1,136 @@
+# IBM QDMI Device Agent Guide
+
+Follow this guide and the nearest scoped `AGENTS.md`. Use
+[`docs/development.md`](docs/development.md) for build, test, and documentation
+commands. Keep this file focused on repository-specific guardrails.
+
+## Repository Layout
+
+- `src/` contains the native device, HTTP transport, IAM authentication, and
+  metadata parsing. `include/` contains public IBM constants. Generated QDMI
+  headers stay in the build tree.
+- `python/ibm/qdmi/` contains the Python package, installed paths, and
+  information CLI. The catalogue template lives in `cmake/` and installs beside
+  the library. The optional Qiskit backend reuses MQT Core's backend, job, and
+  primitives.
+- `test/unit/` contains hermetic GoogleTest cases. `test/integration/` checks
+  the shared library and loopback transport. `test/python/` tests Python
+  modules.
+- `cmake/`, `CMakeLists.txt`, and `pyproject.toml` define builds. Keep generated
+  output in `build/` and `docs/_build/`, never in commits.
+- The project uses Apache-2.0 WITH LLVM-exception. SPANK is out of scope.
+
+## Working Principles
+
+- Inspect the worktree before editing and preserve unrelated user changes.
+- Prefer the smallest change that fully solves the problem. Reuse existing code
+  and C++20 facilities before adding abstractions or settings.
+- Follow documented policy. Neighboring code does not override instructions.
+- Write comments, documentation, tests, diagnostics, and public text for the
+  final design. Remove review chronology and abandoned approaches.
+- Use short sentences, active voice, and one established term per concept.
+  Preserve the capitalization of IBM, QDMI, OpenQASM, CMake, and Python.
+- Add tests for changed behavior or concrete regressions. Keep tests in `test/`
+  and start with focused checks. Do not add artificial passing device tests.
+- Keep cleanup separate from behavior changes unless correctness requires both.
+  Retain only narrow, justified suppressions.
+- Keep documentation at its existing source of truth and link to it.
+- Keep project documentation and configuration self-contained. Do not name or
+  link other device implementations. Preserve required copyright and license
+  notices in copied material.
+- Group related changes in a concise changelog entry. Once a PR exists, include
+  its reference and every contributing author as `([#123]) ([**@username**])`
+  and define their links at the bottom of `CHANGELOG.md`. Do not invent PRs.
+- Never hand-edit generated files. Change their source configuration instead.
+  Change externally managed templates in their owning repository.
+- Preserve copyright and license notices on copied material.
+
+## C++ and QDMI Contracts
+
+The project targets C++20. Use `///` for documentation comments and keep API
+documentation at the declaration. Explain only details that names and signatures
+do not convey. Use C++ casts, not C-style casts.
+
+Preserve the QDMI C ABI and the `IBM_` symbol prefix. No C++ exception may cross
+the C boundary. Honor size queries, handle validation, status codes, and null
+checks. Jobs retain their session resources until freed. Never retry a job
+submission automatically or treat local handle cleanup as remote cancellation.
+Preserve physical qubit indices and classical-bit ordering through execution.
+Keep framework imports and package information commands free of live access.
+
+## Build and Validation
+
+Run offline tests by default. Collect coverage without IBM credentials or QPU
+submissions; never spend hardware time to improve coverage. Separate native,
+wheel, documentation, and installed-consumer build directories under `build/`.
+Do not run package builds concurrently in the same build directory. For
+dependency-only setup, use `uv sync --locked --only-group dev`.
+
+- Run `uvx nox -s lint` after each completed batch of changes. Inspect formatter
+  changes, keep only relevant changes, and rerun the check.
+- For C++ changes, reproduce `.github/workflows/cpp-linter.yml` against every
+  line of each changed file. Report existing diagnostics rather than hiding them
+  with broad suppressions.
+- Run focused Python tests with `uvx nox -s tests-3.14 -- <test path>`. Use
+  `uvx nox -s tests minimums` for the supported Python matrix.
+- Use Google-style Python docstrings. Preserve the `ibm.qdmi` namespace. Fix
+  Ruff and ty findings where possible.
+- Build Sphinx and Doxygen through the dedicated Nox documentation session.
+
+### Live Access
+
+Never print, store, or commit credentials, tokens, account identifiers, or
+private backend details. Live IBM access requires explicit authorization for the
+service, backend, and spending scope. The opt-in metadata checks submit no jobs.
+The manual metadata workflow runs from merged `main` in the branch-restricted
+`ibm-quantum` environment. Never dispatch from a PR or merge to enable a live
+run without human approval. Keep credentials confined to the live test step,
+after wheel installation. Follow `docs/development.md` for commands.
+
+Keep live tests marked `live` and skipped before credential access unless
+`--run-live` is explicit. Preserve sequential execution and fixed diagnostic
+categories. Never retain raw responses, topology, or calibration snapshots in
+logs or artifacts. Reproduce compatibility failures with synthetic fixtures
+before fixing them. Quantum checks require the separate `quantum` marker and
+`--run-quantum` opt-in. Run them only after the offline CI gates on merged
+`main` or same-repository PRs labeled `live-qpu-tests`. Applying that label
+requires human authorization and also opts subsequent PR updates into hardware
+checks. Label additions reuse the exact merge commit's successful offline CI and
+retained candidate. Unrelated label changes must not start jobs, cancel CI, or
+publish a skipped `🚦 Check`. Fork PRs remain offline. The authorized CI budget
+is one job each on Berlin and Aachen, 128 shots per job, and at most 60 seconds
+of QPU execution per job. Do not make paid local submissions or automatically
+retry hardware tests. Preserve the tested candidate wheel across offline and
+hardware jobs. The `🚦 Check` aggregate covers every Actions prerequisite on
+`main`. Pre-commit.ci and Read the Docs are required before merging; hardware
+execution uses the Actions prerequisites on the tested commit. Hardware results
+and job IDs must not be uploaded as artifacts.
+
+## Git and GitHub
+
+- Keep commits focused. Start subjects with a gitmoji and an imperative verb;
+  target 50 characters and never exceed 72. Use the body for constraints and
+  non-obvious decisions.
+- Sign commits and annotated tags with the configured key. Verify commits with
+  `git verify-commit HEAD` before pushing; never bypass a signing failure.
+- Preserve human attribution. Use `Assisted-by` for AI assistance, never an AI
+  `Co-authored-by` trailer.
+- Push, open or merge PRs, and post public text only within explicit human
+  authorization. Request new authority before expanding that scope.
+- Start every agent-authored or agent-edited public text body with
+  `🤖 *AI text below* 🤖`; titles and commit messages are exempt. Commit
+  messages record AI assistance through the `Assisted-by` trailer only. For
+  other public text, state how AI assisted the work and leave acceptance and
+  responsibility with the human reviewer.
+- Use the applicable PR template, labels, and requested assignee. Do not invent
+  checklist items or attest to human review on the user's behalf.
+- Do not work on `good first issue` tasks or post repetitive reviews.
+- A push does not authorize CI monitoring. Verify the remote head, report the
+  available status, and stop unless monitoring was requested.
+
+## Handoff
+
+Inspect the final diff and worktree. Report what changed and each check run,
+including failures or checks that could not run. Distinguish local validation,
+live validation, and hosted CI for the final head. Never describe queued checks
+or checks from an older commit as passing validation of the new head.

ibm_qdmi-0.1.0/CHANGELOG.md

@@ -0,0 +1,36 @@
+<!-- Entries in each category are sorted by merge time, with the latest PRs appearing first. -->
+
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+The format is based on a mixture of [Keep a Changelog] and [Common Changelog].
+This project adheres to [Semantic Versioning], with the exception that minor
+releases may include breaking changes.
+
+## [Unreleased]
+
+## [0.1.0] - 2026-10-05
+
+_This is the initial release of the IBM QDMI Device._
+
+### Added
+
+- 🎉 Initial release. See the [documentation] for features and usage.
+  ([**@marcelwa**])
+
+<!-- Version links -->
+
+[unreleased]: https://github.com/munich-quantum-software/ibm-qdmi-device/compare/v0.1.0...HEAD
+[0.1.0]: https://github.com/munich-quantum-software/ibm-qdmi-device/releases/tag/v0.1.0
+
+<!-- Contributor -->
+
+[**@marcelwa**]: https://github.com/marcelwa
+
+<!-- General links -->
+
+[Keep a Changelog]: https://keepachangelog.com/en/1.1.0/
+[Common Changelog]: https://common-changelog.org/
+[Semantic Versioning]: https://semver.org/spec/v2.0.0.html
+[documentation]: https://ibm-qdmi-device.readthedocs.io/en/latest/

ibm_qdmi-0.1.0/CMakeLists.txt

@@ -0,0 +1,73 @@
+# Copyright (c) 2026 Munich Quantum Software Company GmbH
+# 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://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
+# WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
+# License for the specific language governing permissions and limitations under
+# the License.
+#
+# SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
+
+cmake_minimum_required(VERSION 3.24...4.4)
+project(
+  ibm-qdmi-device
+  VERSION 0.1.0
+  LANGUAGES C CXX
+  DESCRIPTION "IBM QDMI Device")
+
+if(NOT CMAKE_BUILD_TYPE AND NOT CMAKE_CONFIGURATION_TYPES)
+  set(CMAKE_BUILD_TYPE
+      Release
+      CACHE STRING "Choose the type of build." FORCE)
+  set_property(CACHE CMAKE_BUILD_TYPE PROPERTY STRINGS Debug Release MinSizeRel RelWithDebInfo)
+endif()
+
+set(CMAKE_EXPORT_COMPILE_COMMANDS ON)
+set(CMAKE_CXX_STANDARD 20)
+set(CMAKE_CXX_STANDARD_REQUIRED ON)
+set(CMAKE_CXX_EXTENSIONS OFF)
+# There are no C++ modules; keep the compilation database usable before a build.
+set(CMAKE_CXX_SCAN_FOR_MODULES OFF)
+set(CMAKE_VERIFY_INTERFACE_HEADER_SETS ON)
+set(CMAKE_POSITION_INDEPENDENT_CODE ON)
+set(QDMI_PREFIX IBM)
+set(QDMI_TARGET_NAME ibm-qdmi-device)
+
+option(BUILD_IBM_QDMI_TESTS "Build offline native tests" ${PROJECT_IS_TOP_LEVEL})
+option(USE_INSTALLED_IBM_QDMI_DEVICE "Build tests against an installed package" OFF)
+option(IBM_QDMI_ENABLE_COVERAGE "Enable native coverage reporting" OFF)
+option(BUILD_IBM_QDMI_DOCS "Configure the native API documentation" OFF)
+
+if(BUILD_IBM_QDMI_DOCS AND USE_INSTALLED_IBM_QDMI_DEVICE)
+  message(FATAL_ERROR "Documentation requires a source build")
+endif()
+
+include(cmake/Sanitizers.cmake)
+ibm_qdmi_apply_sanitizers()
+include(cmake/ExternalDependencies.cmake)
+
+if(USE_INSTALLED_IBM_QDMI_DEVICE)
+  find_package(ibm-qdmi-device ${PROJECT_VERSION} REQUIRED CONFIG)
+else()
+  get_target_property(IBM_QDMI_QDMI_VERSION qdmi::qdmi VERSION)
+  if(NOT IBM_QDMI_QDMI_VERSION)
+    set(IBM_QDMI_QDMI_VERSION "${qdmi_VERSION}")
+  endif()
+  if(NOT IBM_QDMI_QDMI_VERSION)
+    message(FATAL_ERROR "Cannot determine the QDMI library version")
+  endif()
+  add_subdirectory(src)
+endif()
+
+if(BUILD_IBM_QDMI_TESTS)
+  enable_testing()
+  include(GoogleTest)
+  add_subdirectory(test)
+endif()

ibm_qdmi-0.1.0/LICENSE

@@ -0,0 +1,217 @@
+Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+    TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+    1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+    2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+    3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+    4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+    5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+    6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+    7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+    8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+    9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+    END OF TERMS AND CONDITIONS
+
+    APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+    Copyright [yyyy] [name of copyright owner]
+
+    Licensed under the Apache License, Version 2.0 (the "License");
+    you may not use this file except in compliance with the License.
+    You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+    Unless required by applicable law or agreed to in writing, software
+    distributed under the License is distributed on an "AS IS" BASIS,
+    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+    See the License for the specific language governing permissions and
+    limitations under the License.
+
+---- LLVM Exceptions to the Apache 2.0 License ----
+
+As an exception, if, as a result of your compiling your source code, portions
+of this Software are embedded into an Object form of such source code, you
+may redistribute such embedded portions in such Object form without complying
+with the conditions of Sections 4(a), 4(b) and 4(d) of the License.
+
+In addition, if you combine or link compiled forms of this Software with
+software that is licensed under the GPLv2 ("Combined Software") and if a
+court of competent jurisdiction determines that the patent provision (Section
+3), the indemnity provision (Section 9) or other Section of the License
+conflicts with the conditions of the GPLv2, you may retroactively and
+prospectively choose to deem waived or otherwise exclude such Section(s) of
+the License, but only in their entirety and only with respect to the Combined
+Software.

ibm_qdmi-0.1.0/PKG-INFO

@@ -0,0 +1,116 @@
+Metadata-Version: 2.4
+Name: ibm-qdmi
+Version: 0.1.0
+Summary: IBM quantum execution through QDMI, Qiskit, and PennyLane
+Author-Email: Marcel Walter <marcel@mq.sc>, Lukas Burgholzer <lukas@mq.sc>
+License-Expression: Apache-2.0 WITH LLVM-exception
+License-File: LICENSE
+Classifier: Development Status :: 3 - Alpha
+Classifier: Intended Audience :: Information Technology
+Classifier: Intended Audience :: Science/Research
+Classifier: Natural Language :: English
+Classifier: Operating System :: MacOS
+Classifier: Operating System :: Microsoft :: Windows
+Classifier: Operating System :: POSIX :: Linux
+Classifier: Programming Language :: C++
+Classifier: Programming Language :: Python
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3 :: Only
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: 3.14
+Classifier: Topic :: Scientific/Engineering :: Quantum Computing
+Classifier: Typing :: Typed
+Project-URL: Documentation, https://ibm-qdmi-device.readthedocs.io/en/latest/
+Project-URL: Homepage, https://github.com/munich-quantum-software/ibm-qdmi-device
+Project-URL: Issues, https://github.com/munich-quantum-software/ibm-qdmi-device/issues
+Requires-Python: >=3.11
+Provides-Extra: executor
+Requires-Dist: mqt-core[qiskit]~=4.0.0; extra == "executor"
+Requires-Dist: qiskit-ibm-runtime~=0.50.0; extra == "executor"
+Provides-Extra: pennylane
+Requires-Dist: mqt-core[pennylane,qiskit]~=4.0.0; extra == "pennylane"
+Provides-Extra: qiskit
+Requires-Dist: mqt-core[qiskit]~=4.0.0; extra == "qiskit"
+Requires-Dist: qiskit-algorithms>=0.4; extra == "qiskit"
+Description-Content-Type: text/markdown
+
+<!-- rumdl-disable MD033 MD041 -->
+<p align="center">
+  <a href="https://mq.sc/">
+    <picture>
+      <source media="(prefers-color-scheme: dark)" srcset="docs/_static/logo-mqsc-dark.svg">
+      <img src="docs/_static/logo-mqsc-light.svg" alt="MQSC Logo" width="40%">
+    </picture>
+  </a>
+</p>
+
+# IBM QDMI Device
+
+[![License](https://img.shields.io/badge/License-Apache--2.0_w%2F_LLVM--exception-blue?logo=apache&style=flat-square)](LICENSE)
+[![C++20](https://img.shields.io/badge/C%2B%2B-20-blue?logo=cplusplus&style=flat-square)](https://isocpp.org/)
+[![CMake](https://img.shields.io/badge/CMake-3.24%2B-blue?logo=cmake&style=flat-square)](https://cmake.org/)
+[![CI](https://img.shields.io/github/actions/workflow/status/munich-quantum-software/ibm-qdmi-device/ci.yml?branch=main&style=flat-square&logo=github&label=CI)](https://github.com/munich-quantum-software/ibm-qdmi-device/actions/workflows/ci.yml)
+[![codecov](https://img.shields.io/codecov/c/github/munich-quantum-software/ibm-qdmi-device?style=flat-square&logo=codecov)](https://codecov.io/gh/munich-quantum-software/ibm-qdmi-device)
+
+**IBM QDMI Device** connects IBM Quantum Platform to the
+[Quantum Device Management Interface (QDMI)](https://github.com/Munich-Quantum-Software-Stack/QDMI),
+a vendor-neutral C API for quantum hardware. The C++20 library handles API-key
+authentication, calibration queries, and the job lifecycle. It submits OpenQASM
+3 circuits and returns ordered shots and histograms. Optional Qiskit and
+PennyLane integrations use the same native interface.
+
+Live metadata validation has passed; quantum execution has not yet been
+validated on hardware. Examples default to local simulation.
+
+<p align="center">
+  <a href="https://ibm-qdmi-device.readthedocs.io/en/latest/">
+    <img width="30%" src="https://img.shields.io/badge/documentation-blue?style=for-the-badge&logo=read%20the%20docs" alt="Documentation">
+  </a>
+</p>
+<!-- rumdl-enable MD033 MD041 -->
+
+## Installation
+
+Install from a source checkout with Python 3.11 or newer, a C++20 compiler,
+CMake 3.24 or newer, and Git. Linux builds also require OpenSSL development
+headers.
+
+```console
+uv venv
+uv pip install .          # core library and Python entry points
+uv pip install '.[qiskit]'  # adds the Qiskit backend (IBMBackend)
+```
+
+For C++ projects, follow the
+[native installation guide](https://ibm-qdmi-device.readthedocs.io/en/latest/installation.html#native-package)
+for CMake build and installation commands.
+
+Use [.env.example](.env.example) as a reference for connection and optional
+client settings. Supply credentials through the process environment or a secret
+manager; the device does not load `.env` files.
+
+## Where to Start
+
+| I want to…                                   | Guide                                                                                    |
+| :------------------------------------------- | :--------------------------------------------------------------------------------------- |
+| Run circuits from **Python / Qiskit**        | [Qiskit Integration](https://ibm-qdmi-device.readthedocs.io/en/latest/qiskit.html)       |
+| Execute **PennyLane** QNodes                 | [PennyLane Integration](https://ibm-qdmi-device.readthedocs.io/en/latest/pennylane.html) |
+| Walk through end-to-end workloads            | [Examples](https://ibm-qdmi-device.readthedocs.io/en/latest/examples.html)               |
+| Integrate the **C++ library** directly       | [Usage Guide](https://ibm-qdmi-device.readthedocs.io/en/latest/api.html)                 |
+| Understand the Python package's entry points | [Python Package](https://ibm-qdmi-device.readthedocs.io/en/latest/python_package.html)   |
+| Contribute to the project                    | [Contributing](https://ibm-qdmi-device.readthedocs.io/en/latest/contributing.html)       |
+
+## Contributing
+
+Contributions are welcome, including bug reports, documentation improvements,
+and new features. See the
+[Contributing Guide](https://ibm-qdmi-device.readthedocs.io/en/latest/contributing.html)
+for the development workflow, coding standards, and pull request process.
+
+## License
+
+The core C++ library and Python package are licensed under the
+**Apache License 2.0 with LLVM exception**. See [LICENSE](LICENSE) for the
+license text.

ibm_qdmi-0.1.0/README.md

@@ -0,0 +1,78 @@
+<!-- rumdl-disable MD033 MD041 -->
+<p align="center">
+  <a href="https://mq.sc/">
+    <picture>
+      <source media="(prefers-color-scheme: dark)" srcset="docs/_static/logo-mqsc-dark.svg">
+      <img src="docs/_static/logo-mqsc-light.svg" alt="MQSC Logo" width="40%">
+    </picture>
+  </a>
+</p>
+
+# IBM QDMI Device
+
+[![License](https://img.shields.io/badge/License-Apache--2.0_w%2F_LLVM--exception-blue?logo=apache&style=flat-square)](LICENSE)
+[![C++20](https://img.shields.io/badge/C%2B%2B-20-blue?logo=cplusplus&style=flat-square)](https://isocpp.org/)
+[![CMake](https://img.shields.io/badge/CMake-3.24%2B-blue?logo=cmake&style=flat-square)](https://cmake.org/)
+[![CI](https://img.shields.io/github/actions/workflow/status/munich-quantum-software/ibm-qdmi-device/ci.yml?branch=main&style=flat-square&logo=github&label=CI)](https://github.com/munich-quantum-software/ibm-qdmi-device/actions/workflows/ci.yml)
+[![codecov](https://img.shields.io/codecov/c/github/munich-quantum-software/ibm-qdmi-device?style=flat-square&logo=codecov)](https://codecov.io/gh/munich-quantum-software/ibm-qdmi-device)
+
+**IBM QDMI Device** connects IBM Quantum Platform to the
+[Quantum Device Management Interface (QDMI)](https://github.com/Munich-Quantum-Software-Stack/QDMI),
+a vendor-neutral C API for quantum hardware. The C++20 library handles API-key
+authentication, calibration queries, and the job lifecycle. It submits OpenQASM
+3 circuits and returns ordered shots and histograms. Optional Qiskit and
+PennyLane integrations use the same native interface.
+
+Live metadata validation has passed; quantum execution has not yet been
+validated on hardware. Examples default to local simulation.
+
+<p align="center">
+  <a href="https://ibm-qdmi-device.readthedocs.io/en/latest/">
+    <img width="30%" src="https://img.shields.io/badge/documentation-blue?style=for-the-badge&logo=read%20the%20docs" alt="Documentation">
+  </a>
+</p>
+<!-- rumdl-enable MD033 MD041 -->
+
+## Installation
+
+Install from a source checkout with Python 3.11 or newer, a C++20 compiler,
+CMake 3.24 or newer, and Git. Linux builds also require OpenSSL development
+headers.
+
+```console
+uv venv
+uv pip install .          # core library and Python entry points
+uv pip install '.[qiskit]'  # adds the Qiskit backend (IBMBackend)
+```
+
+For C++ projects, follow the
+[native installation guide](https://ibm-qdmi-device.readthedocs.io/en/latest/installation.html#native-package)
+for CMake build and installation commands.
+
+Use [.env.example](.env.example) as a reference for connection and optional
+client settings. Supply credentials through the process environment or a secret
+manager; the device does not load `.env` files.
+
+## Where to Start
+
+| I want to…                                   | Guide                                                                                    |
+| :------------------------------------------- | :--------------------------------------------------------------------------------------- |
+| Run circuits from **Python / Qiskit**        | [Qiskit Integration](https://ibm-qdmi-device.readthedocs.io/en/latest/qiskit.html)       |
+| Execute **PennyLane** QNodes                 | [PennyLane Integration](https://ibm-qdmi-device.readthedocs.io/en/latest/pennylane.html) |
+| Walk through end-to-end workloads            | [Examples](https://ibm-qdmi-device.readthedocs.io/en/latest/examples.html)               |
+| Integrate the **C++ library** directly       | [Usage Guide](https://ibm-qdmi-device.readthedocs.io/en/latest/api.html)                 |
+| Understand the Python package's entry points | [Python Package](https://ibm-qdmi-device.readthedocs.io/en/latest/python_package.html)   |
+| Contribute to the project                    | [Contributing](https://ibm-qdmi-device.readthedocs.io/en/latest/contributing.html)       |
+
+## Contributing
+
+Contributions are welcome, including bug reports, documentation improvements,
+and new features. See the
+[Contributing Guide](https://ibm-qdmi-device.readthedocs.io/en/latest/contributing.html)
+for the development workflow, coding standards, and pull request process.
+
+## License
+
+The core C++ library and Python package are licensed under the
+**Apache License 2.0 with LLVM exception**. See [LICENSE](LICENSE) for the
+license text.