Documentation
=============

**smlmLP**

----

**A python library for Single Molecule Localization Microscopy.**

.. code-block:: text

   Author        : Lancelot PINCET
   Library       : smlmLP
   GitHub        : https://github.com/LancelotPincet/smlmLP
   HTTPS         : https://github.com/LancelotPincet/smlmLP.git
   SSH           : git@github.com:LancelotPincet/smlmLP.git
   PyPI          : https://pypi.org/project/smlmLP
   Docs          : https://smlmLP.readthedocs.io

**smlmLP** is a library written by **Lancelot PINCET**.
The source code can be consulted on its `GitHub repository <https://github.com/LancelotPincet/smlmLP>`_.
However for simply using the features, you can install it in your Python environment using `pip <https://pypi.org/project/smlmLP>`_.
And for information, do not hesitate to consult the `documentation <https://smlmLP.readthedocs.io>`_.

1. New to **smlmLP**? Check out the :doc:`Beginner Guide <beginner_guide>` to get up and running.
2. Want a deeper understanding of key concepts in **smlmLP**? Dive into the :doc:`User Guide <user_guide>` to get an in-depth understanding of the tool.
3. Have a doubt on a syntax in **smlmLP**? Consult the :doc:`Reference Guide <reference_guide>` to have detailed on the library API. 

.. toctree::
   :maxdepth: 1
   :caption: Beginner guide

   what_is
   install
   quicky

.. toctree::
   :maxdepth: 1
   :caption: User guide

   concepts
   features
   tutorials

.. toctree::
   :maxdepth: 1
   :caption: Reference guide

   modules
   routines