Skip to main content

OpenPIV consists in a Python and Cython modules for scripting and executing the analysis of a set of PIV image pairs. In addition, a Qt and Tk graphical user interfaces are in development, to ease the use for those users who don't have python skills.

Project description

OpenPIV

Build and upload to PyPI DOI PyPI Anaconda

OpenPIV consists in a Python and Cython modules for scripting and executing the analysis of a set of PIV image pairs. In addition, a Qt and Tk graphical user interfaces are in development, to ease the use for those users who don't have python skills.

Warning

The OpenPIV python version is still in its beta state. This means that it still might have some bugs and the API may change. However, testing and contributing is very welcome, especially if you can contribute with new algorithms and features.

Test it without installation

Click the link - thanks to BinderHub, Jupyter and Conda you can now get it in your browser with zero installation: Binder

Installing

Use PyPI: https://pypi.python.org/pypi/OpenPIV:

pip install openpiv

Or conda

conda install -c alexlib openpiv

Or Poetry

poetry add openpiv

To build from source

Download the package from the Github: https://github.com/OpenPIV/openpiv-python/archive/master.zip or clone using git

git clone https://github.com/OpenPIV/openpiv-python.git

Using distutils create a local (in the same directory) compilation of the Cython files:

python setup.py build_ext --inplace

Or for the global installation, use:

python setup.py install 

Documentation

The OpenPIV documentation is available on the project web page at http://openpiv.readthedocs.org

Demo notebooks

  1. Tutorial Notebook 1
  2. Tutorial notebook 2
  3. Dynamic masking tutorial
  4. Multipass with Windows Deformation
  5. Multiple sets in one notebook
  6. 3D PIV

These and many additional examples are in another repository: OpenPIV-Python-Examples

Contributors

  1. Alex Liberzon
  2. Roi Gurka
  3. Zachary J. Taylor
  4. David Lasagna
  5. Mathias Aubert
  6. Pete Bachant
  7. Cameron Dallas
  8. Cecyl Curry
  9. Theo Käufer
  10. Andreas Bauer
  11. David Bohringer
  12. Erich Zimmer
  13. Peter Vennemann
  14. Lento Manickathan
  15. Yuri Ishizawa

Copyright statement: smoothn.py is a Python version of smoothn.m originally created by D. Garcia [https://de.mathworks.com/matlabcentral/fileexchange/25634-smoothn], written by Prof. Lewis and available on Github [https://github.com/profLewis/geogg122/blob/master/Chapter5_Interpolation/python/smoothn.py]. We include a version of it in the openpiv folder for convenience and preservation. We are thankful to the original authors for releasing their work as an open source. OpenPIV license does not relate to this code. Please communicate with the authors regarding their license.

How to cite this work

DOI

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

openpiv-0.25.3.tar.gz (37.9 MB view details)

Uploaded Source

Built Distribution

openpiv-0.25.3-py3-none-any.whl (38.1 MB view details)

Uploaded Python 3

File details

Details for the file openpiv-0.25.3.tar.gz.

File metadata

  • Download URL: openpiv-0.25.3.tar.gz
  • Upload date:
  • Size: 37.9 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.0.0 CPython/3.12.2

File hashes

Hashes for openpiv-0.25.3.tar.gz
Algorithm Hash digest
SHA256 94e7588e897c6a5d64831aa9b906d4a9ed2d37a3ec71d668ba917783ddf1947d
MD5 039f6405130e248eb2fbef0d372a0963
BLAKE2b-256 09e332e0555d878ca6bf8ac2284d6b0195b00e1eabc6a5d8243584fcbbadd0d2

See more details on using hashes here.

File details

Details for the file openpiv-0.25.3-py3-none-any.whl.

File metadata

  • Download URL: openpiv-0.25.3-py3-none-any.whl
  • Upload date:
  • Size: 38.1 MB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.0.0 CPython/3.12.2

File hashes

Hashes for openpiv-0.25.3-py3-none-any.whl
Algorithm Hash digest
SHA256 b7f939a1710a951780c719646394c796370e82ad7694619d7a419653e34735f0
MD5 cbeb4b7d23099276f12a5a6af4d78198
BLAKE2b-256 fba5bc7908ca83c6e83230dade81e063519e528f3bc274f1b0a4ec0beb699461

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