Skip to content

Commit fe4eaf0

Browse files
authored
Add citation bibtex for arXiv preprint (#457)
1 parent 85d23ef commit fe4eaf0

File tree

5 files changed

+52
-4
lines changed

5 files changed

+52
-4
lines changed

CITATION.bib

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
@article{QuantumToolbox-jl2025,
2+
title={{QuantumToolbox.jl}: An efficient {Julia} framework for simulating open quantum systems},
3+
author={Mercurio, Alberto and Huang, Yi-Te and Cai, Li-Xun and Chen, Yueh-Nan and Savona, Vincenzo and Nori, Franco},
4+
journal={arXiv preprint arXiv:2504.21440},
5+
year={2025},
6+
publisher = {arXiv},
7+
eprint={2504.21440},
8+
archivePrefix={arXiv},
9+
primaryClass={quant-ph},
10+
doi = {10.48550/arXiv.2504.21440}
11+
}

README.md

Lines changed: 20 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@
1010
and [Y.-T. Huang](https://github.com/ytdHuang).
1111

1212
<!-- Table of Badges -->
13-
| **Release** | [![Release][release-img]][release-url] [![License][license-img]][license-url] [![DOI][doi-img]][doi-url] [![Downloads][download-img]][download-url] |
13+
| **Release** | [![Release][release-img]][release-url] [![License][license-img]][license-url] [![Cite][cite-img]][cite-url] [![Downloads][download-img]][download-url] |
1414
|:-----------------:|:-------------|
1515
| **Runtests** | [![Runtests][runtests-img]][runtests-url] [![Coverage][codecov-img]][codecov-url] |
1616
| **Code Quality** | [![Code Quality][code-quality-img]][code-quality-url] [![Aqua QA][aqua-img]][aqua-url] [![JET][jet-img]][jet-url] |
@@ -24,8 +24,8 @@ and [Y.-T. Huang](https://github.com/ytdHuang).
2424
[license-img]: https://img.shields.io/badge/license-New%20BSD-blue.svg
2525
[license-url]: https://opensource.org/licenses/BSD-3-Clause
2626

27-
[doi-img]: https://zenodo.org/badge/DOI/10.5281/zenodo.10822816.svg
28-
[doi-url]: https://doi.org/10.5281/zenodo.10822816
27+
[cite-img]: https://img.shields.io/badge/cite-arXiv%3A2504.21440_(2023)-blue
28+
[cite-url]: https://doi.org/10.48550/arXiv.2504.21440
2929

3030
[download-img]: https://img.shields.io/badge/dynamic/json?url=http%3A%2F%2Fjuliapkgstats.com%2Fapi%2Fv1%2Ftotal_downloads%2FQuantumToolbox&query=total_requests&label=Downloads
3131
[download-url]: https://juliapkgstats.com/pkg/QuantumToolbox
@@ -177,6 +177,23 @@ You are most welcome to contribute to `QuantumToolbox.jl` development by forking
177177

178178
For more information about contribution, including technical advice, please see the [Contributing to Quantum Toolbox in Julia](https://qutip.org/QuantumToolbox.jl/stable/resources/contributing).
179179

180+
## Cite `QuantumToolbox.jl`
181+
If you like `QuantumToolbox.jl`, we would appreciate it if you starred the repository in order to help us increase its visibility. Furthermore, if you find the framework useful in your research, we would be grateful if you could cite our arXiv preprint [ [arXiv:2504.21440 (2025)](https://doi.org/10.48550/arXiv.2504.21440) ] using the following bibtex entry:
182+
183+
```bib
184+
@article{QuantumToolbox-jl2025,
185+
title={{QuantumToolbox.jl}: An efficient {Julia} framework for simulating open quantum systems},
186+
author={Mercurio, Alberto and Huang, Yi-Te and Cai, Li-Xun and Chen, Yueh-Nan and Savona, Vincenzo and Nori, Franco},
187+
journal={arXiv preprint arXiv:2504.21440},
188+
year={2025},
189+
publisher = {arXiv},
190+
eprint={2504.21440},
191+
archivePrefix={arXiv},
192+
primaryClass={quant-ph},
193+
doi = {10.48550/arXiv.2504.21440}
194+
}
195+
```
196+
180197
## Acknowledgements
181198

182199
### Fundings

docs/make.jl

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -42,7 +42,7 @@ const PAGES = [
4242
# "Key differences from QuTiP" => "getting_started/qutip_differences.md",
4343
"The Importance of Type-Stability" => "getting_started/type_stability.md",
4444
"Example: Create QuantumToolbox.jl Logo" => "getting_started/logo.md",
45-
# "Cite QuantumToolbox.jl" => "getting_started/cite.md",
45+
"Cite QuantumToolbox.jl" => "getting_started/cite.md",
4646
],
4747
"Users Guide" => [
4848
"Basic Operations on Quantum Objects" => [

docs/src/getting_started/cite.md

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
# [Cite QuantumToolbox.jl](@id doc:Cite)
2+
3+
If you like `QuantumToolbox.jl`, we would appreciate it if you could cite our arXiv preprint [ [arXiv:2504.21440 (2025)](https://doi.org/10.48550/arXiv.2504.21440) ] using the following bibtex entry:
4+
5+
```bib
6+
@article{QuantumToolbox-jl2025,
7+
title={{QuantumToolbox.jl}: An efficient {Julia} framework for simulating open quantum systems},
8+
author={Mercurio, Alberto and Huang, Yi-Te and Cai, Li-Xun and Chen, Yueh-Nan and Savona, Vincenzo and Nori, Franco},
9+
journal={arXiv preprint arXiv:2504.21440},
10+
year={2025},
11+
publisher = {arXiv},
12+
eprint={2504.21440},
13+
archivePrefix={arXiv},
14+
primaryClass={quant-ph},
15+
doi = {10.48550/arXiv.2504.21440}
16+
}
17+
```

docs/src/index.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -22,6 +22,9 @@ hero:
2222
- theme: alt
2323
text: API
2424
link: /resources/api
25+
- theme: alt
26+
text: Cite us
27+
link: /getting_started/cite
2528
- theme: alt
2629
text: View on Github
2730
link: https://github.com/qutip/QuantumToolbox.jl

0 commit comments

Comments
 (0)