DPIVSoft documentation
======================

Open, vendor-neutral, GPU-accelerated classical PIV (Particle Image
Velocimetry). The documentation has three layers: the **User guide** gets you
from installation to a first (stereo) measurement; the **Theory** pages
explain the implemented methods -- the PIV algorithm, its OpenCL
parallelisation, stereo calibration and 3C reconstruction, and
vorticity-based force estimation -- with their derivations and practical
notes; the **API reference** is generated directly from the NumPy-style
docstrings in the source, so editing a docstring and rebuilding updates the
corresponding page.

.. toctree::
   :maxdepth: 2
   :caption: User guide

   getting_started
   stereo_workflow

.. toctree::
   :maxdepth: 2
   :caption: Theory

   piv_algorithm
   opencl_implementation
   stereo_calibration_mapping
   forces_theory

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

   api/DPIV
   api/Cl_DPIV
   api/Classes
   api/Postprocessing
   api/SyIm
   api/stereo_DPIV
   api/stereo_gui
   api/meshTools

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

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