Installation#

To install the PyProximal library you will need Python 3.8 or greater.

Note

Versions prior to v0.3.0 require Python 3.6 or greater, and scipy version lower than v1.8.0.

Dependencies#

Our mandatory dependencies are limited to:

We advise using the Anaconda Python distribution to ensure that these dependencies are installed via the Conda package manager. This is not just a pure stylistic choice but comes with some hidden advantages, such as the linking to Intel MKL library (i.e., a highly optimized BLAS library created by Intel).

Step-by-step installation for users#

Pip#

If you are using pip, and simply type the following command in your terminal to install the PyPI distribution:

>> pip install pyproximal

Note that when installing via pip, only required dependencies are installed.

From Source#

To access the latest source from github:

>> pip install https://github.com/PyLops/pyproximal.git@main

or just clone the repository

>> git clone https://github.com/mrava87/pyproximal.git

or download the zip file from the repository (green button in the top right corner of the main github repo page) and install PyProximal from terminal using the command:

>> make install

Step-by-step installation for developers#

Fork and clone the repository by executing the following in your terminal:

>> git clone https://github.com/your_name_here/pyproximal.git

The first time you clone the repository run the following command:

>> make dev-install

If you prefer to build a new Conda enviroment just for PyProximal, run the following command:

>> make dev-install_conda

To ensure that everything has been setup correctly, run tests:

>> make tests

Make sure no tests fail, this guarantees that the installation has been successfull.

If using Conda environment, always remember to activate the conda environment every time you open a new bash shell by typing:

>> source activate pyproximal