HPC Gateway Quick Start

This document provides a brief outline of the tools you can see in the HPC Gateway Web Desktop. At the end of each section is a button to switch to another document with more details on each tool.

At the bottom of those pages is a link to return to this Quickstart.

HPC Gateway is a web desktop frontend to seamlessly manage HPC clusters environments.

HPC Gateway desktop overview

You can find the usual elements of a desktop:

  • Multiple windows
  • Menu bar
  • Manageable icons
  • Drag and drop shortcuts
  • Context menus
  • Notification widget

The menu contain the following tools :

  • Notepad : view and edit text files
  • File Explorer : explore the file systems of the different clusters
  • Task Monitor : monitor the status of the HPC tasks
  • User Manager : view the list of registered users
  • Application Manager : view the list of the applications
  • Application Editor : create and edit applications


On first login, you should populate your desktop with the tools you want to use the more frequently. Just open the menu an drag and drop the tool you need to the desktop.

When putting an icon to the desktop, an administrator can choose to share it with other users. In that case the other users won't be able to remove the icon.

The File Explorer allows you to browse and access the files on the different clusters managed by HPC Gateway.

HPC Gateway File Explorer

The File Explorer applies strictly the UNIX rights. It guarantees that a user won't access a file if he's not allowed when logged on the cluster head node.

Application Manager

The Application Manager is the entry point for all the applications.

HPC Gateway Application Manager

You can submit application directly from the Application Manager or just create shortcuts on the desktop.

Task Submission

The task submitter of an application allows the user to parameter his simulation use-case but also its execution.

On the left you find the Execution environment with :

  • the description of the simulation (name, description, wiki, project)
  • the batch scheduler options to use
  • the choice of the run directory

On the right you have all the simulation inputs that can be configured.

Application submission

Using profiles

The task submitter provides a “profile” mechanism that lets you save all the parameters of an application if you want to resubmit it.

Application profile

The Task Monitor shows the list of the tasks that have run or that are still in queue.

It also display the status of the underlying batch scheduler jobs.

Task Monitor

Task and Job Detail

For further details, you can open the Task detail or the Job detail windows.

Task Detail windowJob Detail window

Data Monitoring

You can also open the Data monitoring window to see the evolution of the simulation during the computation.
^More details...|

For advanced users, it is possible to create or edit applications.

The Application Editor allows to define a bright new application from scratch.

The Application Editor is organized by panels and you must fulfill all of them to get a functional application :

  1. Main : setup the description of the application (name, version, icon, …)
  2. Inputs : define the inputs of the application
  3. Outputs : define the outputs of the application
  4. Scripts : define the scripts that will be run in the different phases (prolog, execute, epilog)
  5. Environment : define the environment for the application to be run on the different clusters.