CoolWP: Job Composer

The Job Composer is a web-based tool designed for efficiently creating and managing batch jobs using predefined template directories. It is designed to replicate a straightforward yet commonly used workflow for typical HPC center users. It can be opened by selecting Job Composer from the drop-down list under Clusters in the upper menu bar.


Once you open the Job Composer tool, a new window will appear in the Jobs section, displaying the following page:


Managing job

In the Jobs section, you can perform various actions, including creating a batch job and modifying an existing one to suit your requirements. Once you select a job from the list, the following page will be displayed, showing detailed information about your job.


On the right side, two subsections will appear. The upper section is titled Job Details, and below it, the Submit Script section is displayed.

The Job Details section provides essential information about the batch job, including:

  • Job Name: The assigned name of the job
  • Submit To: The HPC system where the job will run
  • Account: The associated account (if specified)
  • Script Location: The file path of the job script
  • Script Name: The name of the script being executed
  • Folder Contents: A list of files included in the job directory


The Submit Script section displays the contents of my_job.sh, which specifies the job configuration, resource allocation, and execution commands required for submission. 


You can edit the batch file with the CoolWP: Code Editor by either selecting its name in the Job Details section under Folder Contents or clicking the Open Editor icon at the bottom of the Submit Script section. Both actions open the CoolWP: Code Editor for further editing. 



You can open a new terminal at the job path with CoolWP: Shell Access by clicking the Open Terminal icon in the upper left corner or at the bottom of the Submit Script section.  



You can open the path in the file explorer by clicking the Edit Files icon in the upper left corner or the Open Dir icon at the bottom of the Submit Script section.  


Jobs can be submitted to the batch queue by selecting an existing job and clicking the Submit icon. 



Jobs can be stopped by selecting a running or queued job and clicking the Stop icon.  



Jobs can be deleted by selecting an existing job and clicking the Delete icon to remove it from the list.   



You can describe a job by selecting an existing job and clicking Job Options.



After clicking, the following page will be displayed, including details regarding the job, with labels for each section such as Name (the job's name), Cluster, Specified job script, Account, and Job array.



You also have options to copy the environment by clicking Copy the Environment, reset with the Reset icon, or go back with the Back icon.


After making the necessary changes, click the Save button.


Creating a batch job

To create a batch job, click the New Job button.


You will see three options for creating batch jobs: using the default template, selecting a job from a specified path, or choosing an existing job. 


To create a batch job from the default template, select From Default Template. This is useful if you want to quickly set up a job with standard configurations. This will create a sample job script named main_job.sh.


To create a batch job from a specified path, select the From Specified Path option.


After selecting this option, a details page will be displayed. In the details page, enter the job file path in the Source Path section, provide a descriptive name in the Name field, ensure the Script Name matches the batch file name, select the appropriate cluster in the Cluster section, and enter your account name in the Account section. 

 

Click the Save button to finalize the job creation. After this step, the specified path containing the job files, along with all relevant files, will be copied to the project directory.

 

To create a batch job from an existing job, select a job from the list and choose the From Selected Job option. This option allows you to duplicate an existing job, making it useful when you need to reuse a previously created job without starting from scratch.


Creating a Custom Job Template

There are two methods for creating job templates: from an existing job or an arbitrary path in your HOME directory.

To generate a job template from an existing job, select the desired job from the table and click the Create Template button to initiate the process. 


After selecting Create Template, the template details page will appear. In the Path section, enter the path to your job file(s). In the Name field, provide a suitable name for the template. In the Cluster section, choose the appropriate cluster for the template.


Click the Save button to finalize the template creation and store it for future use.


The newly created template will appear in the Templates section and can be used to generate a new job by clicking the Create New Job button. 



To create a new template from an arbitrary path in your HOME directory containing at least a job script (though it may include additional data), navigate to the Templates section.


After navigating to the Templates section, click the New Template button.


After selecting New Template, the template details page will be displayed.  In the Path section, enter the path to your job file(s). In the Name field, provide a suitable name for the template. In the Cluster section, choose the appropriate cluster for the template. 


Click the Save button to finalize the template creation and store it for future use. 


After this step, the specified path containing the job files, along with all relevant files, will be copied as a template into the Templates directory.The newly created template will appear in the Templates section and can be used to generate a new job by clicking the Create New Job button.