Requirements and Installation

Requirements

Python 3
ro-crate-py (at least version 0.13)

Optional Requirements

docker
docker package for Python

Installation

Install pycompss-cli:

Since the PyCOMPSs CLI package is available in PyPI, it can be easily installed with pip as follows:
```
$ python3 -m pip install pycompss-cli
```
Check the pycompss-cli installation:

In order to check that it is correctly installed, check that the pycompss-cli executables (pycompss, compss and dislib, which can be used indifferently) are available from your command line.
```
$ pycompss
[PyCOMPSs CLI options will be shown]
```

Installing docker is optional and it’s only required for running and deploying Docker type environments.

Unix

Install Docker (continue with step 3 if already installed):

2.1. Suggested Docker installation instructions:

Docker for Mac. Or, if you prefer to use Homebrew.

Docker for Ubuntu.

Docker for Arch Linux.

Be aware that for some distributions the Docker package has been renamed from docker to docker-ce. Make sure you install the new package.

2.2. Add user to docker group to run the containers as a non-root user:

Instructions

2.3. Check that docker is correctly installed:
$ docker --version
$ docker ps # this should be empty as no docker processes are yet running.
Install docker for python:
$ python3 -m pip install docker
Tip

Some Linux distributions do not include the $HOME/.local/bin folder in the PATH environment variable, preventing to access to the pycompss-cli commands (and any other Python packages installed in the user HOME).

If you experience that the pycompss| compss| dislib command is not available after the installation, you may need to include the following line into your .bashrc and execute it in your current session:
$ export PATH=${HOME}/.local/bin:${PATH}

Windows

Install Docker (continue with step 2 if already installed):
2.1. Suggested Docker installation instructions:

Docker for Windows.

2.2. Check that docker is correctly installed:
$ docker --version
$ docker ps # this should be empty as no docker processes are yet running.
Install docker-py for python:
$  python3 -m pip install docker