.. Information Reconciliation Library for CV-QKD Systems documentation master file, created by
   sphinx-quickstart on Mon Jun 10 10:43:31 2024.
   You can adapt this file completely to your liking, but it should at least
   contain the root `toctree` directive.

Information Reconciliation Library for CV-QKD Systems
=================================================================================

+++++++++++++++++++++++++++++++++++++++++++++
Overview
+++++++++++++++++++++++++++++++++++++++++++++

Welcome to the official documentation for the Information Reconciliation Library for Continuous-Variable Quantum Key Distribution (CV-QKD) Systems. This comprehensive library provides a suite of tools designed for reconciling measured states in CV-QKD systems.

Developed in C++, this library offers a robust set of utilities to facilitate the reconciliation process. Its versatile design allows for integration across multiple platforms:

* Direct implementation in C++
* Python integration via provided bindings
* MATLAB compatibility through Python bindings


+++++++++++++++++++++++++++++++++
Detailed Documentation
+++++++++++++++++++++++++++++++++

For in-depth information on each component of the library, please refer to the following sections:

.. toctree::
   :maxdepth: 2

   Installation
   reconciliation
   utilities
   examples


+++++++++++++++++++++++++++++++
Indices and Reference
+++++++++++++++++++++++++++++++

* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`