Skip to main content

Python package for post-processing PIV results

Project description

PIVPy PIVPy

Python based post-processing PIV data analysis

PyPI version Documentation Status Binder

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

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

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

pivpy-0.0.20.tar.gz (5.1 MB view details)

Uploaded Source

Built Distribution

pivpy-0.0.20-py3-none-any.whl (5.1 MB view details)

Uploaded Python 3

File details

Details for the file pivpy-0.0.20.tar.gz.

File metadata

  • Download URL: pivpy-0.0.20.tar.gz
  • Upload date:
  • Size: 5.1 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.1.1 CPython/3.9.19

File hashes

Hashes for pivpy-0.0.20.tar.gz
Algorithm Hash digest
SHA256 481a8be24a02d21aa692dc0337ce70b63f7ac3a1e070a8c3750f4362e256b835
MD5 3030b8a1f52258f6d6d1a176427bf3c1
BLAKE2b-256 9967a470afa79b961e01354b1afd019b50b21a73875aa271b1dadeab7ddea426

See more details on using hashes here.

File details

Details for the file pivpy-0.0.20-py3-none-any.whl.

File metadata

  • Download URL: pivpy-0.0.20-py3-none-any.whl
  • Upload date:
  • Size: 5.1 MB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.1.1 CPython/3.9.19

File hashes

Hashes for pivpy-0.0.20-py3-none-any.whl
Algorithm Hash digest
SHA256 b9c978840a2eaeabaa5536571180902a553b5d7918187fe59cd6011159012300
MD5 9a29ad7e98275993da4246999651cf21
BLAKE2b-256 93d25c6dd9e651784b56e33f5f06c966948d4d5c11ff2eafbd8c545663f34fdb

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page