Skip to content

Commit d65265e

Browse files
committed
Added installation from conda to doc
1 parent df9bf9f commit d65265e

File tree

1 file changed

+20
-6
lines changed

1 file changed

+20
-6
lines changed

docs/source/installation.rst

Lines changed: 20 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -27,21 +27,35 @@ is not just a pure stylistic choice but comes with some *hidden* advantages, suc
2727
Step-by-step installation for users
2828
-----------------------------------
2929

30-
Python environment
31-
~~~~~~~~~~~~~~~~~~
30+
Conda (recommended)
31+
===================
32+
If using ``conda``, install our ``conda-forge`` distribution via:
3233

33-
Activate your Python environment, and simply type the following command in your terminal
34-
to install the PyPi distribution:
34+
.. code-block:: bash
35+
36+
>> conda install --channel conda-forge pyproximal
37+
38+
Using the ``conda-forge`` distribution is recommended as all the dependencies (both required
39+
and optional) will be automatically installed for you.
40+
41+
Pip
42+
===
43+
If you are using ``pip``, and simply type the following command in your terminal
44+
to install the PyPI distribution:
3545

3646
.. code-block:: bash
3747
3848
>> pip install pyproximal
3949
40-
Alternatively, to access the latest source from github:
50+
Note that when installing via ``pip``, only *required* dependencies are installed.
51+
52+
From Source
53+
===========
54+
To access the latest source from github:
4155

4256
.. code-block:: bash
4357
44-
>> pip install https://github.com/PyLops/pyproximal/archive/master.zip
58+
>> pip install https://github.com/PyLops/pyproximal.git@main
4559
4660
or just clone the repository
4761

0 commit comments

Comments
 (0)