README

OpenPTV - framework for particle tracking velocimetry
=====================================================

This is the code collection of the OpenPTV project - an effort to create
common code for different aspects of the Particle Tracking Velocimetry
method. The code is required to meet the community standards for quality, and
all code here is therefore peer reviewed.

The quality standards are decided upon open discussion on the community 
mailing-list, 

  openptv@googlegroups.com

The peer-review process happens in the open on the same mailing list.


How to help
-----------
To contribute code: fork this repository, build on your fork an orderly branch
with your changes, then create a pull request on Github and inform the mailing
list, or post a patch series to the mailing list. Be prepared to answer 
questions and amend your code to satisfy reviewer comments. Be mindful of the
agreed coding standards (whose URL will be soon updated here).

To follow and participate in the technical discussion: join the mailing list
through Google Groups.


Instalation
-----------
See the respective subdirectories' README files for instructions on installing 
subpackages.