PIVPy

Python based post-processing PIV data analysis

Merging the three packages:

1. https://github.com/tomerast/Vecpy
2. https://github.com/alexlib/pivpy/tree/xarray
3. https://github.com/ronshnapp/vecpy

How do I get set up?

Use pip:

pip install pivpy[all]

to include also lvpyio if you work with Lavision files

pip install pivpy

if you use OpenPIV, PIVlab, etc.

For developers, local use:

git clone https://github.com/alexlib/pivpy .
cd pivpy
conda create -n pivpy python=3.11
conda activate pivpy
conda install pip
pip install -e .

What packages are required and which are optional

1. lvpyio by Lavision Inc. if you use vc7 files
2. netcdf4 if you want to store NetCDF4 files by xarray
3. pyarrow if you want to store parquet files
4. vortexfitting if you want to do vortex analysis ($\lambda_2$ and $Q$ criterions, vortex fitting)
5. numpy, scipy, matplotlib, xarray are must and installed with the pivpy

Contributors

1. @alexlib
2. @ronshnapp - original steps
3. @liorshig - LVreader and great visualizaiton for Lavision
4. @nepomnyi - connection to VortexFitting and new algorithms

How to get started?

Look into the getting started Jupyter notebook

and additional notebooks: Notebooks

How to test?

From a command line just use:

pip install pytest
pytest

Documentation on Github:

PIVPy on ReadTheDocs

How to help?

Read the ToDo file and pick one item to program. Use Fork-Develop-Pull Request model to contribute

How to write tutorials and add those to the documentation

Using great tutorial http://sphinx-ipynb.readthedocs.org/en/latest/howto.html we now can prepare IPython notebooks (see in /docs/source) and convert those to .rst files, then

python setup.py sphinx-build
sphinx-build -b html docs/source/ docs/build/html

generates docs/build/html directory with the documentation