Skip to content

Tools

All tools can be found in tools/.

COMPSs Monitor Runner

This document describes the usage of tools/run_compss_monitor.sh

Info

This bash script is based on the COMPSs Monitor Documentation.

Warning

This script might fail due to your system configuration (or OS, currently this works only on Linux/OSX/Unix/WSL). In case of failure, refer to the COMPSs documentation for exploiting this feature (and if you want, open an issuein the repo)

Overview

A convenience script for running the COMPSs Monitor locally by:

  1. Detecting container runtime (Docker/Podman) and pulling the COMPSs image
  2. Mounting the remote .COMPSs directory via SSHFS
  3. Starting the COMPSs Monitor in a Docker container

Prerequisites

  • Container runtime — Docker or Podman installed and running
  • SSHFS — installed on your system
  • SSH access — must have previously connected to the cluster (host key accepted)

Usage

In your local machine, when a PyCOMPSs workflow is running remotely, run the script as:

./tools/run_compss_monitor.sh <cluster> <remote_parent_path> [local_path]

Example

./tools/run_compss_monitor.sh leonardo /path/to/work/space/WP3-P3-workflow/md/examples/pdb/output
./tools/run_compss_monitor.sh dardel /home/user/projects ~/compss-logs

Once running, access the monitor at:

http://localhost:8080/compss-monitor

Login: /

If the script is not executable, use chmod +x ./tools/run_compss_monitor.sh.

Arguments

Argument Description
cluster SSH alias configured in ~/.ssh/config
remote_parent_path Remote directory where .COMPSs resides (without /.COMPSs suffix)
local_path (optional) Local mount point (default: ~/.COMPSs)
--stop Stop the monitor container and unmount SSHFS

Stop monitoring

./tools/run_compss_monitor.sh --stop
# or manually:
docker stop compss-monitor   # Container auto-removes on stop
fusermount -u ~/.COMPSs       # Unmount remote directory