Skip to content

Commit 3c07421

Browse files
committed
Updated installation instructions to support pixi/uv
1 parent fc0b565 commit 3c07421

File tree

2 files changed

+44
-7
lines changed

2 files changed

+44
-7
lines changed

README.rst

Lines changed: 14 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -200,18 +200,30 @@ Supported Python and NumPy versions are determined according to the `NEP 29 depr
200200
Where to get it
201201
---------------
202202

203-
Conda install (preferred):
203+
conda:
204204

205205
.. code:: bash
206206
207207
conda install -c conda-forge stumpy
208208
209-
PyPI install, presuming you have numpy, scipy, and numba installed:
209+
pip:
210210

211211
.. code:: bash
212212
213213
python -m pip install stumpy
214214
215+
pixi:
216+
217+
.. code:: bash
218+
219+
pixi add stumpy
220+
221+
uv:
222+
223+
.. code:: bash
224+
225+
uv add stumpy
226+
215227
To install stumpy from source, see the instructions in the `documentation <https://stumpy.readthedocs.io/en/latest/install.html>`__.
216228

217229
-------------

docs/install.rst

Lines changed: 30 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -4,21 +4,32 @@ Installation
44

55
Supported Python and NumPy versions are determined according to the `NEP 29 deprecation policy <https://numpy.org/neps/nep-0029-deprecation_policy.html>`__.
66

7-
Using conda/pip
7+
Where to get it
88
===============
99

10-
Conda install (preferred):
10+
conda:
1111

1212
.. code:: bash
1313
1414
conda install -c conda-forge stumpy
1515
16-
PyPI install with ``pip``:
16+
pip:
1717

1818
.. code:: bash
1919
2020
python -m pip install stumpy
2121
22+
pixi:
23+
24+
.. code:: bash
25+
26+
pixi add stumpy
27+
28+
uv:
29+
30+
.. code:: bash
31+
32+
uv add stumpy
2233
2334
From source
2435
===========
@@ -30,18 +41,32 @@ To install stumpy from source, first clone the source repository:
3041
git clone https://github.com/stumpy-dev/stumpy.git
3142
cd stumpy
3243
33-
Next, you'll need to install the necessary dependencies. For maximum performance (or if you are installing stumpy for the Apple M1 ARM-based chip), it is recommended that you install all dependencies using `conda`:
44+
Next, you'll need to install the necessary dependencies:
45+
46+
conda:
3447

3548
.. code:: bash
3649
3750
conda install -c conda-forge -y numpy scipy numba
3851
39-
Alternatively, but with lower performance, you can also install these dependencies using the requirements.txt file in the root of this repository:
52+
pip:
4053

4154
.. code:: bash
4255
4356
python -m pip install -r requirements.txt
4457
58+
pixi:
59+
60+
.. code:: bash
61+
62+
pixi install
63+
64+
uv:
65+
66+
.. code:: bash
67+
68+
uv sync
69+
4570
Once the dependencies are installed (stay inside of the ``stumpy`` directory), execute:
4671

4772
.. code:: bash

0 commit comments

Comments
 (0)