Metadata-Version: 2.5
Name: mqt-bench
Version: 2.4.0
Summary: MQT Bench - A MQT tool for Benchmarking Quantum Software Tools
Project-URL: Homepage, https://github.com/munich-quantum-toolkit/bench
Project-URL: Bug Tracker, https://github.com/munich-quantum-toolkit/bench/issues
Project-URL: Discussions, https://github.com/munich-quantum-toolkit/bench/discussions
Project-URL: Research, https://www.cda.cit.tum.de/research/quantum/
Author-email: Lukas Burgholzer <burgholzer@me.com>, Simon Hofmann <simon@mq.sc>, Patrick Hopf <patrick@mq.sc>, Daniel Haag <daniel@mq.sc>, Nils Quetschlich <nils.quetschlich@tum.de>
License-Expression: MIT
License-File: LICENSE
Keywords: MQT,benchmarking,performance,quantum computing,testing
Classifier: Development Status :: 5 - Production/Stable
Classifier: Intended Audience :: Developers
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 :: 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: Programming Language :: Python :: 3.15
Classifier: Topic :: Scientific/Engineering :: Electronic Design Automation (EDA)
Classifier: Topic :: Scientific/Engineering :: Quantum Computing
Classifier: Typing :: Typed
Requires-Python: >=3.11
Requires-Dist: mqt-core>=4.2
Requires-Dist: networkx>=2.8.8
Requires-Dist: numpy>=2
Requires-Dist: numpy>=2.1; python_version >= '3.13'
Requires-Dist: numpy>=2.3.2; python_version >= '3.14'
Requires-Dist: numpy>=2.5.2; python_version >= '3.15'
Requires-Dist: qiskit<3,>=2.5.2
Description-Content-Type: text/markdown

