From 6c5b9cebd734704d05ced5a387c579ce37335108 Mon Sep 17 00:00:00 2001 From: "copilot-swe-agent[bot]" <198982749+Copilot@users.noreply.github.com> Date: Mon, 19 Jan 2026 19:26:40 +0000 Subject: [PATCH 1/2] Initial plan From 725b3d67e43bbc186d5232606050abd63f930bbe Mon Sep 17 00:00:00 2001 From: "copilot-swe-agent[bot]" <198982749+Copilot@users.noreply.github.com> Date: Mon, 19 Jan 2026 19:29:33 +0000 Subject: [PATCH 2/2] Remove conda/anaconda installation instructions and add uv as recommended method Co-authored-by: alexlib <747110+alexlib@users.noreply.github.com> --- README.md | 27 +++++++++++--- openpiv/docs/src/installation_instruction.rst | 35 ++++++++++++++----- 2 files changed, 49 insertions(+), 13 deletions(-) diff --git a/README.md b/README.md index 68531484..0b2c6a95 100644 --- a/README.md +++ b/README.md @@ -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 @@ -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: : 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 diff --git a/openpiv/docs/src/installation_instruction.rst b/openpiv/docs/src/installation_instruction.rst index 46181ffd..8720c985 100644 --- a/openpiv/docs/src/installation_instruction.rst +++ b/openpiv/docs/src/installation_instruction.rst @@ -19,23 +19,42 @@ The dependencies are: * `Python `_ * `Scipy `_ * `Numpy `_ -* `scikit-image `_ - -On all platforms, the following Python distribution is recommended: - -* Anaconda +* `scikit-image `_ Installation ============ -Use `conda` :: +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:: - 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! ========================