Skip to content

Commit 8fc9414

Browse files
authored
Merge pull request #355 from OpenPIV/copilot/remove-conda-installation-instructions
Remove conda installation instructions and promote uv as primary method
2 parents 649a3d4 + 725b3d6 commit 8fc9414

File tree

2 files changed

+49
-13
lines changed

2 files changed

+49
-13
lines changed

README.md

Lines changed: 22 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,6 @@
22
[![Python package](https://github.com/OpenPIV/openpiv-python/actions/workflows/testing.yml/badge.svg)](https://github.com/OpenPIV/openpiv-python/actions/workflows/testing.yml)
33
[![DOI](https://zenodo.org/badge/DOI/10.5281/zenodo.18304582.svg)](https://doi.org/10.5281/zenodo.18304582)
44
![PyPI](https://img.shields.io/pypi/v/openpiv)
5-
![Anaconda](https://anaconda.org/openpiv/openpiv/badges/version.svg)
65

76

87
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
2524

2625
## Installing
2726

27+
### Recommended: Using uv (fastest)
28+
29+
[uv](https://github.com/astral-sh/uv) is a fast Python package installer and resolver written in Rust:
30+
31+
pip install uv
32+
uv pip install openpiv
33+
34+
### Using pip (standard)
35+
2836
Use PyPI: <https://pypi.python.org/pypi/OpenPIV>:
2937

3038
pip install openpiv
3139

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

33-
## Or `conda`
42+
poetry add openpiv
3443

35-
conda install -c openpiv openpiv
44+
### Note on Conda/Anaconda
3645

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

39-
poetry add openpiv
48+
If you previously installed OpenPIV via conda, you can migrate to pip or uv:
49+
50+
# Remove the conda package
51+
conda remove openpiv
52+
53+
# Install with pip or uv
54+
pip install openpiv
55+
# or
56+
uv pip install openpiv
4057

4158

4259
### To build from source

openpiv/docs/src/installation_instruction.rst

Lines changed: 27 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -19,23 +19,42 @@ The dependencies are:
1919
* `Python <http://python.org/>`_
2020
* `Scipy <http://numpy.scipy.org/>`_
2121
* `Numpy <http://www.scipy.org/>`_
22-
* `scikit-image <http://scikit-image.org/>`_
23-
24-
On all platforms, the following Python distribution is recommended:
25-
26-
* Anaconda <https://store.continuum.io/cshop/anaconda/>
22+
* `scikit-image <http://scikit-image.org/>`_
2723

2824

2925
Installation
3026
============
3127

32-
Use `conda` ::
28+
Recommended: Use `uv` (fastest)
29+
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
30+
31+
`uv <https://github.com/astral-sh/uv>`_ is a fast Python package installer and resolver written in Rust.
32+
It provides faster and more reliable package installation compared to traditional tools.
33+
34+
To install OpenPIV with uv::
3335

34-
conda install -c alexlib openpiv
36+
pip install uv
37+
uv pip install openpiv
3538

36-
Or use `pip` ::
39+
Or use `pip` (standard)
40+
^^^^^^^^^^^^^^^^^^^^^^^^
41+
42+
::
3743

3844
pip install openpiv
45+
46+
.. warning::
47+
**Conda packages are no longer actively maintained.** The conda-forge package may be outdated.
48+
49+
If you previously installed OpenPIV via conda, you can migrate to pip or uv::
50+
51+
# Remove the conda package
52+
conda remove openpiv
53+
54+
# Install with pip or uv
55+
pip install openpiv
56+
# or
57+
uv pip install openpiv
3958
4059
Get OpenPIV source code!
4160
========================

0 commit comments

Comments
 (0)