Metadata-Version: 2.4
Name: information_reconciliation
Version: 1.0.0
Summary: Information Reconciliation Library for Continuous-Variable Quantum Key Distribution Systems
Author-Email: Erdem Eray Cil <erdem.cil@kit.edu>
License-Expression: GPL-3.0-or-later
License-File: LICENSE
Classifier: Programming Language :: Python :: 3
Classifier: Operating System :: OS Independent
Project-URL: Homepage, https://information-reconciliation-for-cv-qkd.readthedocs.io/en/latest/
Project-URL: Issues, https://github.com/erdemeray/IR_for_CVQKD/issues
Requires-Python: >=3.9
Provides-Extra: docs
Requires-Dist: sphinx>=7.0; extra == "docs"
Requires-Dist: breathe>=4.35; extra == "docs"
Requires-Dist: sphinx-rtd-theme>=3.1.0; extra == "docs"
Description-Content-Type: text/markdown

[![build](https://github.com/erdemeray/IR_for_CVQKD/actions/workflows/main.yml/badge.svg)](https://github.com/erdemeray/IR_for_CVQKD/actions/workflows/main.yml) [![Documentation Status](https://readthedocs.org/projects/information-reconciliation-for-cv-qkd/badge/?version=latest)](https://information-reconciliation-for-cv-qkd.readthedocs.io/en/latest/?badge=latest)


# Information Reconciliation Library for CV-QKD Systems

This C++ library provides a comprehensive set of tools for information reconciliation, specifically designed for continuous-variable quantum key distribution (CV-QKD) systems. The library also includes Python bindings, enabling seamless integration with Python and MATLAB environments.

### Documentation

For detailed information on installation, library usage, and implementation details, please refer to our comprehensive documentation: [Library Documentation](https://information-reconciliation-for-cv-qkd.readthedocs.io/).

## Research Article

This library is built upon the principles and methodologies detailed in our associated research article. For a deeper understanding of the library's foundations, we encourage you to review the publication:
[Research Article](https://arxiv.org/abs/2408.00569). 

## Licensing

This project is open-source and distributed under the terms of the GPL-3.0 License. For more details, please see the LICENSE file in the repository.

## Acknowledgements

We gratefully acknowledge the following contributions and support:

- Funding support from the German Federal Ministry of Education and Research (BMBF), grant number 16KISQ056 (DE-QOR).

- The C++ example provided in the library utilizes the [cxx_argp](https://github.com/pboettch/cxx_argp) library for command-line input parsing, which is available under the [LGPL3](https://www.gnu.org/licenses/lgpl-3.0.html) license. 


## Citation:

If you use this library in your research, please cite our work as follows:
```
E. E. Cil and L. Schmalen, "An open-source library for information reconciliation in continuous-variable QKD," *Proc. International Conference on Quantum Cryptography (QCRYPT)*, Vigo, Spain, Sep. 2024
```

For any questions or feedback, please open an issue in the repository or contact the maintainers directly.
