================================
OpenPIV-Python-cxx Documentation
================================

OpenPIV-Python-cxx consists of Python and c++ modules for scipting and executing the analysis of a set of partivle image velocimetry (PIV) image pairs. Additionally, preprocessing and post-processing modules are included to help aid users in extracting as much information as possible from PIV images.

Table of Contents
=================

.. toctree::
   :maxdepth: 2
   :caption: Getting Started

   getting_started/introduction
   getting_started/installation

.. toctree::
   :maxdepth: 2
   :caption: API

   modules/interpolate
   modules/filters
   modules/process
   modules/tools
   modules/validate
   modules/windef

.. toctree::
   :maxdepth: 2
   :caption: Reference

   reference/contribution


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

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