A GUI for Open PIV

This graphical user interface provides an efficient workflow for evaluating and postprocessing particle image velocimetry (PIV) images. OpenPivGui relies on the Python libraries provided by the OpenPIV project.

Installation

Launching

Usage

Video Tutorial

Documentation

Contribution

Installation

Please note: Depending on your local system replace pip3 by pip or python3 by python'.

You may use Pip to install OpenPivGui:

pip3 install openpivgui

Alternatively, Conda may also work:

conda install -c conda-forge openpivgui

If you get an error about np.int consider this installation workaround:

conda create -n openpivgui python=3.12
conda activate openpivgui
pip install git+https://github.com/alexlib/openpiv-python-0.23.8
pip install git+https://github.com/openpiv/openpiv_tk_gui --upgrade
python -m openpivgui.OpenPivGui

Launching

Launch OpenPivGui by executing:

python3 -m openpivgui.OpenPivGui

Usage

1. Press the button »open directory«. Choose a directory that contains PIV images. Use the »back« or »forward« button to filter the directory content, until there is a list of images in the file list on the right side of the OpenPivGui.
2. To inspect the images, click on the links in the file-list.
3. Walk through the riders, select the desired functions, and edit the corresponding parameters.
4. Press »start processing« to start the evaluation.
5. Inspect the results by clicking on the links in the file-list.
6. Use the »back« and »forward« buttons to inspect intermediate results.
7. Use »dump settings« to document your project. You can recall the settings anytime by pressing »load settings«.

Video tutorial

Learn how to use and extend OpenPivGui watching a less than eight minute video tutorial.

Documentation

Find the detailed documentation on readthedocs.io.

Contribution

Contributions are very welcome! Please follow the step by step guide in the documentation.

Related

Also check out JPIV.