.. FitSNAP documentation master file, created by
   sphinx-quickstart on Sun Aug 14 18:25:17 2022.
   You can adapt this file completely to your liking, but it should at least
   contain the root `toctree` directive.

FitSNAP Documentation
=====================

**FitSNAP** is a molecular machine learning package for LAMMPS. 

**Wanna get started ASAP?**  Check out our `Colab Python notebook tutorial <tutorialnotebook_>`_

**GitHub repo:** https://github.com/FitSNAP/FitSNAP

.. _tutorialnotebook: https://colab.research.google.com/github/FitSNAP/FitSNAP/blob/master/tutorial.ipynb

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

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

----------

.. _user_documentation:
.. toctree::
   :maxdepth: 2
   :numbered: 3
   :caption: User Guide
   :name: userdoc
   :includehidden:

   Introduction
   Installation
   Run/index.rst
   Linear
   Pytorch

.. _programmer_documentation:
.. toctree::
   :maxdepth: 2
   :numbered: 3
   :caption: Programmer Guide
   :name: progdoc
   :includehidden:

   Contributing
   Executable
   Lib/index.rst
   Tests