.. nearl documentation master file, created by
   sphinx-quickstart on Tue Mar 12 13:34:54 2024.
   You can adapt this file completely to your liking, but it should at least
   contain the root `toctree` directive.

Welcome to Nearl's documentation!
=================================

.. Include the README page 
.. include:: ../../README.rst
.. .. include:: installation.rst

   .. install_prereq
   .. install_steps
   .. install_valid

.. toctree::
   :maxdepth: 2
   :caption: Get started

   installation
   quick_start
   intro_visual
   intro_dynfeat

.. TODO: Add back this section after the publication of the paper
.. tutorial3
.. tutorial4
.. tutorial5
.. tutorial6

.. toctree::
   :maxdepth: 2
   :caption: Tutorials
   
   tutorial1
   tutorial2 
   tutorial_tba


.. toctree::
   :maxdepth: 0
   :caption: API Reference
   
   modules_features
   modules_featurizer
   modules_traj
   modules_trajloader
   modules_commands


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

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