Skip to content

Commit 8fa2f5a

Browse files
🚚 Adapt after move to MQT organization (#385)
This PR introduces changes to the package look and feel and prepares the repository for moving into the [MQT organization](https://github.com/munich-quantum-toolkit). --------- Co-authored-by: flowerthrower <flowerthrower@users.noreply.github.com>
1 parent 90d7a41 commit 8fa2f5a

35 files changed

Lines changed: 275 additions & 51 deletions

.github/ISSUE_TEMPLATE/bug-report.yml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -8,9 +8,9 @@ body:
88
**Thank you for wanting to report a bug for this project!**
99
1010
11-
Verify first that your issue is not [already reported on GitHub](https://github.com/cda-tum/mqt-predictor/search?q=is%3Aissue&type=issues).
11+
Verify first that your issue is not [already reported on GitHub](https://github.com/munich-quantum-toolkit/predictor/search?q=is%3Aissue&type=issues).
1212
13-
If you have general questions, please consider [starting a discussion](https://github.com/cda-tum/mqt-predictor/discussions).
13+
If you have general questions, please consider [starting a discussion](https://github.com/munich-quantum-toolkit/predictor/discussions).
1414
- type: textarea
1515
attributes:
1616
label: Environment information

.github/ISSUE_TEMPLATE/feature-request.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ body:
88
**Thank you for wanting to suggest a feature for this project!**
99
1010
11-
Verify first that your idea is not [already requested on GitHub](https://github.com/cda-tum/mqt-predictor/search?q=is%3Aissue&type=issues).
11+
Verify first that your idea is not [already requested on GitHub](https://github.com/munich-quantum-toolkit/predictor/search?q=is%3Aissue&type=issues).
1212
1313
- type: textarea
1414
attributes:

.github/contributing.rst

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ We value contributions from people with all levels of experience.
66
In particular if this is your first pull request not everything has to be perfect.
77
We will guide you through the process.
88

9-
We use GitHub to `host code <https://github.com/cda-tum/mqt-predictor>`_, to `track issues and feature requests <https://github.com/cda-tum/mqt-predictor/issues>`_, as well as accept `pull requests <https://github.com/cda-tum/mqt-predictor/pulls>`_.
9+
We use GitHub to `host code <https://github.com/munich-quantum-toolkit/predictor>`_, to `track issues and feature requests <https://github.com/munich-quantum-toolkit/predictor/issues>`_, as well as accept `pull requests <https://github.com/munich-quantum-toolkit/predictor/pulls>`_.
1010
See https://docs.github.com/en/get-started/quickstart for a general introduction to working with GitHub and contributing to projects.
1111

1212
Types of Contributions
@@ -15,16 +15,16 @@ Types of Contributions
1515
You can contribute in several ways:
1616

1717
- 🐛 Report Bugs
18-
Report bugs at https://github.com/cda-tum/mqt-predictor/issues using the *🐛 Bug report* issue template. Please make sure to fill out all relevant information in the respective issue form.
18+
Report bugs at https://github.com/munich-quantum-toolkit/predictor/issues using the *🐛 Bug report* issue template. Please make sure to fill out all relevant information in the respective issue form.
1919

2020
- 🐛 Fix Bugs
21-
Look through the `GitHub Issues <https://github.com/cda-tum/mqt-predictor/issues>`_ for bugs. Anything tagged with "bug" is open to whoever wants to try and fix it.
21+
Look through the `GitHub Issues <https://github.com/munich-quantum-toolkit/predictor/issues>`_ for bugs. Anything tagged with "bug" is open to whoever wants to try and fix it.
2222

2323
- ✨ Propose New Features
24-
Propose new features at https://github.com/cda-tum/mqt-predictor/issues using the *✨ Feature request* issue template. Please make sure to fill out all relevant information in the respective issue form.
24+
Propose new features at https://github.com/munich-quantum-toolkit/predictor/issues using the *✨ Feature request* issue template. Please make sure to fill out all relevant information in the respective issue form.
2525

2626
- ✨ Implement New Features
27-
Look through the `GitHub Issues <https://github.com/cda-tum/mqt-predictor/issues>`_ for features. Anything tagged with "feature" is open to whoever wants to implement it. We highly appreciate external contributions to the project.
27+
Look through the `GitHub Issues <https://github.com/munich-quantum-toolkit/predictor/issues>`_ for features. Anything tagged with "feature" is open to whoever wants to implement it. We highly appreciate external contributions to the project.
2828

2929
- 📝 Write Documentation
3030
MQT Predictor could always use some more `documentation <https://mqt.readthedocs.io/projects/predictor>`_, and we appreciate any help with that.

.github/support.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,12 @@
11
Support
22
=======
33

4-
If you are stuck with a problem using MQT Predictor or have questions, please do get in touch at our `Issues <https://github.com/cda-tum/mqt-predictor/issues>`_ or `Discussions <https://github.com/cda-tum/mqt-predictor/discussions>`_. We'd love to help.
4+
If you are stuck with a problem using MQT Predictor or have questions, please do get in touch at our `Issues <https://github.com/munich-quantum-toolkit/predictor/issues>`_ or `Discussions <https://github.com/munich-quantum-toolkit/predictor/discussions>`_. We'd love to help.
55

66
You can save time by following this procedure when reporting a problem:
77

88
- Do try to solve the problem on your own first. Make sure to consult the `Documentation <https://mqt.readthedocs.io/projects/predictor>`_.
9-
- Search through past `Issues <https://github.com/cda-tum/mqt-predictor/issues>`_ to see if someone else already had the same problem.
9+
- Search through past `Issues <https://github.com/munich-quantum-toolkit/predictor/issues>`_ to see if someone else already had the same problem.
1010
- Before filing a bug report, try to create a minimal working example (MWE) that reproduces the problem. It's much easier to identify the cause for the problem if a handful of lines suffice to show that something isn't working.
1111

1212
You can also always reach us at `quantum.cda@xcit.tum.de <mailto:quantum.cda@xcit.tum.de>`_.

.license-tools-config.json

Lines changed: 32 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,32 @@
1+
{
2+
"author": {
3+
"name": "Chair for Design Automation, TUM\nCopyright (c) 2025 Munich Quantum Software Company GmbH",
4+
"years": [2023, 2025]
5+
},
6+
"force_author": true,
7+
"license": "MIT",
8+
"title": false,
9+
"include": ["**/*"],
10+
"style_override_for_suffix": {
11+
".pyi": "DOCSTRING_STYLE",
12+
".in": "POUND_STYLE",
13+
".mlir": "SLASH_STYLE",
14+
".td": "SLASH_STYLE",
15+
".yaml": "POUND_STYLE",
16+
".toml": "POUND_STYLE"
17+
},
18+
"exclude": [
19+
"^\\.[^/]+",
20+
"/\\.[^/]+",
21+
".*\\.md",
22+
".*\\.bib",
23+
".*\\.css",
24+
".*\\.ipynb",
25+
".*\\.json",
26+
".*\\.html",
27+
"uv\\.lock",
28+
".*\\.rst",
29+
"py\\.typed",
30+
".*build.*"
31+
]
32+
}

.pre-commit-config.yaml

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -70,6 +70,12 @@ repos:
7070
- id: blacken-docs
7171
additional_dependencies: [black==24.*]
7272

73+
# Check for license headers
74+
- repo: https://github.com/emzeat/mz-lictools
75+
rev: v2.7.0
76+
hooks:
77+
- id: license-tools
78+
7379
# Format configuration files with prettier
7480
- repo: https://github.com/rbubley/mirrors-prettier
7581
rev: v3.5.3
File renamed without changes.

README.md

Lines changed: 27 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,16 @@
11
[![PyPI](https://img.shields.io/pypi/v/mqt.predictor?logo=pypi&style=flat-square)](https://pypi.org/project/mqt.predictor/)
22
![OS](https://img.shields.io/badge/os-linux%20%7C%20macos%20%7C%20windows-blue?style=flat-square)
33
[![License: MIT](https://img.shields.io/badge/license-MIT-blue.svg?style=flat-square)](https://opensource.org/licenses/MIT)
4-
[![CI](https://img.shields.io/github/actions/workflow/status/cda-tum/mqt-predictor/ci.yml?branch=main&style=flat-square&logo=github&label=ci)](https://github.com/cda-tum/mqt-predictor/actions/workflows/ci.yml)
5-
[![CD](https://img.shields.io/github/actions/workflow/status/cda-tum/mqt-predictor/cd.yml?style=flat-square&logo=github&label=cd)](https://github.com/cda-tum/mqt-predictor/actions/workflows/cd.yml)
4+
[![CI](https://img.shields.io/github/actions/workflow/status/munich-quantum-toolkit/predictor/ci.yml?branch=main&style=flat-square&logo=github&label=ci)](https://github.com/munich-quantum-toolkit/predictor/actions/workflows/ci.yml)
5+
[![CD](https://img.shields.io/github/actions/workflow/status/munich-quantum-toolkit/predictor/cd.yml?style=flat-square&logo=github&label=cd)](https://github.com/munich-quantum-toolkit/predictor/actions/workflows/cd.yml)
66
[![Documentation](https://img.shields.io/readthedocs/mqt-predictor?logo=readthedocs&style=flat-square)](https://mqt.readthedocs.io/projects/predictor)
7-
[![codecov](https://img.shields.io/codecov/c/github/cda-tum/mqt-predictor?style=flat-square&logo=codecov)](https://codecov.io/gh/cda-tum/mqt-predictor)
7+
[![codecov](https://img.shields.io/codecov/c/github/munich-quantum-toolkit/predictor?style=flat-square&logo=codecov)](https://codecov.io/gh/munich-quantum-toolkit/predictor)
88

99
<p align="center">
1010
<a href="https://mqt.readthedocs.io">
1111
<picture>
12-
<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%">
13-
<img src="https://raw.githubusercontent.com/munich-quantum-toolkit/.github/refs/heads/main/docs/_static/mqt-banner-light.svg" width="90%" alt="MQT Banner">
12+
<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%">
13+
<img src="https://raw.githubusercontent.com/munich-quantum-toolkit/.github/refs/heads/main/docs/_static/logo-mqt-light.svg" width="60%" alt="MQT Logo">
1414
</picture>
1515
</a>
1616
</p>
@@ -41,13 +41,29 @@ For more details, please refer to:
4141
</a>
4242
</p>
4343

44-
MQT Predictor is part of the [Munich Quantum Toolkit (MQT)](https://mqt.readthedocs.io/) developed by the [Chair for Design Automation](https://www.cda.cit.tum.de/) at the [Technical University of Munich](https://www.tum.de/).
44+
## Contributors and Supporters
4545

46-
If you have any questions, feel free to create a [discussion](https://github.com/cda-tum/mqt-predictor/discussions) or an [issue](https://github.com/cda-tum/mqt-predictor/issues) on [GitHub](https://github.com/cda-tum/mqt-predictor).
46+
The _[Munich Quantum Toolkit (MQT)](https://mqt.readthedocs.io)_ 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 supported by the [Munich Quantum Software Company (MQSC)](https://munichquantum.software).
47+
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.
48+
49+
<p align="center">
50+
<picture>
51+
<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%">
52+
<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">
53+
</picture>
54+
</p>
55+
56+
Thank you to all the contributors who have helped make MQT Predictor a reality!
57+
58+
<p align="center">
59+
<a href="https://github.com/munich-quantum-toolkit/predictor/graphs/contributors">
60+
<img src="https://contrib.rocks/image?repo=munich-quantum-toolkit/predictor" />
61+
</a>
62+
</p>
4763

4864
## Getting Started
4965

50-
`mqt-predictor` is available via [PyPI](https://pypi.org/project/mqt.predictor/).
66+
`mqt.predictor` is available via [PyPI](https://pypi.org/project/mqt.predictor/).
5167

5268
```console
5369
(venv) $ pip install mqt.predictor
@@ -59,7 +75,7 @@ The following code gives an example on the usage:
5975
from mqt.predictor import qcompile
6076
from mqt.bench import get_benchmark
6177

62-
# get a benchmark circuit on algorithmic level representing the GHZ state with 5 qubits from [MQT Bench](https://github.com/cda-tum/mqt-bench)
78+
# get a benchmark circuit on algorithmic level representing the GHZ state with 5 qubits from [MQT Bench](https://github.com/munich-quantum-toolkit/bench)
6379
qc_uncompiled = get_benchmark(benchmark_name="ghz", level="alg", circuit_size=5)
6480

6581
# compile it using the MQT Predictor
@@ -98,6 +114,8 @@ In case you are using MQT Predictor in your work, we would be thankful if you re
98114
}
99115
```
100116

117+
---
118+
101119
## Acknowledgements
102120

103121
This project received funding from the European Research Council (ERC) under the European Union's Horizon 2020 research

docs/Compilation.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -51,5 +51,5 @@ We trained one RL model for each currently :ref:`supported quantum device <suppo
5151

5252
Training Data
5353
-------------
54-
To train the model, sufficient training data must be provided as qasm files in the `respective directory <https://github.com/cda-tum/mqt-predictor/tree/main/src/mqt/predictor/rl/training_data/training_circuits>`_.
55-
We provide the training data used for the initial performance evaluation of this framework which are stored `here <https://github.com/cda-tum/mqt-predictor/tree/main/src/mqt/predictor/rl/training_data/trained_model>`_.
54+
To train the model, sufficient training data must be provided as qasm files in the `respective directory <https://github.com/munich-quantum-toolkit/predictor/tree/main/src/mqt/predictor/rl/training_data/training_circuits>`_.
55+
We provide the training data used for the initial performance evaluation of this framework which are stored `here <https://github.com/munich-quantum-toolkit/predictor/tree/main/src/mqt/predictor/rl/training_data/trained_model>`_.

docs/DevelopmentGuide.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ Ready to contribute to the project? Here is how to set up a local development en
66
Initial Setup
77
#############
88

9-
1. Fork the `cda-tum/mqt-predictor <https://github.com/cda-tum/mqt-predictor>`_ repository on GitHub (see https://docs.github.com/en/get-started/quickstart/fork-a-repo).
9+
1. Fork the `munich-quantum-toolkit/predictor <https://github.com/munich-quantum-toolkit/predictor>`_ repository on GitHub (see https://docs.github.com/en/get-started/quickstart/fork-a-repo).
1010

1111
2. Clone your fork locally
1212

0 commit comments

Comments
 (0)