Metadata-Version: 2.4
Name: mqt-debugger
Version: 1.1.0
Summary: A quantum circuit debugging tool
Keywords: MQT,quantum-computing,design-automation,verification,debugging,dap
Author-Email: Damian Rovara <damian.rovara@tum.de>, Lukas Burgholzer <burgholzer@me.com>
License-Expression: MIT
License-File: LICENSE.md
Classifier: Development Status :: 5 - Production/Stable
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 :: Only
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Classifier: Topic :: Scientific/Engineering :: Electronic Design Automation (EDA)
Classifier: Typing :: Typed
Project-URL: Homepage, https://github.com/munich-quantum-toolkit/debugger
Project-URL: Documentation, https://mqt.readthedocs.io/projects/debugger
Project-URL: Issues, https://github.com/munich-quantum-toolkit/debugger/issues
Project-URL: Discussions, https://github.com/munich-quantum-toolkit/debugger/discussions
Requires-Python: >=3.9
Provides-Extra: check
Requires-Dist: qiskit>=1.2.4; extra == "check"
Requires-Dist: scipy>=1.15; python_version >= "3.13" and extra == "check"
Requires-Dist: scipy>=1.13.1; python_version < "3.13" and extra == "check"
Requires-Dist: numpy>=2.1; python_version >= "3.13" and extra == "check"
Description-Content-Type: text/markdown

[![PyPI](https://img.shields.io/pypi/v/mqt.debugger?logo=pypi&style=flat-square)](https://pypi.org/project/mqt.debugger/)
![OS](https://img.shields.io/badge/os-linux%20%7C%20macos%20%7C%20windows-blue?style=flat-square)
[![License: MIT](https://img.shields.io/badge/license-MIT-blue.svg?style=flat-square)](https://opensource.org/licenses/MIT)
[![CI](https://img.shields.io/github/actions/workflow/status/munich-quantum-toolkit/debugger/ci.yml?branch=main&style=flat-square&logo=github&label=ci)](https://github.com/munich-quantum-toolkit/debugger/actions/workflows/ci.yml)
[![CD](https://img.shields.io/github/actions/workflow/status/munich-quantum-toolkit/debugger/cd.yml?style=flat-square&logo=github&label=cd)](https://github.com/munich-quantum-toolkit/debugger/actions/workflows/cd.yml)
[![Documentation](https://img.shields.io/readthedocs/mqt-debugger?logo=readthedocs&style=flat-square)](https://mqt.readthedocs.io/projects/debugger)
[![codecov](https://img.shields.io/codecov/c/github/munich-quantum-toolkit/debugger?style=flat-square&logo=codecov)](https://codecov.io/gh/munich-quantum-toolkit/debugger)

<p align="center">
  <a href="https://mqt.readthedocs.io">
   <picture>
     <source media="(prefers-color-scheme: dark)" srcset="https://raw.githubusercontent.com/munich-quantum-toolkit/.github/refs/heads/main/docs/_static/mqt-banner-dark.svg" width="90%">
     <img src="https://raw.githubusercontent.com/munich-quantum-toolkit/.github/refs/heads/main/docs/_static/mqt-banner-light.svg" width="90%" alt="MQT Banner">
   </picture>
  </a>
</p>

# MQT Debugger - A Quantum Circuit Debugging Tool

A tool for debugging quantum circuits developed as part of the [_Munich Quantum Toolkit (MQT)_](https://mqt.readthedocs.io) by the [Chair for Design Automation](https://www.cda.cit.tum.de/) at the [Technical University of Munich](https://www.tum.de/).
It proposes an interface for the simulation of circuits and diagnosis of errors and provides a base implementation built upon [MQT Core](https://github.com/munich-quantum-toolkit/core), which forms the backbone of the MQT.
It also provides a Debugger Adapter Protocol (DAP) server that can be used to integrate the debugger into IDEs.

<p align="center">
  <a href="https://mqt.readthedocs.io/projects/debugger">
  <img width=30% src="https://img.shields.io/badge/documentation-blue?style=for-the-badge&logo=read%20the%20docs" alt="Documentation" />
  </a>
</p>

If you have any questions, feel free to contact us via [quantum.cda@xcit.tum.de](mailto:quantum.cda@xcit.tum.de) or by creating an issue on [GitHub](https://github.com/munich-quantum-toolkit/debugger/issues).

## Getting Started

MQT Debugger is available via [PyPI](https://pypi.org/project/mqt.debugger/) for Linux, macOS, and Windows and supports Python 3.9 to 3.13.

```console
(venv) $ pip install mqt.debugger
```

The following code gives an example on the usage:

```python3
from mqt import debugger

state = debugger.create_ddsim_simulation_state()
with open("code.qasm", "r") as f:
    state.load_code(f.read())
f.run_simulation()
print(f.get_state_vector_full())
```

**Detailed documentation on all available methods, options, and input formats is available at [ReadTheDocs](https://mqt.readthedocs.io/projects/debugger).**

## System Requirements and Building

The implementation is compatible with any C++20 compiler, a minimum CMake version of 3.19, and Python 3.9+.
Please refer to the [documentation](https://mqt.readthedocs.io/projects/debugger) on how to build the project.

Building (and running) is continuously tested under Linux, macOS, and Windows using the [latest available system versions for GitHub Actions](https://github.com/actions/virtual-environments).

## References

MQT Debugger has been developed based on methods proposed in the following papers:

[![a](https://img.shields.io/static/v1?label=arXiv&message=2412.12269&color=inactive&style=flat-square)](https://arxiv.org/abs/2412.12269)
D. Rovara, L. Burgholzer, and R. Wille, "[A Framework for Debugging Quantum Programs](https://arxiv.org/abs/2412.12269)," arXiv, 2024

[![a](https://img.shields.io/static/v1?label=arXiv&message=2412.14252&color=inactive&style=flat-square)](https://arxiv.org/abs/2412.14252)
D. Rovara, L. Burgholzer, and R. Wille, "[Automatically Refining Assertions for Efficient Debugging of Quantum Programs](https://arxiv.org/abs/2412.14252)," arXiv, 2024

## Acknowledgements

The Munich Quantum Toolkit has been supported by the European
Research Council (ERC) under the European Union's Horizon 2020 research and innovation program (grant agreement
No. 101001318), the Bavarian State Ministry for Science and Arts through the Distinguished Professorship Program, as well as the
Munich Quantum Valley, which is supported by the Bavarian state government with funds from the Hightech Agenda Bayern Plus.

<p align="center">
  <picture>
    <source media="(prefers-color-scheme: dark)" srcset="https://raw.githubusercontent.com/munich-quantum-toolkit/.github/refs/heads/main/docs/_static/mqt-funding-footer-dark.svg" width="90%">
    <img src="https://raw.githubusercontent.com/munich-quantum-toolkit/.github/refs/heads/main/docs/_static/mqt-funding-footer-light.svg" width="90%" alt="MQT Funding Footer">
  </picture>
</p>
