Alvis OnDemand

Open OnDemand logo

Alvis is available as an Open OnDemand powered web service at https://portal.c3se.chalmers.se.

Open OnDemand is a HPC portal accessible from a web browser and comes with features such as file managment, command-line shell access, job management and monitoring. Open OnDemand is accessible using most browsers and is built for scientific workflows using a scheduler. Open OnDemand includes support for applications such as Jupyter, RStudio, MATLAB, and more.

Advantages of Alvis OnDemand

Traditionally access to HPC resources has largely been terminal-based. Users has been required to install and operate a terminal emulator, access a remote system and carefully compose files for batch-job processing. If you were lucky, the labour from one HPC system could be reused on another, but not always. Open OnDemand simplifies these prior steps. In particular for users from non-traditional HPC fields with less experience in terminals and command-line operation. To access Alvis OnDemand you only need a browser, an account and the URL to the Open OnDemand portal. If you work mostly using Jupyter notebooks, or in a Desktop environment, the setup work is greatly reduced, saving you time for science.

Requirements

  • You need a SUPR account and membership in a active project with allocation on Alvis.
  • You need to connect from a network on SUNET.
  • A modern browser such as Mozilla Firefox, Google Chrome or Microsoft Edge. The later versions of each is expected to work best. Safari might work, but have reported issues with frameworks used by Open OnDemand.

A note on browser support: Open OnDemand uses the Shell App to provide an interactive shell using the browser. In some versions of Google Chrome not all special characters can be typed into the shell.


Login

To access Alvis OnDemand open a web browser and type https://portal.c3se.chalmers.se in the address bar. This will take you to the login page. Click the button Login to Alvis OnDemand. You will be redirected to SUPR where you will be prompted to login and prove your identity. Login using your SUPR credentials. Click the Prove My Identity to C3SE button and you will be forwarded to the Open OnDemand dashboard.


⚠️ Remember to log out. An active and logged in session in Open OnDemand offers similar access to Alvis as traditional remote shell access. Always make sure you log out when leaving your computer. Closing the browser tab is not enough as most browsers keeps active sessions for some time.

Open OnDemand log out


User guide

All navigation is performed using the top menu. Alvis OnDemand provides four main features. Files for accessing the File manager, Jobs for composing and monitoring active jobs, Clusters to open a interactive shell and Interactive Apps to quickly launch applications accessible from your browser, such as a Jupyter notebook.

Open OnDemand navigation

Files - Manage your files

Click on Files to open a drop-down list of your file spaces. Select any of them to open the File Manager. File Manager allows you to view, edit, rename or delete existing files, and create new files and directories.

File manager is shown below

Open OnDemand file view

Changing directories can be made either by clicking on the Change directory button and writing an absolute path name, or by clicking the left most up arrow icon to move to the parent directory. Please note that it might take a little bit of time to load a directory containing many files.

Open OnDemand change directory

Upload a file

Upload files by clicking on the Upload button in the file menu. You will be prompted to drop files, or browse and select files and folders. Please note that uploading files to your home and project storage area can only be done if you have sufficient quota.

Open OnDemand upload

Download a file

Download files by first selecting a single file by checking the checkbox next to the file name, and then click the Download button in the file menu.

Open OnDemand download

Jobs - Create and manage jobs

Click on Jobs to view Active Jobs or to open the Job Composer from which you can compose and submit jobs. The Active Jobs view lists all your active jobs, including your jobs submitted outside of Open OnDemand. Completed job will be listed for a short time.

Active jobs

Open OnDemand active jobs

Click on the left most arrow to view job details. At the end of job details you have the option to open the output location in the File Manager or start a terminal. Note that the terminal will start where you submitted the job. If the job is running on a compute node opening a terminal will not start the terminal at the compute node.

Open OnDemand active jobs


⚠️ Status is not the same as job state. Please note that jobs that fail (exit with a non-zero return code) will still show as status completed. You need to click on the left most arrow to view the job details to see the actual job state as reported by Slurm.

Capture below shows a COMPLETED but FAILED job

Open OnDemand failed

Job composer

The Job composer is a tool to compose or construct a Slurm job. All the requirements from submitting a Slurm job still holds of course and you need to either specify or provide a path to a job file containing the required job parameters. As jobs often have high reusability, Open OnDemand also allows you to be more productive by offering job templates.

Click on New Job. You have two options, either compose a new job from a default template, or create a job from a path you specify. We will show the second alternative.

Creating a new job from a path you will need to enter the Source path, a path to a directory containing a template (a Slurm job submit file) with headers (#SBATCH ...) you intend to use frequently. A minimal template directory is a directory and a Slurm job submit file. This is exactly what you get if you instead chose to use the first option From Default Template.

Open OnDemand new template


Staging template dir must be less than 1 GiB: Job Composer limits the template directory to 1073741824 bytes (1 GiB). It is thus not a good idea to use the root of your home or project directory as the template directory.

Open OnDemand staging error

Clicking on Save brings you back to the Job manager. With our recently saved job you can now chose to edit files, specify job options, open a terminal or submit the job.

Open OnDemand compose a job

Clusters - Quickly launch a login shell on Alvis

Open OnDemand is currently only supported for the Alvis cluster. Clusters will present you with an option to launch a login shell on the Alvis login node.

Open OnDemand shell login

Interactive Apps

The Interactive Apps tab allows you to quickly configure a job that launches an interactive application, such as a Desktop or a Jupyter notebook server. The application is started as a Slurm job on Alvis. You will need to enter a project, the duration of the job, node type to use (i.e. how many GPUs do you need), a runtime and (optional) a working directory. You can customize your own Runtime by creating ~jupyter1.sh. For examples how runtimes are constructed see the existing runtimes in /apps/jupyter/.

Open OnDemand shell login

As the job is submitted to the Slurm queue you will need to be patient until it starts. Once it starts you can find and start the session from the My Interactive Sessions tab.

Open OnDemand interactive sessions