.. LatticeABC documentation master file, created by
   sphinx-quickstart on Sat Dec  3 19:48:06 2022.
   You can adapt this file completely to your liking, but it should at least
   contain the root `toctree` directive.

Welcome to LatticeABC's documentation!
======================================

This is a simple library designed for lattice data analyis.
The code is still a work in progress and constantly updating, and the
documentation is under construction. It however contains the basic key features
of the library, and it will be updated as the code evolves.
For this reason, the suggested way to get started is to clone the repository 
and start playing with the code, using the documentation as a reference. 
To get started

.. code-block:: bash

   git clone https://github.com/ale-barone/labc.git

and use the folder 'labc/labc' as a normal python module.

You can, however, also install it in the usual way with pip:

.. code-block:: bash

   pip install -e .

.. toctree::
   :maxdepth: 2

   stats
   data

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

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