Skip to content
Draft
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
27 changes: 22 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,6 @@
[![Python package](https://github.com/OpenPIV/openpiv-python/actions/workflows/testing.yml/badge.svg)](https://github.com/OpenPIV/openpiv-python/actions/workflows/testing.yml)
[![DOI](https://zenodo.org/badge/DOI/10.5281/zenodo.4409178.svg)](https://doi.org/10.5281/zenodo.4409178)
![PyPI](https://img.shields.io/pypi/v/openpiv)
![Anaconda](https://anaconda.org/openpiv/openpiv/badges/version.svg)


OpenPIV consists in a Python and Cython modules for scripting and executing the analysis of
Expand All @@ -25,18 +24,36 @@ Click the link - thanks to BinderHub, Jupyter and Conda you can now get it in yo

## Installing

### Recommended: Using uv (fastest)

[uv](https://github.com/astral-sh/uv) is a fast Python package installer and resolver written in Rust:

pip install uv
uv pip install openpiv

### Using pip (standard)

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

pip install openpiv

### Or [Poetry](https://python-poetry.org/)

## Or `conda`
poetry add openpiv

conda install -c openpiv openpiv
### Note on Conda/Anaconda

## Or [Poetry](https://python-poetry.org/)
⚠️ **Conda packages are no longer actively maintained.** The conda-forge package may be outdated.

poetry add openpiv
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


### To build from source
Expand Down
35 changes: 27 additions & 8 deletions openpiv/docs/src/installation_instruction.rst
Original file line number Diff line number Diff line change
Expand Up @@ -19,23 +19,42 @@ The dependencies are:
* `Python <http://python.org/>`_
* `Scipy <http://numpy.scipy.org/>`_
* `Numpy <http://www.scipy.org/>`_
* `scikit-image <http://scikit-image.org/>`_

On all platforms, the following Python distribution is recommended:

* Anaconda <https://store.continuum.io/cshop/anaconda/>
* `scikit-image <http://scikit-image.org/>`_


Installation
============

Use `conda` ::
Recommended: Use `uv` (fastest)
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

`uv <https://github.com/astral-sh/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::

conda install -c alexlib openpiv
pip install uv
uv pip install openpiv

Or use `pip` ::
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!
========================
Expand Down