communication.qkd_key_rate
Python code to compute optimal protocol parameters for different QKD protocols.
Science Score: 57.0%
This score indicates how likely this project is to be science-related based on various indicators:
-
✓CITATION.cff file
Found CITATION.cff file -
✓codemeta.json file
Found codemeta.json file -
✓.zenodo.json file
Found .zenodo.json file -
✓DOI references
Found 4 DOI reference(s) in README -
○Academic publication links
-
○Academic email domains
-
○Institutional organization owner
-
○JOSS paper metadata
-
○Scientific vocabulary similarity
Low similarity (9.8%) to scientific vocabulary
Keywords
Repository
Python code to compute optimal protocol parameters for different QKD protocols.
Basic Info
- Host: GitHub
- Owner: TNO-Quantum
- License: apache-2.0
- Language: Python
- Default Branch: main
- Homepage: https://tno-quantum.github.io/documentation/
- Size: 3.51 MB
Statistics
- Stars: 12
- Watchers: 1
- Forks: 2
- Open Issues: 1
- Releases: 2
Topics
Metadata Files
README.md
TNO-Quantum: QKD key-rate
TNO Quantum provides generic software components aimed at facilitating the development of quantum applications.
The tno.quantum.communication.qkd_key_rate package provides python code to compute optimal protocol parameters for different quantum key distribution (QKD) protocols.
The codebase is based on the following papers:
- Attema et al. - Optimizing the decoy-state BB84 QKD protocol parameters (2021)
- Ma et al. - Quantum key distribution with entangled photon sources (2007)
The following quantum protocols are supported:
- BB84 protocol,
- BB84 protocol using a single photon source,
- BBM92 protocol.
The following classical error-correction protocols are supported:
- Cascade,
- Winnow.
The presented code can be used to
- determine optimal parameter settings needed to obtain the maximum key rate,
- correct errors in exchanged sifted keys for the different QKD protocols,
- apply privacy amplification by calculating secure key using hash function.
Documentation
Documentation of the tno.quantum.communication.qkd_key_rate package can be found here.
The documentation contains usage examples that show
How to compute the secure key-rate for various protocols as function of the loss.

How to compute secure key-rate using the finite key-rate protocol for different number of pulses.

Install
Easily install the tno.quantum.communication.qkd_key_rate package using pip:
console
$ python -m pip install tno.quantum.communication.qkd_key_rate
If you wish to run the tests you can use:
console
$ python -m pip install tno.quantum.communication.qkd_key_rate[tests]
(End)use limitations
The content of this software may solely be used for applications that comply with international export control laws.
Owner
- Name: TNO - Quantum
- Login: TNO-Quantum
- Kind: organization
- Email: tnoquantum@tno.nl
- Location: Netherlands
- Twitter: TNO_Research
- Repositories: 2
- Profile: https://github.com/TNO-Quantum
Citation (CITATION.cff)
cff-version: 1.2.0
license: Apache-2.0
message: If you use this software, please cite it using these metadata.
authors:
- name: TNO Quantum
city: The Hague
country: NL
email: tnoquantum@tno.nl
website: https://tno.nl
type: software
url: https://tno.nl
contact:
- name: TNO Quantum
city: The Hague
country: NL
email: tnoquantum@tno.nl
website: https://tno.nl
repository-code: https://github.com/TNO-Quantum/communication.qkd_key_rate
repository-artifact: https://pypi.org/project/tno.quantum.communication.qkd_key_rate
title: TNO Quantum - Communication - QKD Key Rate
version: v2.0.2
date-released: 2025-07-03
GitHub Events
Total
- Create event: 2
- Release event: 1
- Issues event: 5
- Watch event: 3
- Delete event: 1
- Issue comment event: 5
- Push event: 4
Last Year
- Create event: 2
- Release event: 1
- Issues event: 5
- Watch event: 3
- Delete event: 1
- Issue comment event: 5
- Push event: 4
Issues and Pull Requests
Last synced: 10 months ago
All Time
- Total issues: 3
- Total pull requests: 0
- Average time to close issues: 5 months
- Average time to close pull requests: N/A
- Total issue authors: 3
- Total pull request authors: 0
- Average comments per issue: 1.33
- Average comments per pull request: 0
- Merged pull requests: 0
- Bot issues: 0
- Bot pull requests: 0
Past Year
- Issues: 3
- Pull requests: 0
- Average time to close issues: 5 months
- Average time to close pull requests: N/A
- Issue authors: 3
- Pull request authors: 0
- Average comments per issue: 1.33
- Average comments per pull request: 0
- Merged pull requests: 0
- Bot issues: 0
- Bot pull requests: 0
Top Authors
Issue Authors
- fjlc-73 (1)
- AlessandroAmadoriTNO (1)
- amartin-m (1)