PIVPy¶
Python based post-processing PIV data analysis
Merging the three packages:
https://github.com/tomerast/Vecpy
https://github.com/alexlib/pivpy/tree/xarray
https://github.com/ronshnapp/vecpy
How do I get set up?¶
Use pip
:
pip install pivpy
What packages are required and which are optional¶
lvreader
by Lavision if you use vc7 filesnetcdf4
if you want to store NetCDF4 files by xarraypyarrow
if you want to store parquet filesnumpy
,scipy
,matplotlib
,xarray
are must and installed with thepivpy
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:¶
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