Skip to content

Commit f77c342

Browse files
committed
doc: finalized update of installation instructions
1 parent be39ba3 commit f77c342

1 file changed

Lines changed: 5 additions & 10 deletions

File tree

docs/source/installation.rst

Lines changed: 5 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@ For learning, however, the standard installation is often good enough; in that c
2323
recommend using `uv <https://docs.astral.sh/uv/>`_, a modern Python package manager that
2424
is easy to use and has a very fast dependency resolver.
2525

26-
Some operators have additional, optional "engines" that are usually meant to provide improved
26+
Some operators have additional, optional *engines* that are usually meant to provide improved
2727
performance on CPU or enable GPU acceleration. These rely on third-party libraries, which are
2828
added to the list of our optional dependencies and must be installed to be able to use the
2929
associated engine. Similarly, some operators are implemented on top of third-party libraries,
@@ -57,13 +57,8 @@ First install `pylops` with your package manager of choice.
5757
>> uv add pylops
5858
5959
which installs also the *required* dependencies, if not already present
60-
in your environment. To also install some of the optional dependencies
61-
(namely ``numba``, ``pyfftw``, ``PyWavelets``, ``scikit-fmm``, ``spgl1``,
62-
``dtcwt``, ``astra-toolbox``), run:
63-
64-
.. code-block:: bash
65-
66-
>> uv add "pylops[advanced]"
60+
in your environment. Refer to :ref:`Optional` for alternative `uv`
61+
commands that install some of the optional dependencies as well.
6762

6863
From Source
6964
===========
@@ -372,7 +367,7 @@ a safe fallback to one of the required dependencies will be enforced.
372367
PyLops via ``make dev-install_conda`` (``conda``) or
373368
``make dev-install_uv`` (``uv``). GPU-enabled equivalents are
374369
``make dev-install_conda_gpu`` (``conda``) and
375-
``make dev-install_uvcu126 / dev-install_uvcu128 / dev-install_uvcu13 `` (``uv``)
370+
``make dev-install_uvcu126 / dev-install_uvcu128 / dev-install_uvcu13`` (``uv``)
376371

377372
When using the Conda package manager, only the required dependencies will be installed
378373
when installing PyLops. It is recommended to install the optional dependencies manually
@@ -424,7 +419,7 @@ In all cases, dependencies are installed from their PyPI wheels.
424419

425420
A summary table of all optional dependencies, the operators that rely on them (and
426421
whether they are required to be able to use the operator(s)), and how to install
427-
them as part of the installation process of PyLopss provided in the table below.
422+
them as part of the installation process of PyLops provided in the table below.
428423

429424
.. list-table::
430425
:widths: 15 40 5 40

0 commit comments

Comments
 (0)