Installation

You will need Python 3.5 or greater to get started.

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.

Step-by-step installation for users

Python environment

Stable releases on PyPI and Conda coming soon…

To install the latest source from github:

>> pip install https://git@github.com/equinor/pylops-distributed.git@master

or just clone the repository

>> git clone https://github.com/equinor/pylops-distributed.git

or download the zip file from the repository (green button in the top right corner of the main github repo page) and install PyLops 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/pylops-distributed.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 PyLops, 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 pylops-distributed