The Open OnDemand Job Composer enables users to create job scripts and submit them without ever using the command line. This is a custom Confluence template that is intended to be re-used in the creation of workshops presented by ARCC on the Wiki. All of the content in these sections is intended to be replaced by the author of the workshop. The first step in this style guide is to ensure that the the page is in wide mode to maximize the real estate for content when possible. The Title of the Page should be the same as the Title of the workshop and this section should include a quick intro to the topic, why it’s important for ARCC users, and what users should expect to get out of this workshop. Next should be a Table of Contents macro in vertical format. The Table is intended to be used as an agenda section for presenter mode as well as navigation for non-presenting viewing so that users can find the documentation and navigate to what they need to brush up on. Finally, at the end of each section, there should be a divider to indicate the separation of “slides”paricularly helpful for new users who have never opened a terminal or are unfamiliar with Linux command line behavior. However, some knowledge of Slurm and ARCC’s required Slurm directives is needed to successfully submit jobs on MedicineBow. Discussed in this module is the use of the Job Composer and common issues that arise with it.
...
| Table of Contents | ||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
Headers and Sections
...
Code Examples
Two Column Tables are nice ways to separate content/ Background info along with a code example on the same “Slide”. Please notice the table width. This should stop scroll bars from appearing
...
Bullets are nice to include for distinct points
...
yep
...
they
...
sure
...
| Code Block |
|---|
Please use the "code snippet" in the + button when creating code examples. Also please do not go
past the width of the table. This is to prevent scroll bars appearing
This is the Max number of code lines to show on an example |
...
Straight Code - No context
| Code Block |
|---|
Limit to 16 lines in the example.
This is the end |
Same Thing With Images
...
Two Column Tables are nice ways to separate content/ Background info along with an image example on the same “Slide”. Please notice the table width. This should stop scroll bars from appearing
Bullets are nice to include for distinct points
yep
they
sure
are
This is 14 lines
...
First Look at the Job Composer
When opening the Job Composer for the first time, there are a few pop up prompts to follow to get started creating a job. There are also two items in the top menu 1) for Job management and 2) for job templates. Notice that the “New Job” button allows user to select a previously created job with the path, or from a Default Template as well as a new one if there is a job in the selections below.
...
Create a Job With a Template
If someone has never created a batch job in Slurm before, a template is a good place to get started into seeing how one would look like. In this example, we will create a Default Template and then edit it in the steps below. After clicking the “New Job” Button and selecting the “Default Template” option, we are presented with a new box on the right of the first look. Notice the parameters already set:
|
|
...
Job Editor
When we click the light blue button on the bottom of the right box, we get a new window to pop up with a text editor-like appearance. If we then look at ARCC’s documentation on Required Inputs, we know what to add to get a job to run by adding the account and time Slurm directives.
If we click save and go back to the Job Composer page, we should see our changes in the preview.
...
Job Options
Now that our job will run, we still might need to make some changes to the job options that will work best for us. If we click the “Job Options”
|
|
...
Alternatively No Table
...