Laptop/PC/VM/Container

This section shows you the pre-requisites to install the COMPSs framework. There are 3 types:

Essential: Minimal packages to install COMPSs.

Build: Extra packages to build COMPSs from sources.

Optional: Extra packages recommended for performance purposes.

Essential Requirements

There are some systemwide packages required in order to install COMPSs.

They are, depending on your OS and version, shown here:

Linux

macOS

Sequoia 15.4

macOS Sequoia dependencies installation commands:

Although many packages can be installed with Homebrew, some of them will have to be installed manually from their source files. It is also important to mention that, some package names may be slightly different in Homebrew, compared to Linux distributions, thus, some previous search for equivalences may be required. Our tested installation sequence was as follows. Please install each package INDIVIDUALLY, since some can have post-installation instructions that require adding environment variables to your shell profile.

$ brew install openjdk@21
$ sudo ln -sfn /opt/homebrew/opt/openjdk@21/libexec/openjdk.jdk /Library/Java/JavaVirtualMachines/openjdk-21.jdk
$ brew install graphviz
$ brew install libxslt
$ brew install xmlto
$ brew install libtool
$ brew install automake
$ brew install coreutils
$ brew install util-linux
$ brew install boost
$ brew install gradle
$ export JAVA_HOME=$(dirname $(readlink $(which javac)))/java_home
$ echo $JAVA_HOME >> ~/.bashrc
$ echo 'export GRADLE_HOME=/opt/gradle-8.7' >> ~/.bashrc
$ export GRADLE_HOME=/opt/gradle-8.7
$ echo 'export PATH=/opt/gradle-8.7/bin:$PATH' >> ~/.bashrc
$ export PATH=/opt/gradle-8.7/bin:$PATH

The package xdg-utils has to be installed by hand (after installing libxslt and xmlto):

$ export XML_CATALOG_FILES="/usr/local/etc/xml/catalog"
$ git clone https://gitlab.freedesktop.org/xdg/xdg-utils.git
$ cd xdg-utils
$ ./configure --prefix=/usr/local
$ make ; make install

You can download the following script for your reference, but we STRONGLY recommend to run it command by command, since every installation step with brew usually includes post-installation instructions.

brew install openjdk@21
sudo ln -sfn /opt/homebrew/opt/openjdk@21/libexec/openjdk.jdk /Library/Java/JavaVirtualMachines/openjdk-21.jdk
brew install graphviz
brew install libxslt
brew install xmlto
brew install libtool
brew install automake
brew install coreutils
brew install util-linux
brew install boost
brew install gradle
export JAVA_HOME=$(dirname $(readlink $(which javac)))/java_home
echo $JAVA_HOME >> ~/.bashrc
echo 'export GRADLE_HOME=/opt/gradle-8.7' >> ~/.bashrc
export GRADLE_HOME=/opt/gradle-8.7
echo 'export PATH=/opt/gradle-8.7/bin:$PATH' >> ~/.bashrc
export PATH=/opt/gradle-8.7/bin:$PATH
# The package ``xdg-utils`` has to be installed by hand (after installing ``libxslt`` and ``xmlto``)
export XML_CATALOG_FILES="/usr/local/etc/xml/catalog"
git clone https://gitlab.freedesktop.org/xdg/xdg-utils.git
cd xdg-utils
./configure --prefix=/usr/local
make ; make install

this example script

Warning

Tracing is not yet available for macOS, therefore, its dependencies do not need to be installed.

Tip

For macOS, we strongly recommend to use the Homebrew package manager, since it includes the majority of dependencies needed. In other package managers, such as MacPorts, quite some dependencies may be missing as packages, which will force you to have to install them from their source codes. After each package installation, PAY ATTENTION to the messages reported by Homebrew, since extra steps may be required to complete each installation (e.g. add variables to your .bash_profile, etc…)

Other

Tip

If your version is not in this list, you can get in contact with us and we will be happy to help you:

support-compss@bsc.es

Windows

Please, check Linux and Ubuntu tab in order to get the instructions to install COMPSs in WSL.

Other

Tip

If your operative system is not in this list, you can get in contact with us and we will be happy to help you:

support-compss@bsc.es

The following table provides a list of dependencies for installing COMPSs package.

The exact names may vary depending on the Linux/macOS distribution but this list provides a general overview of the COMPSs dependencies. For specific information about your distribution please check the Depends section at your package manager (apt, yum, zypper, etc.).

Table 1 COMPSs dependencies
Module	Dependencies
COMPSs Runtime	openjdk-21-jdk (or JRE if using the pre-built runtime), graphviz, xdg-utils, openssh-server, gradle (8.7)
COMPSs Python Binding	libtool, automake, build-essential, python (>=3.7), python3-dev, python3-setuptools (>=61.0.0)
COMPSs C/C++ Binding	libtool, automake, build-essential, libboost-all-dev, libxml2-dev
COMPSs R Binding	build-essential, R (>=3.6.3)
COMPSs Tracing	libxml2 (>= 2.5), libxml2-dev (>= 2.5), gfortran, papi

Important

Python version 3.8 or higher is recommended since some of the Python binding features are only supported in these Python versions (e.g. worker cache)

Build Dependencies

To build COMPSs from sources you will also need wget, git and maven (maven web). To install with Pip, pip for the target Python version is required.

Optional Dependencies

For the Python binding it is recommended to have dill (dill project), guppy3 (guppy3 project) and numpy (numpy project) installed:

The dill package increases the variety of serializable objects by Python (for example: lambda functions)
The guppy3 package is needed to use the @local decorator.
The numpy package is useful to improve the serialization/deserialization performance since its internal mechanisms are used by the Python binding.

For the Workflow Provenance generation, some distributions may not have installed yaml and pytz, so you will have to install them manually.

All these packages can be found in PyPI and can be installed via pip.

Since it is possible to execute python applications using workers spawning MPI processes instead of multiprocessing, it is necessary to have openmpi, openmpi-devel and openmpi-libs system packages installed and mpi4py with pip.

Caution

The mpi4py package requires to have the MPI header/development package available, which has to be installed with the OS package manager.

$ sudo apt-get install libopenmpi-dev  # Adapt for your OS package manager