File tree Expand file tree Collapse file tree
Expand file tree Collapse file tree Original file line number Diff line number Diff line change @@ -45,8 +45,28 @@ please `cite <https://doi.org/10.5281/zenodo.4604495>`_ the software.
4545Installation
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 ``uv init `` in a console prompt to create a new project. See the
55+ `official guide <https://docs.astral.sh/uv/guides/projects/ >`_ for more information.
56+ - Add `sdt-python ` and optional dependencies by running
57+
58+ ::
59+
60+ uv add sdt-python
61+ uv add opencv trackpy lmfit ipympl scikit-learn pyqt
62+
63+ - Start the python interpreter by executing ``uv run python `` or Jupyter Lab by executing
64+ ``uv run --with jupyter jupyter lab `` (see the
65+ `official documentation <https://docs.astral.sh/uv/guides/integration/jupyter/ >`_ for details).
66+
67+
68+ Using anaconda
69+ ^^^^^^^^^^^^^^
5070
5171Choose one of the three following options.
5272
@@ -122,6 +142,20 @@ Install some Python distribution and run (possibly in a virtual environment)
122142Updating
123143--------
124144
145+ If using uv, type
146+
147+ ::
148+
149+ uv sync -P sdt-python
150+
151+ to update only `sdt-python ` or
152+
153+ ::
154+
155+ uv sync -U
156+
157+ to update everything.
158+
125159If the conda installation was converted to `conda forge `, type
126160
127161::
@@ -150,10 +184,10 @@ If `pip` is used, run
150184Requirements
151185------------
152186
153- - Python >= 3.9
187+ - Python >= 3.10
154188- matplotlib
155- - numpy >= 1.10
156- - pandas
189+ - numpy >= 2.1
190+ - pandas >= 2.2.3
157191- imageio >= 2.29
158192- tifffile >= 0.7.0
159193- pyyaml
You can’t perform that action at this time.
0 commit comments