.. diff_viz documentation master file, created by
   sphinx-quickstart on Tue May 30 16:32:22 2023.
   You can adapt this file completely to your liking, but it should at least
   contain the root `toctree` directive.

Welcome to diff_viz's documentation!
====================================

The goal of this package is to allow researchers working with Multiple Particle Tracking (MPT) data 
to quickly generate informative data visualizations.

Specifically, this package will enable users to:

- Automatically generate plots for exploratory data analysis

- Create publication-worthy plots

- Build on template plots to create visualizations for new use cases

.. toctree::
   :maxdepth: 2
   :hidden:
   :caption: Contents:

   Modules/data_loading
   Modules/diffusion_modes
   Modules/msd
   Modules/feature_distribution_plots
   Modules/utils


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

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