Skip to content

Commit 82f9c67

Browse files
🚚 Prepare move to MQT organization (#156)
## Description This PR prepares the move to the MQT organization. - Streamline the README. - Streamline the documentation. Remove work-in-progress files. Documentation will be added with #103. - Slightly off topic, but test GitHub Pages build in PRs. ## Checklist: - [x] The pull request only contains commits that are focused and relevant to this change. - [x] ~I have added appropriate tests that cover the new/changed functionality.~ - [x] ~I have updated the documentation to reflect these changes.~ - [x] The changes follow the project's style guidelines and introduce no new warnings. - [x] The changes are fully tested and pass the CI checks. - [x] I have reviewed my own code changes. --------- Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>
1 parent f845242 commit 82f9c67

18 files changed

+589
-607
lines changed

.github/contributing.md renamed to .github/CONTRIBUTING.md

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

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

1111
## Types of Contributions
1212

1313
You can contribute in several ways:
1414

1515
- 🐛 Report Bugs
16-
: Report bugs at <https://github.com/cda-tum/mqt-naviz/issues> using the _🐛 Bug report_ issue template. Please make sure to fill out all relevant information in the respective issue form.
16+
: Report bugs at <https://github.com/munich-quantum-toolkit/naviz/issues> using the _🐛 Bug report_ issue template. Please make sure to fill out all relevant information in the respective issue form.
1717

1818
- 🐛 Fix Bugs
19-
: Look through the [GitHub Issues](https://github.com/cda-tum/mqt-naviz/issues) for bugs. Anything tagged with "bug" is open to whoever wants to try and fix it.
19+
: Look through the [GitHub Issues](https://github.com/munich-quantum-toolkit/naviz/issues) for bugs. Anything tagged with "bug" is open to whoever wants to try and fix it.
2020

2121
- ✨ Propose New Features
22-
: Propose new features at <https://github.com/cda-tum/mqt-naviz/issues> using the _✨ Feature request_ issue template. Please make sure to fill out all relevant information in the respective issue form.
22+
: Propose new features at <https://github.com/munich-quantum-toolkit/naviz/issues> using the _✨ Feature request_ issue template. Please make sure to fill out all relevant information in the respective issue form.
2323

2424
- ✨ Implement New Features
25-
: Look through the [GitHub Issues](https://github.com/cda-tum/mqt-naviz/issues) for features. Anything tagged with "feature" or "enhancement" is open to whoever wants to implement it. We highly appreciate external contributions to the project.
25+
: Look through the [GitHub Issues](https://github.com/munich-quantum-toolkit/naviz/issues) for features. Anything tagged with "feature" or "enhancement" is open to whoever wants to implement it. We highly appreciate external contributions to the project.
2626

2727
- 📝 Write Documentation
2828
: MQT NAViz could always use some more documentation, and we appreciate any help with that.

.github/ISSUE_TEMPLATE/bug-report.yml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -8,8 +8,8 @@ body:
88
**Thanks for taking the time to report an issue!**
99
1010
⚠ Before submitting:
11-
1. Search [existing issues](https://github.com/cda-tum/mqt-naviz/search?q=is%3Aissue&type=issues) to avoid duplicates
12-
2. For questions or discussions, please use our [discussions forum](https://github.com/cda-tum/mqt-naviz/discussions)
11+
1. Search [existing issues](https://github.com/munich-quantum-toolkit/naviz/search?q=is%3Aissue&type=issues) to avoid duplicates
12+
2. For questions or discussions, please use our [discussions forum](https://github.com/munich-quantum-toolkit/naviz/discussions)
1313
- type: textarea
1414
attributes:
1515
label: System 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
**Thanks for helping improve this project by suggesting a feature!**
99
1010
⚠ Before submitting:
11-
- Search [existing feature requests](https://github.com/cda-tum/mqt-naviz/search?q=is%3Aissue&type=issues) to avoid duplicates
11+
- Search [existing feature requests](https://github.com/munich-quantum-toolkit/naviz/search?q=is%3Aissue&type=issues) to avoid duplicates
1212
- One feature per issue helps us track and implement ideas effectively
1313
1414
- type: textarea

.github/release.yaml

Lines changed: 0 additions & 26 deletions
This file was deleted.

.github/support.md

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

3-
If you are stuck with a problem using MQT NAViz or have questions, please get in touch at our [Issues](https://github.com/cda-tum/mqt-naviz/issues) or [Discussions](https://github.com/cda-tum/mqt-naviz/discussions). We'd love to help.
3+
If you are stuck with a problem using MQT NAViz or have questions, please get in touch at our [Issues](https://github.com/munich-quantum-toolkit/naviz/issues) or [Discussions](https://github.com/munich-quantum-toolkit/naviz/discussions). We'd love to help.
44

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

77
- Do try to solve the problem on your own first.
8-
- Search through past [Issues](https://github.com/cda-tum/mqt-naviz/issues) and [Discussions](https://github.com/cda-tum/mqt-naviz/discussions) to see if someone else already had the same problem.
8+
- Search through past [Issues](https://github.com/munich-quantum-toolkit/naviz/issues) and [Discussions](https://github.com/munich-quantum-toolkit/naviz/discussions) to see if someone else already had the same problem.
99
- Before filing a bug report, try to create a minimal working example (MWE) that reproduces the problem. It is much easier to identify the cause for the problem if a handful of lines suffice to show that something is not working.
1010

1111
You can also always reach us at [[email protected]](mailto:[email protected]).

.github/workflows/github-pages.yaml

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -11,8 +11,11 @@ on:
1111
push:
1212
branches:
1313
- main
14-
tags:
15-
- "v*" # Rebuild when a full version is released
14+
release:
15+
types: [published]
16+
pull_request:
17+
merge_group:
18+
workflow_dispatch:
1619

1720
# Cancel any old builds when starting a new build
1821
concurrency:
@@ -52,6 +55,7 @@ jobs:
5255
path: ./gui/dist
5356

5457
deploy:
58+
if: github.ref == 'refs/heads/main'
5559
environment:
5660
name: github-pages
5761
url: ${{ steps.deployment.outputs.page_url }}

.readthedocs.yml

Lines changed: 3 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,9 @@ version: 2
22

33
formats:
44
- htmlzip
5-
# - pdf
5+
6+
sphinx:
7+
configuration: docs/conf.py
68

79
build:
810
os: ubuntu-24.04
@@ -39,11 +41,3 @@ build:
3941
- uv run --frozen --no-dev --no-build-isolation-package mqt-naviz -m sphinx -T -b dirhtml -d docs/_build/doctrees -D language=en docs docs/_build/dirhtml
4042
- mkdir -p $READTHEDOCS_OUTPUT/htmlzip
4143
- zip -r $READTHEDOCS_OUTPUT/htmlzip/html.zip docs/_build/dirhtml/*
42-
# pdf:
43-
# - uv run --frozen --no-dev --no-build-isolation-package mqt-naviz -m sphinx -T -b latex -d docs/_build/doctrees -D language=en docs docs/_build/latex
44-
# - cd docs/_build/latex && latexmk -pdf -f -dvi- -ps- -interaction=nonstopmode -jobname=$READTHEDOCS_PROJECT
45-
# - mkdir -p $READTHEDOCS_OUTPUT/pdf
46-
# - cp docs/_build/latex/$READTHEDOCS_PROJECT.pdf $READTHEDOCS_OUTPUT/pdf/$READTHEDOCS_PROJECT.pdf
47-
48-
sphinx:
49-
configuration: docs/conf.py

Cargo.toml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ resolver = "2"
1414

1515
[workspace.package]
1616
license = "LGPL-3.0-or-later WITH LGPL-3.0-linking-exception"
17-
repository = "https://github.com/cda-tum/mqt-naviz"
17+
repository = "https://github.com/munich-quantum-toolkit/naviz"
1818

1919
[workspace.dependencies]
2020
naviz-animator = {path = "animator", version = "0.4.1"}

README.md

Lines changed: 38 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,3 @@
1-
<!-- [![PyPI](https://img.shields.io/pypi/v/mqt.naviz?logo=pypi&style=flat-square)](https://pypi.org/project/mqt.naviz/) -->
2-
<!-- ![OS](https://img.shields.io/badge/os-linux%20%7C%20macos%20%7C%20windows-blue?style=flat-square) -->
3-
<!-- [![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-naviz/ci.yml?branch=main&style=flat-square&logo=github&label=ci)](https://github.com/cda-tum/mqt-naviz/actions/workflows/ci.yml) -->
5-
<!-- [![CD](https://img.shields.io/github/actions/workflow/status/cda-tum/mqt-naviz/cd.yml?style=flat-square&logo=github&label=cd)](https://github.com/cda-tum/mqt-naviz/actions/workflows/cd.yml) -->
6-
71
[![Documentation](https://img.shields.io/readthedocs/mqt-naviz?logo=readthedocs&style=flat-square)](https://mqt.readthedocs.io/projects/naviz)
82

93
<p align="center">
@@ -35,7 +29,7 @@ It is developed as part of the [_Munich Quantum Toolkit (MQT)_](https://mqt.read
3529
- Support for different input formats
3630
- Fully customizable visualization style and clean predefined styles
3731

38-
If you have any questions, feel free to create a [discussion](https://github.com/cda-tum/mqt-naviz/discussions) or an [issue](https://github.com/cda-tum/mqt-naviz/issues) on [GitHub](https://github.com/cda-tum/mqt-naviz).
32+
If you have any questions, feel free to create a [discussion](https://github.com/munich-quantum-toolkit/naviz/discussions) or an [issue](https://github.com/munich-quantum-toolkit/naviz/issues) on [GitHub](https://github.com/munich-quantum-toolkit/naviz).
3933

4034
## Contributors and Supporters
4135

@@ -52,11 +46,46 @@ Among others, it is part of the [Munich Quantum Software Stack (MQSS)](https://w
5246
Thank you to all the contributors who have helped make MQT NAViz a reality!
5347

5448
<p align="center">
55-
<a href="https://github.com/cda-tum/mqt-naviz/graphs/contributors">
56-
<img src="https://contrib.rocks/image?repo=cda-tum/mqt-naviz" />
49+
<a href="https://github.com/munich-quantum-toolkit/naviz/graphs/contributors">
50+
<img src="https://contrib.rocks/image?repo=munich-quantum-toolkit/naviz" />
5751
</a>
5852
</p>
5953

54+
The MQT will remain free, open-source, and permissively licensed—now and in the future.
55+
We are firmly committed to keeping it open and actively maintained for the quantum computing community.
56+
57+
To support this endeavor, please consider:
58+
59+
- Starring and sharing our repositories: https://github.com/munich-quantum-toolkit
60+
- Contributing code, documentation, tests, or examples via issues and pull requests
61+
- Citing the MQT in your publications (see [Cite This](#cite-this))
62+
- Using the MQT in research and teaching, and sharing feedback and use cases
63+
- Sponsoring us on GitHub: https://github.com/sponsors/munich-quantum-toolkit
64+
65+
<p align="center">
66+
<a href="https://github.com/sponsors/munich-quantum-toolkit">
67+
<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" />
68+
</a>
69+
</p>
70+
71+
## Cite This
72+
73+
When discussing the overall MQT project or its ecosystem, please cite the MQT Handbook:
74+
75+
```bibtex
76+
@inproceedings{mqt,
77+
title = {The {{MQT}} Handbook: {{A}} Summary of Design Automation Tools and Software for Quantum Computing},
78+
shorttitle = {{The MQT Handbook}},
79+
author = {Will, 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},
80+
year = 2024,
81+
booktitle = {IEEE International Conference on Quantum Software (QSW)},
82+
doi = {10.1109/QSW62656.2024.00013},
83+
eprint = {2405.17543},
84+
eprinttype = {arxiv},
85+
addendum = {A live version of this document is available at \url{https://mqt.readthedocs.io}}
86+
}
87+
```
88+
6089
---
6190

6291
## Acknowledgements

0 commit comments

Comments
 (0)