Skip to main content

Job Composer

The Job Composer is a system tool that provides a web-based utility for creating and managing batch jobs from template directories.

The Job Composer App attempts to model a simple but common workflow that typical users of an HPC center use. When users create new batch jobs they will follow the given workflow:

  1. Copy a directory of a previous job, either one of their previous jobs or a job from a group member
  2. Make minor modifications to the input files
  3. Submit this new job

The Job Composer app replicates this through "templates" which are just directories with common job input files. The user will be able to create their own template from a job directory they have access to on the file system or they can use one provided to them from a system-installed location.

While the Job Composer is a nice entry-point for beginners, you should also make yourself familiar with Job submission on terrabyte HPC methods if you want to run HPC-workflows in production.

General usage

  1. Click on the Job Composer-icon on the dashboard or select "Job Composer" in the drop down list under "Desktop Apps" in the upper menu bar.

Portal Job Composer menu

  1. The Job Composer will open a new window in the "Jobs" section.

Portal Job Composer jobs window

  1. Hit the "New Job" button Portal Job Composer new job to start creating a new job from an existing template, from any arbitrary path in your HOME-directory, or by copying a job you have already created through the Job Composer.
    The default template is an example job-script named "main_job.sh", that will run 4 tasks in parallel using MPI. Please have a look at Script-driven SLURM jobs (production) in order to learn how to write job-scripts.
    See Create own job templates on how to create your own job templates.

Portal Job Composer simple job template

Select a job and click "Edit Files" Portal Job Composer edit files to open the path in the file explorer and edit the job's files.

Select a job and choose "Job Options" Portal Job Composer job options to specify the jobs's server and submit script.

Select a job and click "Open Terminal" Portal Job Composer open terminal to open a new terminal at the job path.

Select a job and hit "Submit" Portal Job Composer submit to submit the job to the batch queue.

Select a running or queued job and click "Stop" Portal Job Composer stop to stop the job.

Select an existing job and click "Delete" Portal Job Composer delete to remove the job from the list.

Create own job templates

There are two ways to create new job templates.

  1. Create new job templates from existing jobs. This way, you can use that job as a template for future jobs. Select the job in the table to copy, then click "Create Template" to initiate the template creation process.

Portal Job Composer create template

  1. Create a new template from any arbitrary path in your HOME-directory that contains at least a job-script (but may contain additional data as well).

a. Go to the Templates section and select "New Template"

Portal Job Composer new template

b. Specify the path to your job file(s), give the template a name and click on "Save".

Portal Job Composer new template path

c. The new template is now listed in your template section and can directly be used to create a new job, which can then be submitted as explained at General usage.

Portal Job Composer create new job from template