.. SimQN documentation master file, created by
   sphinx-quickstart on Mon Sep 13 11:28:47 2021.
   You can adapt this file completely to your liking, but it should at least
   contain the root `toctree` directive.

Welcome to SimQN's documentation!
=======================================

Welcome to SimQN's documentation. SimQN is a discrete-event based network simulation platform for quantum networks.
SimQN enables large-scale investigations, including QKD protocols, entanglement distributions protocols, and routing algorithms in quantum networks.

SimQN can be accelerated with Cython.

Get Help
---------------------------------------

Having trouble? We’d like to help!

- This `documentation <https://ertuil.github.io/SimQN/>`_ many answer most questions.
- Try the :ref:`modindex` or :ref:`genindex` the detailed table of contents.
- Welcome to report bugs at `Github <https://github.com/ertuil/SimQN>`_.

.. toctree::
   :maxdepth: 2
   :caption: Users' Guide:

   introduction
   install
   tutorials
   develop
   modules