=======
Warning
=======
The OpenPIV python version is currently in alpha state. This means that
it is buggy, untested and the API may change. However testing and contributing
is very welcome, especially if you can contribute with new algorithms and features.

Development is currently done on a Linux/Mac OSX environment, but as soon as possible 
Windows will be tested. If you have access to one of these platforms
please test the code. 


=======
OpenPIV
=======
OpenPIV consists in a python module for scripting and executing the analysis of 
a set of PIV image pairs. In addition, a Qt graphical user interface is in 
development, to ease the use for those users who don't have python skills.


=======
Install
=======
Installation instructions for various platforms can be found at http://www.openpiv.net/openpiv-python/

Basically we use distutils:

>>> python setup.py build

should work 


=============
Documentation
=============

The OpenPiv documentation is available on the project web page at http://www.openpiv.net/openpiv-python/