========================
OpenPivGui Documentation
========================

OpenPivGui is a graphical user interface, providing an efficient workflow for evaluating and postprocessing particle image velocimetry (PIV) images. OpenPivGui relies on the Python libraries provided by the `OpenPIV project <http://www.openpiv.net/>`_.

.. figure:: ./fig/open_piv_gui_vector_plot.png
    :alt: Screenshot of the tkinter GUI.
    :figwidth: 80%

    OpenPivGui.

.. toctree::
   :maxdepth: 2

   installation
   usage
   parameters
   contribution
   code_doc
   related

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

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