[![PyPI](https://img.shields.io/pypi/v/mqt.bench?logo=pypi&style=flat-square)](https://pypi.org/project/mqt.bench/)
![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/bench/ci.yml?branch=main&style=flat-square&logo=github&label=ci)](https://github.com/munich-quantum-toolkit/bench/actions/workflows/ci.yml)
[![CD](https://img.shields.io/github/actions/workflow/status/munich-quantum-toolkit/bench/cd.yml?style=flat-square&logo=github&label=cd)](https://github.com/munich-quantum-toolkit/bench/actions/workflows/cd.yml)
[![Documentation](https://img.shields.io/readthedocs/mqt-bench?logo=readthedocs&style=flat-square)](https://mqt.readthedocs.io/projects/bench)
[![codecov](https://img.shields.io/codecov/c/github/munich-quantum-toolkit/bench?style=flat-square&logo=codecov)](https://codecov.io/gh/munich-quantum-toolkit/bench)

<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/logo-mqt-dark.svg" width="60%">
      <img src="https://raw.githubusercontent.com/munich-quantum-toolkit/.github/refs/heads/main/docs/_static/logo-mqt-light.svg" width="60%" alt="MQT Logo">
    </picture>
  </a>
</p>

# MQT Bench - Benchmarking Software and Design Automation Tools for Quantum Computing

MQT Bench generates quantum circuits for benchmarking quantum software tools.
Choose an algorithm, a circuit size, and an abstraction level. Generate circuits
at <https://mqt-bench.app/>, with Python, or from the command line. MQT Bench is
part of the
[_Munich Quantum Toolkit (MQT)_](https://mqt.readthedocs.io).

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

## Key Features

- Generate algorithms such as GHZ, QAOA, QFT, Grover, and Shor at the
  algorithmic, target-independent, native-gate, or mapped level.
  [Benchmark catalogue](https://mqt.readthedocs.io/projects/bench/en/stable/benchmark_selection.html)
  ·
  [Abstraction levels](https://mqt.readthedocs.io/projects/bench/en/stable/abstraction_levels.html)
- Compile to a native gate set or map the circuit to a device model with
  restricted connectivity.
  [Supported targets](https://mqt.readthedocs.io/projects/bench/en/stable/parameter.html)
- Keep parameters symbolic, bind them to random angles, or generate a mirror
  circuit with a known ideal measurement result.
  [Quickstart](https://mqt.readthedocs.io/projects/bench/en/stable/quickstart.html)
- Export circuits as OpenQASM 2, OpenQASM 3, or QPY.
  [Output formats](https://mqt.readthedocs.io/projects/bench/en/stable/quickstart.html#output-formats)
  ·
  [Usage guide](https://mqt.readthedocs.io/projects/bench/en/stable/usage.html)
- MQT Bench circuits are also available as a
  [PennyLane dataset](https://pennylane.ai/datasets/single-dataset/mqt-bench).

If you have any questions, feel free to create a
[discussion](https://github.com/munich-quantum-toolkit/bench/discussions) or an
[issue](https://github.com/munich-quantum-toolkit/bench/issues) on
[GitHub](https://github.com/munich-quantum-toolkit/bench).

## Contributors and Supporters

MQT Bench is developed by the
[Chair for Design Automation](https://www.cda.cit.tum.de/) at the
[Technical University of Munich](https://www.tum.de/) and [MQSC](https://mq.sc).
Among others, it is part of the
[Munich Quantum Software Stack (MQSS)](https://www.munich-quantum-valley.de/research/research-areas/mqss)
ecosystem, which is being developed as part of the
[Munich Quantum Valley (MQV)](https://www.munich-quantum-valley.de) initiative.

<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-logo-banner-dark.svg" width="90%">
    <img src="https://raw.githubusercontent.com/munich-quantum-toolkit/.github/refs/heads/main/docs/_static/mqt-logo-banner-light.svg" width="90%" alt="MQT Partner Logos">
  </picture>
</p>

Thank you to all the contributors who have helped make MQT Bench a reality!

<p align="center">
  <a href="https://github.com/munich-quantum-toolkit/bench/graphs/contributors">
  <img src="https://contrib.rocks/image?repo=munich-quantum-toolkit/bench" alt="Contributors to munich-quantum-toolkit/bench" />
  </a>
</p>

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:

- Starring and sharing our repositories:
  <https://github.com/munich-quantum-toolkit>
- Contributing code, documentation, tests, or examples via issues and pull
  requests
- Citing the MQT in your publications (see [Cite This](#cite-this))
- Citing our research in your publications (see
  [References](https://mqt.readthedocs.io/projects/bench/en/stable/references.html))
- Using the MQT in research and teaching, and sharing feedback and use cases
- Sponsoring us on GitHub: <https://github.com/sponsors/munich-quantum-toolkit>

<p align="center">
  <a href="https://github.com/sponsors/munich-quantum-toolkit">
  <img width=20% src="https://img.shields.io/badge/Sponsor-white?style=for-the-badge&logo=githubsponsors&labelColor=black&color=blue" alt="Sponsor the MQT" />
  </a>
</p>

## Getting Started

`mqt.bench` is available via [PyPI](https://pypi.org/project/mqt.bench/).

```console
uv pip install mqt.bench
```

Generate a five-qubit GHZ circuit at the algorithmic level:

```python3
from mqt.bench import BenchmarkLevel, get_benchmark

# Get a benchmark circuit on algorithmic level representing the GHZ state with 5 qubits
qc_algorithmic_level = get_benchmark(benchmark="ghz", level=BenchmarkLevel.ALG, circuit_size=5)

# Draw the circuit
print(qc_algorithmic_level.draw())
```

**Detailed documentation and examples are available at
[ReadTheDocs](https://mqt.readthedocs.io/projects/bench).**

## System Requirements

MQT Bench can be installed on all major operating systems with all
[officially supported Python versions](https://devguide.python.org/versions/).
It is continuously tested under Linux, macOS, and Windows using the
[latest available system versions for GitHub Actions](https://github.com/actions/runner-images).

## Cite This

Please cite the work that best fits your use case.

### MQT Bench (the tool)

When citing the software itself or results produced with it, cite the 2023 MQT
Bench paper:

```bibtex
@article{quetschlich2023mqtbench,
  title        = {{{MQT Bench}}: {Benchmarking Software and Design Automation Tools for Quantum Computing}},
  shorttitle   = {{MQT Bench}},
  author       = {Quetschlich, Nils and Burgholzer, Lukas and Wille, Robert},
  year         = {2023},
  journal      = {{Quantum}},
  volume       = {7},
  pages        = {1062},
  doi          = {10.22331/q-2023-07-20-1062},
  note         = {{{MQT Bench}} is available at \url{https://mqt-bench.app/}},
  eprint       = {2204.13719},
  eprinttype   = {arxiv}
}
```

If you use the [web interface](https://mqt-bench.app/) to generate and download
circuits, please also cite our
[2026 QCE paper](https://mqt.readthedocs.io/projects/bench/en/latest/references.html#programmable-benchmark-generation)
on use cases for software evaluation, hardware design, and AI training.

### The Munich Quantum Toolkit (the project)

When discussing the overall MQT project or its ecosystem, cite the MQT Handbook:

```bibtex
@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}}
}
```

---

## 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>
