.. |almos_banner| image:: ../almos/icons/almos_logo.png

|almos_banner|

.. include:: README.rst
   :start-after: badges-start
   :end-before: badges-end

.. _github: https://github.com/MiguelMartzFdez/almos

.. include:: README.rst
   :start-after: checkboxes-start
   :end-before: checkboxes-end

================================

Welcome to ALMOS's documentation!
================================

.. include:: README.rst
   :start-after: introduction-start
   :end-before: introduction-end


.. toctree::
   :maxdepth: 1
   :caption: Installation and interface

   Install/installation
   Install/note
   Install/gui

.. toctree::
   :maxdepth: 1
   :caption: How does ALMOS work?
   
   Modules/cluster
   Modules/el
   Modules/bo


.. include:: README.rst
   :start-after: reference-start
   :end-before: reference-end


.. .. toctree::
..    :maxdepth: 2
..    :caption: Examples

..    Examples/full_workflow/full_workflow
..    Examples/full_workflow/full_workflow_test
..    Examples/full_workflow/smiles_workflow
..    Examples/full_workflow/smiles_vaskas
..    Examples/modules/modules

.. .. toctree:: 
..    :maxdepth: 1
..    :caption: Video Tutorials

..    Videos/video_tutorials

.. toctree:: 
   :maxdepth: 1
   :caption: Technical Details

   Technical/defaults
   Technical/requirements
   Technical/tests
   Technical/development

.. toctree:: 
   :caption: API Reference
   :maxdepth: 1

   API/API_Reference.rst

.. toctree::
   :maxdepth: 2
   :caption: Misc

   Misc/abbreviations
   Misc/versions
   Misc/license
   Misc/help