Getting started

How to get started with OpenPIV:

You can run OpenPIV online without installation:

Use Google Colab project and import one of the OpenPIV Python notebooks

https://colab.research.google.com/notebook#create=true&language=python3

Or click the launch binder button to get a fully running cloud for you thanks to Jupyter and Mybinder

https://github.com/alexlib/openpiv-python-example

You can download and install it locally on Python 3, using pip or conda:

pip install openpiv

or

conda install -c conda-forge openpiv

If you are interested in the TK GUI, follow the instructions on https://github.com/OpenPIV/openpiv_tk_gui

Getting started screencasts and tutorials

  1. Python - http://www.openpiv.net/openpiv-python/
  2. Documentation : https://openpiv.readthedocs.io/
  3. Tutorial: https://openpiv.readthedocs.io/en/latest/src/tutorial1.html
  4. Zero installation online demo: https://github.com/OpenPIV/openpiv-python-example
  5. Multiple notebooks of tests and extended options: https://github.com/OpenPIV/openpiv-python-examples/tree/main/notebooks
  6. Learn how to use and extend OpenPivGui https://video.fh-muenster.de/Panopto/Pages/Viewer.aspx?id=309dccc2-af58-44e0-8cd3-ab9500c5b7f4

Support and documentation

How to get support? Where to ask questions? Use one of the following:

  1. Use our mailing list https://groups.google.com/forum/?hl=en#!forum/openpiv-users
  2. E-mail to openpiv2008@gmail.com
  3. Comment on the Github repository or open an issue on Github, for instance https://github.com/OpenPIV/openpiv-python/issues

How do we help our users

We typically answer very quickly on our mailing list. Users that have difficulty to read images or process it, send e-mails like this one:

`Dear Sir/Madam,

I am not being able to load images at all. Everytime I try to load an image tif/bmp/etc... I hear a error sound on my mac and thats it.
Any advice?`

We usually suggest to have an example pair of your images.

see the screencast http://youtu.be/yg-LjAt-v3Q or read the tutorial by Sergio Bengoechea Lozano, TU Berlin [[https://github.com/OpenPIV/openpiv.github.com/wiki/Tutorial_OpenPIV.pdf]]