This repository contains Python implementations of two algorithms that allow a (numerical) calculation of the secrecy capacity of wiretap channels.
The two algorithms are taken from the following publications:
You can install the package via pip
pip install secrecy-capacityIf you want to install the latest version, you can install the package from source
git clone https://github.com/klb2/secrecy-capacity-calculation.git
cd secrecy_capacity
git checkout dev # only if you want to unstable version
pip install .Some examples are provided in the examples/ directory.
You can run the code locally or using a service like Binder. If you use Binder,
you do not need a local Python installation and you can simply run the scripts
in your browser.
You can find the documentation with some examples on Read the Docs.
The code has been developed and tested with the following versions
- Python 3.9
- numpy 1.19
- scipy 1.6
- matplotlib 3.3
- Jupyter 1.0
This program is licensed under the GPLv3 license. If you in any way use this code for research that results in publications, please cite the original articles listed above and this repository.
You can use the following BibTeX entry for this repository
@online{BesserSecrecyCapacityCalculation,
author = {Besser, Karl-Ludwig},
title = {Algorithms to calculate the secrecy capacity},
subtitle = {Python Implementation},
year = {2021},
url = {https://github.com/klb2/secrecy-capacity-calculation},
version = {0.1.0},
}