https://github.com/alexlib/pivpy

PIVPy helps to understand PIV results, inspired by PIVMAT
https://github.com/alexlib/pivpy

Last synced: about 2 months ago
JSON representation

PIVPy helps to understand PIV results, inspired by PIVMAT

• Host: GitHub
• URL: https://github.com/alexlib/pivpy
• Owner: alexlib
• License: bsd-3-clause
• Created: 2014-01-03T16:30:49.000Z (almost 11 years ago)
• Default Branch: master
• Last Pushed: 2023-10-22T16:52:59.000Z (about 1 year ago)
• Last Synced: 2024-06-09T12:56:58.151Z (6 months ago)
• Language: Python
• Homepage: http://pivpy.readthedocs.io
• Size: 54 MB
• Stars: 10
• Watchers: 4
• Forks: 8
• Open Issues: 20
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

• awesome_piv - alexlib / pivpy - Python clone of PIVMAT ![python] (5. Post-processing)

README

        


#    PIVPy 

Python based post-processing PIV data analysis

[![PyPI version](https://badge.fury.io/py/pivpy.svg)](https://badge.fury.io/py/pivpy)

[![Documentation Status](https://readthedocs.org/projects/pivpy/badge/?version=latest)](https://pivpy.readthedocs.io/en/latest/?badge=latest)

[![Binder](https://mybinder.org/badge_logo.svg)](https://mybinder.org/v2/gh/alexlib/pivpy/master?filepath=examples%2Fnotebooks%2FGetting_Started.ipynb)

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

    

### What packages are required and which are optional

1. `lvreader` by Lavision 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`

    

### How to get started? 

Look into the [getting started Jupyter notebook](https://github.com/alexlib/pivpy/blob/master/examples/notebooks/Getting_Started.ipynb)

and additional notebooks:

[Notebooks](https://github.com/alexlib/pivpy/blob/master/examples/notebooks/)

### How to test? ### 

From a command line just use:

    pip install pytest

    pytest

    

### Documentation on Github:

[PIVPy on ReadTheDocs](http://pivpy.readthedocs.io)

### 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