Metadata-Version: 2.4
Name: mqss-qdmi-mqv
Version: 0.1.1
Summary: Implementation of a MQV QDMI device
Author: Munich Quantum Valley
License-Expression: Apache-2.0 WITH LLVM-exception
License-File: LICENSE
Classifier: Development Status :: 4 - Beta
Classifier: Intended Audience :: Information Technology
Classifier: Intended Audience :: Science/Research
Classifier: Natural Language :: English
Classifier: Operating System :: POSIX :: Linux
Classifier: Programming Language :: C++
Classifier: Programming Language :: Python
Classifier: Topic :: Scientific/Engineering :: Quantum Computing
Classifier: Typing :: Typed
Requires-Python: >=3.11
Description-Content-Type: text/markdown

# MQV QDMI Device

<!-- [DOXYGEN MAIN] -->

A QDMI 1.4 device library for the MQSS **MQP-API** at Munich Quantum Valley.
Each MQP-API resource is available as a QDMI device, for example through MQT
Core's built-in QDMI driver.

<!-- [DOXYGEN MAIN] -->

**Status: prototype** for the SC26 openQSE demo.

## Install

```console
pip install mqss-qdmi-mqv
```

The wheel registers its device manifest with MQT Core (≥ 4.1); no further
configuration is needed.

## Use

```python
from mqt.core.qdmi import builtin_driver

device = builtin_driver.open_device("mqv.maqcs", base_url="https://<mqp-api-host>/v1/", token="<MQP-API token>")
```

| Device ID     | Resource                |
| ------------- | ----------------------- |
| `mqv.maqcs`   | MAQCS (fixed by the ID) |
| `mqv.default` | set by the client       |

| Session parameter | Meaning                              | Environment fallback |
| ----------------- | ------------------------------------ | -------------------- |
| `BASEURL`         | MQP-API base URL (site-specific)     | `MQV_QDMI_BASEURL`   |
| `TOKEN`           | MQP-API token                        | `MQV_QDMI_TOKEN`     |
| `CUSTOM1`         | MQP-API resource, e.g. `MAQCS`       | `MQV_QDMI_RESOURCE`  |
| `CUSTOM2`         | job field `no_modify` (default true) | `MQV_QDMI_NO_MODIFY` |

## Build from source

```console
cmake -S . -B build -DCMAKE_BUILD_TYPE=Release
cmake --build build
ctest --test-dir build                  # unit tests
test/mock_mqp/run_e2e.sh build          # end-to-end tests against a mock MQP-API
```

Integration with openQSE (QFw): see `docs/openqse-integration.md` in the
repository.

## License

Apache License 2.0 with LLVM Exceptions; see the `LICENSE` file.
