Skip to content

Commit 9b6e014

Browse files
authored
📝 Add JOSS journal reference and citation information (#913)
## Description This PR adds the journal reference from the just-published article in the Journal of Open Source Software 🎉 It also adds the respective citation information and touches up the changelog. ## Checklist: <!--- This checklist serves as a reminder of a couple of things that ensure your pull request will be merged swiftly. --> - [x] The pull request only contains commits that are related to it. - [x] I have added appropriate tests and documentation. - [x] I have made sure that all CI jobs on GitHub pass. - [x] The pull request introduces no new warnings and follows the project's style guidelines. --------- Signed-off-by: burgholzer <[email protected]>
1 parent 7a27bf4 commit 9b6e014

File tree

7 files changed

+119
-2
lines changed

7 files changed

+119
-2
lines changed

.license-tools-config.json

+1
Original file line numberDiff line numberDiff line change
@@ -19,6 +19,7 @@
1919
".*\\.qasm",
2020
".*\\.md",
2121
".*\\.bib",
22+
".*\\.cff",
2223
".*\\.css",
2324
".*\\.json",
2425
".*\\.html",

CHANGELOG.md

+16-2
Original file line numberDiff line numberDiff line change
@@ -7,9 +7,22 @@ This project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.htm
77

88
## [Unreleased]
99

10+
## [3.0.2] - 2025-04-07
11+
12+
### Added
13+
14+
- 📝 Add JOSS journal reference and citation information ([#913](https://github.com/munich-quantum-toolkit/core/pull/913)) ([**@burgholzer**](https://github.com/burgholzer))
15+
- 📝 Add new links to Python package metadata ([#911](https://github.com/munich-quantum-toolkit/core/pull/911)) ([**@burgholzer**](https://github.com/burgholzer))
16+
17+
### Fixed
18+
19+
- 📝 Fix old links in Python package metadata ([#911](https://github.com/munich-quantum-toolkit/core/pull/911)) ([**@burgholzer**](https://github.com/burgholzer))
20+
1021
## [3.0.1] - 2025-04-07
1122

12-
_Fix PyPI project metadata as well as doxygen build on RtD._
23+
### Fixed
24+
25+
- 🐛 Fix doxygen build on RtD to include C++ API docs ([#912](https://github.com/munich-quantum-toolkit/core/pull/912)) ([**@burgholzer**](https://github.com/burgholzer))
1326

1427
## [3.0.0] - 2025-04-06
1528

@@ -68,7 +81,8 @@ _📚 Refer to the [GitHub Release Notes](https://github.com/munich-quantum-tool
6881

6982
[PEP 639]: https://peps.python.org/pep-0639/
7083
[PEP 735]: https://peps.python.org/pep-0735/
71-
[unreleased]: https://github.com/munich-quantum-toolkit/core/compare/v3.0.1...HEAD
84+
[unreleased]: https://github.com/munich-quantum-toolkit/core/compare/v3.0.2...HEAD
85+
[3.0.2]: https://github.com/munich-quantum-toolkit/core/compare/v3.0.1...v3.0.2
7286
[3.0.1]: https://github.com/munich-quantum-toolkit/core/compare/v3.0.0...v3.0.1
7387
[3.0.0]: https://github.com/munich-quantum-toolkit/core/compare/v2.7.0...v3.0.0
7488
[2.7.0]: https://github.com/munich-quantum-toolkit/core/releases/tag/v2.7.0

CITATION.cff

+48
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,48 @@
1+
cff-version: "1.2.0"
2+
authors:
3+
- family-names: Burgholzer
4+
given-names: Lukas
5+
orcid: "https://orcid.org/0000-0003-4699-1316"
6+
- family-names: Stade
7+
given-names: Yannick
8+
orcid: "https://orcid.org/0000-0001-5785-2528"
9+
- family-names: Peham
10+
given-names: Tom
11+
orcid: "https://orcid.org/0000-0003-3434-7881"
12+
- family-names: Wille
13+
given-names: Robert
14+
orcid: "https://orcid.org/0000-0002-4993-7860"
15+
contact:
16+
- family-names: Burgholzer
17+
given-names: Lukas
18+
orcid: "https://orcid.org/0000-0003-4699-1316"
19+
doi: 10.6084/m9.figshare.28740254.v1
20+
message: If you use this software, please cite our article in the
21+
Journal of Open Source Software.
22+
preferred-citation:
23+
authors:
24+
- family-names: Burgholzer
25+
given-names: Lukas
26+
orcid: "https://orcid.org/0000-0003-4699-1316"
27+
- family-names: Stade
28+
given-names: Yannick
29+
orcid: "https://orcid.org/0000-0001-5785-2528"
30+
- family-names: Peham
31+
given-names: Tom
32+
orcid: "https://orcid.org/0000-0003-3434-7881"
33+
- family-names: Wille
34+
given-names: Robert
35+
orcid: "https://orcid.org/0000-0002-4993-7860"
36+
date-published: 2025-04-07
37+
doi: 10.21105/joss.07478
38+
issn: 2475-9066
39+
issue: 108
40+
journal: Journal of Open Source Software
41+
publisher:
42+
name: Open Journals
43+
start: 7478
44+
title: "MQT Core: The Backbone of the Munich Quantum Toolkit (MQT)"
45+
type: article
46+
url: "https://joss.theoj.org/papers/10.21105/joss.07478"
47+
volume: 10
48+
title: "MQT Core: The Backbone of the Munich Quantum Toolkit (MQT)"

README.md

+18
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
11
[![PyPI](https://img.shields.io/pypi/v/mqt.core?logo=pypi&style=flat-square)](https://pypi.org/project/mqt.core/)
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+
[![DOI](https://img.shields.io/badge/JOSS-10.21105/joss.07478-blue.svg?style=flat-square)](https://doi.org/10.21105/joss.07478)
45
[![CI](https://img.shields.io/github/actions/workflow/status/munich-quantum-toolkit/core/ci.yml?branch=main&style=flat-square&logo=github&label=ci)](https://github.com/munich-quantum-toolkit/core/actions/workflows/ci.yml)
56
[![CD](https://img.shields.io/github/actions/workflow/status/munich-quantum-toolkit/core/cd.yml?style=flat-square&logo=github&label=cd)](https://github.com/munich-quantum-toolkit/core/actions/workflows/cd.yml)
67
[![Documentation](https://img.shields.io/readthedocs/mqt-core?logo=readthedocs&style=flat-square)](https://mqt.readthedocs.io/projects/core)
@@ -26,6 +27,23 @@ To this end, it consists of multiple components that are used throughout the MQT
2627
</a>
2728
</p>
2829

30+
If you want to cite MQT Core, please use the following BibTeX entry:
31+
32+
```bibtex
33+
@article{burgholzer2025MQTCore,
34+
title = {{{MQT Core}}: {{The}} Backbone of the {{Munich Quantum Toolkit (MQT)}}},
35+
author = {Lukas Burgholzer and Yannick Stade and Tom Peham and Robert Wille},
36+
year = {2025},
37+
journal = {Journal of Open Source Software},
38+
publisher = {The Open Journal},
39+
volume = {10},
40+
number = {108},
41+
pages = {7478},
42+
doi = {10.21105/joss.07478},
43+
url = {https://doi.org/10.21105/joss.07478},
44+
}
45+
```
46+
2947
If you have any questions, feel free to create a [discussion](https://github.com/munich-quantum-toolkit/core/discussions) or an [issue](https://github.com/munich-quantum-toolkit/core/issues) on [GitHub](https://github.com/munich-quantum-toolkit/core).
3048

3149
## Getting Started

docs/index.md

+19
Original file line numberDiff line numberDiff line change
@@ -79,3 +79,22 @@ api/mqt/core/index
7979
8080
api/cpp/namespacelist
8181
```
82+
83+
````{only} html
84+
If you want to cite MQT Core, please use the following BibTeX entry:
85+
86+
```bibtex
87+
@article{burgholzer2025MQTCore,
88+
title = {{{MQT Core}}: {{The}} Backbone of the {{Munich Quantum Toolkit (MQT)}}},
89+
author = {Lukas Burgholzer and Yannick Stade and Tom Peham and Robert Wille},
90+
year = {2025},
91+
journal = {Journal of Open Source Software},
92+
publisher = {The Open Journal},
93+
volume = {10},
94+
number = {108},
95+
pages = {7478},
96+
doi = {10.21105/joss.07478},
97+
url = {https://doi.org/10.21105/joss.07478},
98+
}
99+
```
100+
````

docs/references.md

+4
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,10 @@
66

77
```{only} html
88
# References
9+
10+
If you use *MQT Core* in your work, we would appreciate if you cited {cite:p}`burgholzer2025MQTCore`.
11+
12+
A full list of references is given below.
913
```
1014

1115
```{bibliography}

docs/refs.bib

+13
Original file line numberDiff line numberDiff line change
@@ -44,6 +44,19 @@ @article{bryantSymbolicBooleanManipulation1992
4444
doi = {10.1145/136035.136043},
4545
}
4646

47+
@article{burgholzer2025MQTCore,
48+
title = {{{MQT Core}}: {{The}} Backbone of the {{Munich Quantum Toolkit (MQT)}}},
49+
author = {Lukas Burgholzer and Yannick Stade and Tom Peham and Robert Wille},
50+
year = {2025},
51+
journal = {Journal of Open Source Software},
52+
publisher = {The Open Journal},
53+
volume = {10},
54+
number = {108},
55+
pages = {7478},
56+
doi = {10.21105/joss.07478},
57+
url = {https://doi.org/10.21105/joss.07478},
58+
}
59+
4760
@article{burgholzerAdvancedEquivalenceChecking2021,
4861
title = {Advanced equivalence checking for quantum circuits},
4962
author = {Burgholzer, Lukas and Wille, Robert},

0 commit comments

Comments
 (0)