Skip to content

Commit 06a2a37

Browse files
authored
Update README.md
1 parent 7d86c1f commit 06a2a37

File tree

1 file changed

+52
-0
lines changed

1 file changed

+52
-0
lines changed

README.md

Lines changed: 52 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -70,6 +70,58 @@ We also provide two math solver modules:
7070

7171
In the future, we plan to add more protocols. We also welcome custom-defined protocols and solver modules.
7272

73+
## Citing
74+
75+
If you use Open QKD Security in research, please cite our software and write in your document something like
76+
```
77+
To calculate the key rate for protocol "X" we used the Open QKD Security package[#].
78+
```
79+
80+
Here is a bibtex entry you can use:
81+
```bib
82+
@software{burniston_2024_14262569,
83+
author = {Burniston, John and
84+
Wang, Wenyuan and
85+
Kamin, Lars and
86+
Lin, Jie and
87+
Coles, Patrick and
88+
Metodiev, Eric and
89+
George, Ian and
90+
Li, Nicky Kai Hong and
91+
Fang, Kun and
92+
Chemtov, Max and
93+
Zhang, Yanbao and
94+
Böhm, Christopher and
95+
Winick, Adam and
96+
van Himbeeck, Thomas and
97+
Johnstun, Scott and
98+
Nahar, Shlok and
99+
Tupkary, Devashish and
100+
Pan, Shihong and
101+
Wang, Zhiyao and
102+
Corrigan, Aodhan and
103+
Kanitschar, Florian and
104+
Gracie, Laura and
105+
Gu, Shouzhen and
106+
Mathur, Natansh and
107+
Upadhyaya, Twesh and
108+
Lutkenhaus, Norbert},
109+
title = {Open {QKD} {S}ecurity: {V}ersion 2.0.2},
110+
month = dec,
111+
year = 2024,
112+
publisher = {Zenodo},
113+
version = {v2.0.2},
114+
doi = {10.5281/zenodo.14262569},
115+
url = {https://doi.org/10.5281/zenodo.14262569}
116+
swhid = {swh:1:dir:ce63165f716a15a425fbadc208e27934cc66be10
117+
;origin=https://doi.org/10.5281/zenodo.14262568;vi
118+
sit=swh:1:snp:ea6ece4519d009abf5ae6b7c084f97ba9d3f
119+
14c2;anchor=swh:1:rel:54e7860c1d1e613f2e7a075653d1
120+
2fa44f1226fa;path=/
121+
},
122+
}
123+
```
124+
73125
## Contributing
74126

75127

0 commit comments

Comments
 (0)