Requirements

Minimal Requirements

  • Python >= 3.10

  • Linux, MacOS, or Windows.

Optional Requirements

The CLI supports various COMPSs installed environments. Depending on the environment type, additional requirements may apply.

Local environments

  • Linux or MacOS

Caution

⚠️ Windows users: COMPSs does not provide native support for Windows. Please use WSL (Windows Subsystem for Linux) to enable local environment usage.

Remote environments (HPC)

  • Internet connectivity

  • Access to the remote machine

Dockerized environments

To run and deploy Docker-based environments, the following installations are required:

Linux

  1. Install Docker (skip this step if already installed):

    • Suggested installation instructions:
    • Note: In some distributions, the Docker package has been renamed from docker to docker-ce. Ensure you install the correct package.

  2. Configure permissions: Add the user to the docker group to run containers as a non-root user:

  3. Verify installation:

    $ docker --version
    $ docker ps # this should be empty as no docker processes are yet running.
    
  4. Install the Python docker library:

    $ python3 -m pip install docker
    

    Tip

    Some Linux distributions do not include the $HOME/.local/bin folder in the PATH environment variable, preventing access to the pycompss-cli commands (and any other Python packages installed in the user HOME). If the pycompss, compss, or dislib commands are not recognized after installation, add the following line to your .bashrc and refresh your current session:

    $ export PATH=${HOME}/.local/bin:${PATH}
    

MacOS

  1. Install Docker (skip this step if already installed):

  2. Configure permissions: Add the user to the docker group to run containers as a non-root user:

  3. Verify installation:

  4. Install the Python docker library:

    Tip

    If the pycompss, compss, dislib, or qdislib commands are not recognized after installation, you may need to include the following line in your .bashrc or .zshrc and refresh your current session:

    $ export PATH=${HOME}/.local/bin:${PATH}
    

Windows

  1. Install Docker (skip this step if already installed):

  2. Verify installation:

    $ docker --version
    $ docker ps # this should be empty as no docker processes are yet running.
    
  3. Install the Python docker library:

    $  python3 -m pip install docker
    

UNICORE environments

Installing pyunicore for Python is required for running and deploying UNICORE-type environments.

$  python3 -m pip install pyunicore