Merge pull request #129 from mrava87/readmeconda

Updated README and documentation with conda-forge install

Author: mrava87

README.md

@@ -2,13 +2,14 @@
 
 [![PyPI version](https://badge.fury.io/py/pyproximal.svg)](https://badge.fury.io/py/pyproximal)
 [![Build Status](https://travis-ci.com/PyLops/pyproximal.svg?branch=main)](https://travis-ci.com/PyLops/pyproximal)
-[![AzureDevOps Status](https://dev.azure.com/matteoravasi/PyLops/_apis/build/status/PyLops.pyproximal?branchName=main)](https://dev.azure.com/matteoravasi/PyLops/_build/latest?definitionId=10&branchName=main)
+[![AzureDevOps Status](https://dev.azure.com/matteoravasi/PyLops/_apis/build/status%2FPyLops.pyproximal?branchName=refs%2Fpull%2F129%2Fmerge)](https://dev.azure.com/matteoravasi/PyLops/_build/latest?definitionId=10&branchName=refs%2Fpull%2F129%2Fmerge)
 ![GithubAction Status](https://github.com/PyLops/pyproximal/workflows/PyProx/badge.svg)
 [![Documentation Status](https://readthedocs.org/projects/pyproximal/badge/?version=latest)](https://pyproximal.readthedocs.io/en/latest/?badge=latest)
 [![OS-support](https://img.shields.io/badge/OS-linux,osx-850A8B.svg)](https://github.com/PyLops/pyproximal)
 [![Slack Status](https://img.shields.io/badge/chat-slack-green.svg)](https://pylops.slack.com)
 
 
+
 :vertical_traffic_light: :vertical_traffic_light: This library is under early development.
 Expect things to constantly change until version v1.0.0. :vertical_traffic_light: :vertical_traffic_light:
 
@@ -75,11 +76,10 @@ xladmm, _ = LinearizedADMM(l2, l1, Dop, tau=tau, mu=mu,
 ```
 
 ## Why another library for proximal algorithms?
-
 Several other projects in the Python ecosystem provide implementations of proximal
 operators and/or algorithms, which present some clear overlap with this project.
 
-A (possibly not exahustive) list of other projects is:
+A (possibly not exhaustive) list of other projects is:
 
 * http://proximity-operator.net
 * https://github.com/ganguli-lab/proxalgs/blob/master/proxalgs/operators.py
@@ -110,39 +110,34 @@ This repository is organized as follows:
 * **tutorials**:  set of python script tutorials to be embedded in documentation using sphinx-gallery
 
 ## Getting started
-
 You need **Python 3.8 or greater**.
 
-*Note: Versions prior to v0.3.0 work alsi with Python 3.6 or greater, however they 
+*Note: Versions prior to v0.3.0 work also with Python 3.6 or greater, however they 
 require scipy version to be lower than v1.8.0.*
 
-
 #### From PyPi
-
-If you want to use PyProximal within your codes,
+you want to use PyProximal within your codes,
 install it in your Python environment by typing the following command in your terminal:
 
+To get the most out of PyLops straight out of the box, we recommend `conda` to install PyLops:
+```bash
+conda install -c conda-forge pyproximal
 ```
-pip install pyproximal
-```
-
-Open a python terminal and type:
 
+#### From PyPi
+You can also install pyproximal with `pip`:
+```bash
+pip install pylops
 ```
-import pyproximal
-```
-
 
 #### From Github
-
-You can also directly install from the master node (although this is not reccomended)
+Finally, you can also directly install from the main branch (although this is not recommended)
 
 ```
 pip install git+https://[email protected]/PyLops/pyproximal.git@main
 ```
 
 ## Contributing
-
 *Feel like contributing to the project? Adding new operators or tutorial?*
 
 We advise using the [Anaconda Python distribution](https://www.anaconda.com/download)
@@ -151,7 +146,6 @@ the following instructions and read carefully the [CONTRIBUTING](CONTRIBUTING.md
 file before getting started.
 
 ### 1. Fork and clone the repository
-
 Execute the following command in your terminal:
 
 ```

docs/source/installation.rst

@@ -27,21 +27,35 @@ is not just a pure stylistic choice but comes with some *hidden* advantages, suc
 Step-by-step installation for users
 -----------------------------------
 
-Python environment
-~~~~~~~~~~~~~~~~~~
+Conda (recommended)
+===================
+If using ``conda``, install our ``conda-forge`` distribution via:
 
-Activate your Python environment, and simply type the following command in your terminal
-to install the PyPi distribution:
+.. code-block:: bash
+
+   >> conda install --channel conda-forge pyproximal
+
+Using the ``conda-forge`` distribution is recommended as all the dependencies (both required
+and optional) will be automatically installed for you.
+
+Pip
+===
+If you are using ``pip``, and simply type the following command in your terminal
+to install the PyPI distribution:
 
 .. code-block:: bash
 
    >> pip install pyproximal
 
-Alternatively, to access the latest source from github:
+Note that when installing via ``pip``, only *required* dependencies are installed.
+
+From Source
+===========
+To access the latest source from github:
 
 .. code-block:: bash
 
-   >> pip install https://github.com/PyLops/pyproximal/archive/master.zip
+   >> pip install https://github.com/PyLops/pyproximal.git@main
 
 or just clone the repository