Skip to content

Commit 1818d06

Browse files
committed
README: Add uv installation instructions
1 parent e0ad181 commit 1818d06

1 file changed

Lines changed: 56 additions & 5 deletions

File tree

README.rst

Lines changed: 56 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -45,8 +45,45 @@ please `cite <https://doi.org/10.5281/zenodo.4604495>`_ the software.
4545
Installation
4646
------------
4747

48-
Using anaconda (recommended)
49-
^^^^^^^^^^^^^^^^^^^^^^^^^^^^
48+
Using uv (recommended)
49+
^^^^^^^^^^^^^^^^^^^^^^
50+
51+
- Install ``uv`` according to the `official instructions <https://docs.astral.sh/uv/getting-started/installation/>`_
52+
or using e.g. your Linux distribution's package manager.
53+
- Create a folder for your project.
54+
- Inside this folder, run
55+
56+
::
57+
58+
uv init
59+
60+
in a console prompt to create a new project. See the
61+
`official guide <https://docs.astral.sh/uv/guides/projects/>`_ for more information.
62+
- Add `sdt-python` and optional dependencies by running
63+
64+
::
65+
66+
uv add sdt-python
67+
uv add opencv trackpy lmfit ipympl scikit-learn pyqt
68+
69+
- Start the python interpreter by executing
70+
71+
::
72+
73+
uv run python
74+
75+
or Jupyter Lab by executing
76+
77+
::
78+
79+
uv run --with jupyter jupyter lab
80+
81+
(see the `official documentation <https://docs.astral.sh/uv/guides/integration/jupyter/>`_
82+
for details).
83+
84+
85+
Using anaconda
86+
^^^^^^^^^^^^^^
5087

5188
Choose one of the three following options.
5289

@@ -122,6 +159,20 @@ Install some Python distribution and run (possibly in a virtual environment)
122159
Updating
123160
--------
124161

162+
If using uv, execute
163+
164+
::
165+
166+
uv sync -P sdt-python
167+
168+
to update only `sdt-python` or
169+
170+
::
171+
172+
uv sync -U
173+
174+
to update everything.
175+
125176
If the conda installation was converted to `conda forge`, type
126177

127178
::
@@ -150,10 +201,10 @@ If `pip` is used, run
150201
Requirements
151202
------------
152203

153-
- Python >= 3.9
204+
- Python >= 3.10
154205
- matplotlib
155-
- numpy >= 1.10
156-
- pandas
206+
- numpy >= 2.1
207+
- pandas >= 2.2.3
157208
- imageio >= 2.29
158209
- tifffile >= 0.7.0
159210
- pyyaml

0 commit comments

Comments
 (0)