Skip to content

Latest commit

 

History

History
96 lines (60 loc) · 2.76 KB

File metadata and controls

96 lines (60 loc) · 2.76 KB

Installation instruction

Dependencies

OpenPIV would not have been possible if other great open source projects did not exist. We make extensive use of code and tools that other people have created, so you should install them before you can use OpenPIV.

The dependencies are:

Installation

Recommended: Use uv (fastest)

uv is a fast Python package installer and resolver written in Rust. It provides faster and more reliable package installation compared to traditional tools.

To install OpenPIV with uv:

pip install uv
uv pip install openpiv

Or use pip (standard)

pip install openpiv

Warning

Conda packages are no longer actively maintained. The conda-forge package may be outdated.

If you previously installed OpenPIV via conda, you can migrate to pip or uv:

# Remove the conda package
conda remove openpiv

# Install with pip or uv
pip install openpiv
# or
uv pip install openpiv

Get OpenPIV source code!

At this moment the only way to get OpenPIV's source code is using git. Git Git is a distributed revision control system and our code is hosted at GitHub.

Bleeding edge development version

If you are interested in the source code you are welcome to browse out git repository stored at https://github.com/alexlib/openpiv-python. If you want to download the source code on your machine, for testing, you need to set up git on your computer. Please look at http://help.github.com/ which provide extensive help for how to set up git.

To follow the development of OpenPIV, clone our repository with the command:

git clone http://github.com/openpiv/openpiv-python.git

and update from time to time. You can also download a tarball containing everything.

Then add the path where the OpenPIV source are to the PYTHONPATH environment variable, so that OpenPIV module can be imported and used in your programs. Remeber to build the extension with

python setup.py build_ext --inplace

Experience problems?

If you encountered some issues, found difficult to install OpenPIV following these instructions please register and write on our Google groups forum https://groups.google.com/g/openpiv-users , so that we can help you and improve this page!