.. _api_reference:

API reference
=============

This is a complete api reference to the PIVPy package.

The ``pivpy.io`` module
----------------------------------
.. automodule:: pivpy.io
    :members:

The ``pivpy.compute_funcs`` module
----------------------------------
.. automodule:: pivpy.compute_funcs
    :members:

The ``pivpy.pivmat_compat`` module
----------------------------------
.. automodule:: pivpy.pivmat_compat
    :members:

The ``pivpy.update`` module
---------------------------
.. automodule:: pivpy.update
    :members:

The ``pivpy.graphics`` module
-----------------------------
.. automodule:: pivpy.graphics
    :members:  
   
The ``pivpy.pivpy`` module
----------------------------------
.. automodule:: pivpy.pivpy
    :members:

The ``pivpy.interfacing`` module
----------------------------------
.. automodule:: pivpy.interfacing
    :members:

The ``pivpy.inter`` module (deprecated)
---------------------------------------
.. automodule:: pivpy.inter
    :members: