MQT Debugger - A Quantum Circuit Debugging Tool
MQT Debugger is a tool for debugging quantum circuits. It is part of the
Munich Quantum Toolkit (MQT).
Key Features
- Proposes an interface for the simulation of circuits and diagnosis of errors
- Implementation built upon
MQT Core, the backbone of
the MQT
- Provides a Debugger Adapter Protocol (DAP) server that can be used to
integrate the debugger into IDEs
If you have any questions, feel free to create a
discussion or
an issue on
GitHub.
Contributors and Supporters
The Munich Quantum Toolkit (MQT) is developed by
the Chair for Design Automation at the
Technical University of Munich and supported by
MQSC. Among others, it is part of the
Munich Quantum Software Stack (MQSS)
ecosystem, which is being developed as part of the
Munich Quantum Valley (MQV) initiative.
Thank you to all the contributors who have helped make MQT Debugger a reality!
The MQT will remain free, open-source, and permissively licensed—now and in the
future. We are firmly committed to keeping it open and actively maintained for
the quantum computing community.
To support this endeavor, please consider:
Getting Started
mqt.debugger is available via PyPI.
uv pip install mqt.debugger
The following code gives an example on the usage:
from mqt import debugger
state = debugger.create_ddsim_simulation_state()
with open("code.qasm", "r") as f:
state.load_code(f.read())
state.run_simulation()
print(state.get_state_vector_full())
Detailed documentation and examples are available at
ReadTheDocs.
System Requirements
Building the project requires a C++ compiler with support for C++20 and CMake
3.28 or newer. For details on how to build the project, please refer to the
documentation. Building (and
running) is continuously tested under Linux, macOS, and Windows using the
latest available system versions for GitHub Actions.
MQT Debugger is compatible with all
officially supported Python versions.
Cite This
Please cite the work that best fits your use case.
MQT Debugger (the tool)
When citing the software itself or results produced with it, cite the MQT
Debugger paper:
@misc{rovara2024debugging,
title = {A Framework for Debugging Quantum Programs},
author = {Rovara, Damian and Burgholzer, Lukas and Wille, Robert},
year = {2024},
eprint = {2412.12269},
eprinttype = {arxiv}
}
The Munich Quantum Toolkit (the project)
When discussing the overall MQT project or its ecosystem, cite the MQT Handbook:
@inproceedings{mqt,
title = {The {{MQT}} Handbook: {{A}} Summary of Design Automation Tools and Software for Quantum Computing},
shorttitle = {{The MQT Handbook}},
author = {Wille, Robert and Berent, Lucas and Forster, Tobias and Kunasaikaran, Jagatheesan and Mato, Kevin and Peham, Tom and Quetschlich, Nils and Rovara, Damian and Sander, Aaron and Schmid, Ludwig and Schoenberger, Daniel and Stade, Yannick and Burgholzer, Lukas},
year = 2024,
booktitle = {IEEE International Conference on Quantum Software (QSW)},
doi = {10.1109/QSW62656.2024.00013},
eprint = {2405.17543},
eprinttype = {arxiv},
addendum = {A live version of this document is available at \url{https://mqt.readthedocs.io}}
}
Peer-Reviewed Research
When citing the underlying methods and research, please reference the most
relevant peer-reviewed publications from the list below:
[1] D. Rovara, L. Burgholzer, and R. Wille.
A Framework for Debugging Quantum Programs.
[2] D. Rovara, L. Burgholzer, and R. Wille.
Automatically Refining Assertions for Efficient Debugging of Quantum Programs.
[3] D. Rovara, L. Burgholzer, and R. Wille.
A Framework for the Efficient Evaluation of Runtime Assertions on Quantum
Computers.
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.