.. opticomlib documentation master file, created by
   sphinx-quickstart on Fri Jan 26 15:16:45 2024.
   You can adapt this file completely to your liking, but it should at least
   contain the root `toctree` directive.

Welcome to opticomlib's documentation!
======================================

**OptiComLib** is a Python library for optical communication systems,
using coherent and direct detection modulation formats. It provides open 
source code for easy implementation of optical links. 
The project is hosted on `GitHub <https://github.com/armando-palacio/opticomlib.git>`_.


.. note:: 
   This project (and documentation) is under active development.


.. toctree::
   :caption: Reference
   
   usage

.. toctree:: 
   :maxdepth: 2
   :caption: OptiComLib Documentation

   types
   devices
   ook
   ppm
   lab
   utils

Indices and tables
==================

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