.. DICpy documentation master file, created by
   sphinx-quickstart on Thu Aug 26 15:15:26 2021.
   You can adapt this file completely to your liking, but it should at least
   contain the root `toctree` directive.

Welcome to DICpy's documentation!
=================================

DICpy is a open-source Python toolbox for perfoming digital image correlation (DIC). 
The code is a collection of modules implementing several algorithms used in DIC, including
subpixel resolution, optical flow, and more.

.. _toc:

Table of contents
-----------------

.. toctree::
   :maxdepth: 2
	
   introduction_doc
   DIC_2D_doc
   math4dic_doc
   utils_doc
   installation_doc

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