An open API service indexing awesome lists of open source software.

https://github.com/openptv/openptv

This is our central repository, holding only the community approved code and documentation
https://github.com/openptv/openptv

Last synced: about 1 month ago
JSON representation

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

Awesome Lists containing this project

README

        

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

![Build status](https://github.com/openptv/openptv/actions/workflows/main.yml/badge.svg)
[![DOI](https://zenodo.org/badge/6985516.svg)](https://zenodo.org/badge/latestdoi/6985516)

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 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](https://www.paypalobjects.com/en_US/i/btn/btn_donateCC_LG.gif)](https://www.paypal.com/cgi-bin/webscr?cmd=_s-xclick&hosted_button_id=RK3FHXTCJDSWL)