From 14e968e5c6fa3aaed31d39ebad6c57ada3a24225 Mon Sep 17 00:00:00 2001 From: burgholzer Date: Sat, 16 Nov 2024 15:16:38 -0500 Subject: [PATCH 1/3] =?UTF-8?q?=F0=9F=8D=B1=20add=20citation=20file?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- CITATION.cff | 151 +++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 151 insertions(+) create mode 100644 CITATION.cff diff --git a/CITATION.cff b/CITATION.cff new file mode 100644 index 0000000..2829b58 --- /dev/null +++ b/CITATION.cff @@ -0,0 +1,151 @@ +cff-version: 1.2.0 +title: Munich Quantum Toolkit (MQT) +message: >- + Please cite the MQT using the metadata from 'preferred-citation'. +type: software +authors: + - given-names: Robert + family-names: Wille + email: robert.wille@tum.de + affiliation: 'Technical University of Munich, Germany' + orcid: 'https://orcid.org/0000-0002-4993-7860' + - given-names: Lucas + family-names: Berent + email: lucas.berent@tum.de + affiliation: 'Technical University of Munich, Germany' + orcid: 'https://orcid.org/0000-0002-2973-1689' + - given-names: Tobias + family-names: Forster + email: tobias.forster@tum.de + affiliation: 'Technical University of Munich, Germany' + orcid: 'https://orcid.org/0009-0009-5900-7438' + - given-names: Jagatheesan + family-names: Kunasaikaran + email: jagatheesan.kunasaikaran@tum.de + affiliation: 'Technical University of Munich, Germany' + orcid: 'https://orcid.org/0009-0003-7097-5428' + - given-names: Kevin + family-names: Mato + email: kevin.mato@tum.de + affiliation: 'Technical University of Munich, Germany' + orcid: 'https://orcid.org/0000-0003-2073-5226' + - given-names: Tom + family-names: Peham + email: tom.peham@tum.de + affiliation: 'Technical University of Munich, Germany' + orcid: 'https://orcid.org/0000-0003-3434-7881' + - given-names: Nils + family-names: Quetschlich + email: nils.quetschlich@tum.de + affiliation: 'Technical University of Munich, Germany' + orcid: 'https://orcid.org/0000-0002-4369-5207' + - given-names: Damian + family-names: Rovara + email: damian.rovara@tum.de + affiliation: 'Technical University of Munich, Germany' + orcid: 'https://orcid.org/0009-0000-7416-9149' + - given-names: Aaron + family-names: Sander + email: aaron.sander@tum.de + affiliation: 'Technical University of Munich, Germany' + orcid: 'https://orcid.org/0009-0007-9166-6113' + - given-names: Ludwig + family-names: Schmid + email: ludwig.s.schmid@tum.de + affiliation: 'Technical University of Munich, Germany' + orcid: 'https://orcid.org/0000-0002-4246-8125' + - given-names: Daniel + family-names: Schoenberger + email: daniel.schoenberger@tum.de + affiliation: 'Technical University of Munich, Germany' + orcid: 'https://orcid.org/0009-0005-8059-0534' + - given-names: Yannick + family-names: Stade + email: yannick.stade@tum.de + affiliation: 'Technical University of Munich, Germany' + orcid: 'https://orcid.org/0000-0001-5785-2528' + - given-names: Lukas + family-names: Burgholzer + email: lukas.burgholzer@tum.de + affiliation: 'Technical University of Munich, Germany' + orcid: 'https://orcid.org/0000-0003-4699-1316' +identifiers: + - type: doi + value: 10.1109/QSW62656.2024.00013 + - type: url + value: 'https://arxiv.org/abs/2405.17543' +url: 'https://mqt.readthedocs.io' +license: MIT +preferred-citation: + type: conference-paper + title: "The MQT Handbook: A Summary of Design Automation Tools and Software for Quantum Computing" + conference: "IEEE International Conference on Quantum Software (QSW)" + year: 2024 + month: 7 + doi: "10.1109/QSW62656.2024.00013" + authors: + - given-names: Robert + family-names: Wille + email: robert.wille@tum.de + affiliation: 'Technical University of Munich, Germany' + orcid: 'https://orcid.org/0000-0002-4993-7860' + - given-names: Lucas + family-names: Berent + email: lucas.berent@tum.de + affiliation: 'Technical University of Munich, Germany' + orcid: 'https://orcid.org/0000-0002-2973-1689' + - given-names: Tobias + family-names: Forster + email: tobias.forster@tum.de + affiliation: 'Technical University of Munich, Germany' + orcid: 'https://orcid.org/0009-0009-5900-7438' + - given-names: Jagatheesan + family-names: Kunasaikaran + email: jagatheesan.kunasaikaran@tum.de + affiliation: 'Technical University of Munich, Germany' + orcid: 'https://orcid.org/0009-0003-7097-5428' + - given-names: Kevin + family-names: Mato + email: kevin.mato@tum.de + affiliation: 'Technical University of Munich, Germany' + orcid: 'https://orcid.org/0000-0003-2073-5226' + - given-names: Tom + family-names: Peham + email: tom.peham@tum.de + affiliation: 'Technical University of Munich, Germany' + orcid: 'https://orcid.org/0000-0003-3434-7881' + - given-names: Nils + family-names: Quetschlich + email: nils.quetschlich@tum.de + affiliation: 'Technical University of Munich, Germany' + orcid: 'https://orcid.org/0000-0002-4369-5207' + - given-names: Damian + family-names: Rovara + email: damian.rovara@tum.de + affiliation: 'Technical University of Munich, Germany' + orcid: 'https://orcid.org/0009-0000-7416-9149' + - given-names: Aaron + family-names: Sander + email: aaron.sander@tum.de + affiliation: 'Technical University of Munich, Germany' + orcid: 'https://orcid.org/0009-0007-9166-6113' + - given-names: Ludwig + family-names: Schmid + email: ludwig.s.schmid@tum.de + affiliation: 'Technical University of Munich, Germany' + orcid: 'https://orcid.org/0000-0002-4246-8125' + - given-names: Daniel + family-names: Schoenberger + email: daniel.schoenberger@tum.de + affiliation: 'Technical University of Munich, Germany' + orcid: 'https://orcid.org/0009-0005-8059-0534' + - given-names: Yannick + family-names: Stade + email: yannick.stade@tum.de + affiliation: 'Technical University of Munich, Germany' + orcid: 'https://orcid.org/0000-0001-5785-2528' + - given-names: Lukas + family-names: Burgholzer + email: lukas.burgholzer@tum.de + affiliation: 'Technical University of Munich, Germany' + orcid: 'https://orcid.org/0000-0003-4699-1316' From c70f52b8a64978a292fc2d12c4700afcd40183ad Mon Sep 17 00:00:00 2001 From: burgholzer Date: Sat, 16 Nov 2024 15:38:00 -0500 Subject: [PATCH 2/3] =?UTF-8?q?=F0=9F=8E=A8=20updated=20dark=20mode=20CSS?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- docs/_static/custom.css | 7 ++++++- 1 file changed, 6 insertions(+), 1 deletion(-) diff --git a/docs/_static/custom.css b/docs/_static/custom.css index b1532d3..b1462b0 100644 --- a/docs/_static/custom.css +++ b/docs/_static/custom.css @@ -36,7 +36,8 @@ body:not([data-theme="light"]) .highlight .sa, .highlight .sr, .highlight .s1, .highlight .ss, -.highlight .s1 { +.highlight .s1, +.highlight .s { background-color: #00000001; } @@ -47,3 +48,7 @@ body:not([data-theme="light"]) { --mystnb-stderr-bg-color: #442222; --mystnb-traceback-bg-color: #202020; } + +body:not([data-theme="light"]) .highlight .gp { + color: #c65d09; +} From 6829d6ad306c382db0fe3a9ac916bf0e88b923d4 Mon Sep 17 00:00:00 2001 From: burgholzer Date: Sat, 16 Nov 2024 15:38:52 -0500 Subject: [PATCH 3/3] =?UTF-8?q?=F0=9F=93=9D=20add=20citation=20information?= =?UTF-8?q?=20to=20README=20and=20RtD?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- README.md | 16 ++++++++++++++++ docs/index.md | 20 ++++++++++++++++++-- 2 files changed, 34 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 8828ff1..877a8db 100644 --- a/README.md +++ b/README.md @@ -17,6 +17,22 @@ The [_Munich Quantum Toolkit (MQT)_](https://mqt.readthedocs.io) is a collection

+If you want to cite the Munich Quantum Toolkit, please use the following BibTeX entry: + +```bibtex +@inproceedings{mqt, + title = {The {{MQT}} Handbook: {{A}} Summary of Design Automation Tools and Software for Quantum Computing}, + shorttitle = {{The MQT Handbook}}, + booktitle = {IEEE International Conference on Quantum Software (QSW)}, + 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}, + date = {2024}, + 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}}, +} +``` + ## GitHub Information diff --git a/docs/index.md b/docs/index.md index f213b58..d25a311 100644 --- a/docs/index.md +++ b/docs/index.md @@ -35,7 +35,23 @@ A live version of this document is available at [mqt.readthedocs.io](https://mqt \sphinxtableofcontents ``` -```{only} html +````{only} html +If you want to cite the Munich Quantum Toolkit, please use the following BibTeX entry: + +```bibtex +@inproceedings{mqt, + title = {The {{MQT}} Handbook: {{A}} Summary of Design Automation Tools and Software for Quantum Computing}, + shorttitle = {{The MQT Handbook}}, + booktitle = {IEEE International Conference on Quantum Software (QSW)}, + 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}, + date = {2024}, + 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}}, +} +``` + For a comprehensive visual depiction of the MQT tools, we invite you to download our MQT Flyer.
@@ -46,7 +62,7 @@ For a comprehensive visual depiction of the MQT tools, we invite you to download
-``` +```` ```{toctree} :caption: The MQT Handbook