| Name | mqt.bench JSON |
| Version |
1.1.1
JSON |
| download |
| home_page | None |
| Summary | MQT Bench - A MQT tool for Benchmarking Quantum Software Tools |
| upload_time | 2024-04-11 12:14:02 |
| maintainer | None |
| docs_url | None |
| author | None |
| requires_python | >=3.10 |
| license | MIT License Copyright (c) 2022 Nils Quetschlich, Lukas Burgholzer, and Robert Wille Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. |
| keywords |
mqt
quantum computing
benchmarking
performance
testing
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
[](https://pypi.org/project/mqt.bench/)
[](https://opensource.org/licenses/MIT)
[](https://github.com/cda-tum/MQTBench/actions/workflows/coverage.yml)
[](https://github.com/cda-tum/MQTBench/actions/workflows/deploy.yml)
[](https://codecov.io/gh/cda-tum/mqt-bench)
[](https://mqt.readthedocs.io/projects/bench)
<p align="center">
<picture>
<source media="(prefers-color-scheme: dark)" srcset="https://raw.githubusercontent.com/cda-tum/mqtbench/main/docs/_static/mqt_light.png" width="60%">
<img src="https://raw.githubusercontent.com/cda-tum/mqtbench/main/docs/_static/mqt_dark.png" width="60%">
</picture>
</p>
# MQT Bench: Benchmarking Software and Design Automation Tools for Quantum Computing
MQT Bench is a quantum circuit benchmark suite with cross-level support, i.e., providing the same benchmark algorithms for different abstraction levels throughout the quantum computing
software stack.
<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>
If you have any questions, feel free to create a [discussion](https://github.com/cda-tum/mqt-bench/discussions) or an [issue](https://github.com/cda-tum/mqt-bench/issues) on [GitHub](https://github.com/cda-tum/mqt-bench).
MQT Bench is part of the Munich Quantum Toolkit (MQT) developed by the [Chair for Design Automation](https://www.cda.cit.tum.de/) at the [Technical University of Munich](https://www.tum.de/) and is hosted at [https://www.cda.cit.tum.de/mqtbench/](https://www.cda.cit.tum.de/mqtbench/).
[<img src="https://raw.githubusercontent.com/cda-tum/mqtbench/main/docs/_static/mqtbench.png" align="center" width="500" >](https://www.cda.cit.tum.de/mqtbench)
## Getting Started
`mqt-bench` is available via [PyPI](https://pypi.org/project/mqt.bench/).
```console
(venv) $ pip install mqt.bench
```
The following code gives an example on the usage:
```python3
from mqt.bench import get_benchmark
# get a benchmark circuit on algorithmic level representing the GHZ state with 5 qubits
qc_algorithmic_level = get_benchmark(benchmark_name="dj", level="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).**
# Repository Structure
- src/mqt/: main source directory
- bench: Directory for the MQT Bench package
- bench/benchmarks: Directory for the benchmarks
- benchviewer: Directory for the webpage (which can be started locally and is also hosted at
[https://www.cda.cit.tum.de/mqtbench/](https://www.cda.cit.tum.de/mqtbench/))
- tests: Directory for the tests for MQT Bench
## 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/cda-tum/mqt-bench/main/docs/_static/tum_dark.svg" width="28%">
<img src="https://raw.githubusercontent.com/cda-tum/mqt-bench/main/docs/_static/tum_light.svg" width="28%">
</picture>
<picture>
<img src="https://raw.githubusercontent.com/cda-tum/mqt-bench/main/docs/_static/logo-bavaria.svg" width="16%">
</picture>
<picture>
<source media="(prefers-color-scheme: dark)" srcset="https://raw.githubusercontent.com/cda-tum/mqt-bench/main/docs/_static/erc_dark.svg" width="24%">
<img src="https://raw.githubusercontent.com/cda-tum/mqt-bench/main/docs/_static/erc_light.svg" width="24%">
</picture>
<picture>
<img src="https://raw.githubusercontent.com/cda-tum/mqt-bench/main/docs/_static/logo-mqv.svg" width="28%">
</picture>
</p>
Raw data
{
"_id": null,
"home_page": null,
"name": "mqt.bench",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.10",
"maintainer_email": null,
"keywords": "MQT, quantum computing, benchmarking, performance, testing",
"author": null,
"author_email": "Nils Quetschlich <nils.quetschlich@tum.de>, Lukas Burgholzer <lukas.burgholzer@tum.de>",
"download_url": "https://files.pythonhosted.org/packages/e7/2e/7511bf4b359c1467dc4c8cd7dc88abb6c1d60ffdd7664303c8c4b4183ca5/mqt.bench-1.1.1.tar.gz",
"platform": null,
"description": "[](https://pypi.org/project/mqt.bench/)\n[](https://opensource.org/licenses/MIT)\n[](https://github.com/cda-tum/MQTBench/actions/workflows/coverage.yml)\n[](https://github.com/cda-tum/MQTBench/actions/workflows/deploy.yml)\n[](https://codecov.io/gh/cda-tum/mqt-bench)\n[](https://mqt.readthedocs.io/projects/bench)\n\n<p align=\"center\">\n<picture>\n <source media=\"(prefers-color-scheme: dark)\" srcset=\"https://raw.githubusercontent.com/cda-tum/mqtbench/main/docs/_static/mqt_light.png\" width=\"60%\">\n <img src=\"https://raw.githubusercontent.com/cda-tum/mqtbench/main/docs/_static/mqt_dark.png\" width=\"60%\">\n</picture>\n</p>\n\n# MQT Bench: Benchmarking Software and Design Automation Tools for Quantum Computing\n\nMQT Bench is a quantum circuit benchmark suite with cross-level support, i.e., providing the same benchmark algorithms for different abstraction levels throughout the quantum computing\nsoftware stack.\n\n<p align=\"center\">\n <a href=\"https://mqt.readthedocs.io/projects/bench\">\n <img width=30% src=\"https://img.shields.io/badge/documentation-blue?style=for-the-badge&logo=read%20the%20docs\" alt=\"Documentation\" />\n </a>\n</p>\n\nIf you have any questions, feel free to create a [discussion](https://github.com/cda-tum/mqt-bench/discussions) or an [issue](https://github.com/cda-tum/mqt-bench/issues) on [GitHub](https://github.com/cda-tum/mqt-bench).\n\nMQT Bench is part of the Munich Quantum Toolkit (MQT) developed by the [Chair for Design Automation](https://www.cda.cit.tum.de/) at the [Technical University of Munich](https://www.tum.de/) and is hosted at [https://www.cda.cit.tum.de/mqtbench/](https://www.cda.cit.tum.de/mqtbench/).\n\n[<img src=\"https://raw.githubusercontent.com/cda-tum/mqtbench/main/docs/_static/mqtbench.png\" align=\"center\" width=\"500\" >](https://www.cda.cit.tum.de/mqtbench)\n\n## Getting Started\n\n`mqt-bench` is available via [PyPI](https://pypi.org/project/mqt.bench/).\n\n```console\n(venv) $ pip install mqt.bench\n```\n\nThe following code gives an example on the usage:\n\n```python3\nfrom mqt.bench import get_benchmark\n\n# get a benchmark circuit on algorithmic level representing the GHZ state with 5 qubits\nqc_algorithmic_level = get_benchmark(benchmark_name=\"dj\", level=\"alg\", circuit_size=5)\n\n# draw the circuit\nprint(qc_algorithmic_level.draw())\n```\n\n**Detailed documentation and examples are available at [ReadTheDocs](https://mqt.readthedocs.io/projects/bench).**\n\n# Repository Structure\n\n- src/mqt/: main source directory\n - bench: Directory for the MQT Bench package\n - bench/benchmarks: Directory for the benchmarks\n - benchviewer: Directory for the webpage (which can be started locally and is also hosted at\n [https://www.cda.cit.tum.de/mqtbench/](https://www.cda.cit.tum.de/mqtbench/))\n- tests: Directory for the tests for MQT Bench\n\n## Acknowledgements\n\nThe Munich Quantum Toolkit has been supported by the European\nResearch Council (ERC) under the European Union's Horizon 2020 research and innovation program (grant agreement\nNo. 101001318), the Bavarian State Ministry for Science and Arts through the Distinguished Professorship Program, as well as the\nMunich Quantum Valley, which is supported by the Bavarian state government with funds from the Hightech Agenda Bayern Plus.\n\n<p align=\"center\">\n<picture>\n<source media=\"(prefers-color-scheme: dark)\" srcset=\"https://raw.githubusercontent.com/cda-tum/mqt-bench/main/docs/_static/tum_dark.svg\" width=\"28%\">\n<img src=\"https://raw.githubusercontent.com/cda-tum/mqt-bench/main/docs/_static/tum_light.svg\" width=\"28%\">\n</picture>\n<picture>\n<img src=\"https://raw.githubusercontent.com/cda-tum/mqt-bench/main/docs/_static/logo-bavaria.svg\" width=\"16%\">\n</picture>\n<picture>\n<source media=\"(prefers-color-scheme: dark)\" srcset=\"https://raw.githubusercontent.com/cda-tum/mqt-bench/main/docs/_static/erc_dark.svg\" width=\"24%\">\n<img src=\"https://raw.githubusercontent.com/cda-tum/mqt-bench/main/docs/_static/erc_light.svg\" width=\"24%\">\n</picture>\n<picture>\n<img src=\"https://raw.githubusercontent.com/cda-tum/mqt-bench/main/docs/_static/logo-mqv.svg\" width=\"28%\">\n</picture>\n</p>\n",
"bugtrack_url": null,
"license": "MIT License Copyright (c) 2022 Nils Quetschlich, Lukas Burgholzer, and Robert Wille Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the \"Software\"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. ",
"summary": "MQT Bench - A MQT tool for Benchmarking Quantum Software Tools",
"version": "1.1.1",
"project_urls": {
"Bug Tracker": "https://github.com/cda-tum/mqtbench/issues",
"Discussions": "https://github.com/cda-tum/mqtbench/discussions",
"Homepage": "https://github.com/cda-tum/mqtbench",
"Research": "https://www.cda.cit.tum.de/research/quantum/"
},
"split_keywords": [
"mqt",
" quantum computing",
" benchmarking",
" performance",
" testing"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "a85026133098fe00dd6398cf3a832883fd346416d21e58d9dea06e0a89b7a9a8",
"md5": "aab4d6d4e6327f557ca7bca27cc2eeed",
"sha256": "64179f73289f425729a427cd82f7b0415866e163ab4a92ec6c2100c0ad8c9f33"
},
"downloads": -1,
"filename": "mqt.bench-1.1.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "aab4d6d4e6327f557ca7bca27cc2eeed",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.10",
"size": 4151457,
"upload_time": "2024-04-11T12:13:59",
"upload_time_iso_8601": "2024-04-11T12:13:59.987087Z",
"url": "https://files.pythonhosted.org/packages/a8/50/26133098fe00dd6398cf3a832883fd346416d21e58d9dea06e0a89b7a9a8/mqt.bench-1.1.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "e72e7511bf4b359c1467dc4c8cd7dc88abb6c1d60ffdd7664303c8c4b4183ca5",
"md5": "a9f316171d216763e4621d977153568e",
"sha256": "5be0caf24a2adffa137e74f79ca1f697dd2130890a6cacc59b5826e54ac55a57"
},
"downloads": -1,
"filename": "mqt.bench-1.1.1.tar.gz",
"has_sig": false,
"md5_digest": "a9f316171d216763e4621d977153568e",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.10",
"size": 4812826,
"upload_time": "2024-04-11T12:14:02",
"upload_time_iso_8601": "2024-04-11T12:14:02.631472Z",
"url": "https://files.pythonhosted.org/packages/e7/2e/7511bf4b359c1467dc4c8cd7dc88abb6c1d60ffdd7664303c8c4b4183ca5/mqt.bench-1.1.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-04-11 12:14:02",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "cda-tum",
"github_project": "mqtbench",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "mqt.bench"
}
