Skip to content

This is our central repository, holding only the community approved code and documentation

License

Notifications You must be signed in to change notification settings

OpenPTV/openptv

Repository files navigation

OpenPTV - framework for particle tracking velocimetry

Build status DOI

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,

https://groups.google.com/forum/#!forum/openptv

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 documentation on http://openptv-python.readthedocs.io/en/latest/ or respective subdirectories' README files for instructions on installing subpackages.

Basic steps for C library users

cd liboptv
mkdir build & cd build
cmake ../
sudo make install
make verify

Basic steps for Python users

cd py_bind
python setup.py prepare
pip install . 
cd test
pytest

Donations

Please consider donation to support our website and domain expenses and our developers during their job transitions.

paypal