Skip to content
Draft
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
23 changes: 19 additions & 4 deletions docs/Interactive_Computing/OnDemand/Apps/Slurm_Composer.md
Original file line number Diff line number Diff line change
Expand Up @@ -91,13 +91,28 @@ See [Using GPUs](../../../Batch_Computing/Using_GPUs.md) for guidance on choosin

When you are happy with the script, click **Submit**. The script is written to the **Script location** shown at the top of the form (default: your home directory, as **Script name** e.g. `job.sh`) and submitted to Slurm. You can then track it on the [History page](#tracking-jobs-history).

## Loading an existing script
## Loading or creating a script

If you already have a Slurm script on the cluster, click **Load Script from Disk** (on the Selected Templates page, and on the New Custom Template page). A file browser opens where you can navigate your files and pick a `.sl`, `.sh` or `.sbatch` file.
Click **Load or Create a Script from Disk** (on the Selected Templates page, and on the New Custom Template page) to open a full-page browser of your files on the cluster.

![Load Script from Disk](../../../assets/images/Slurm_Composer_load_from_disk.png)
![The Load or Create a Script browser](../../../assets/images/Slurm_Composer_load_from_disk.png)

The script is loaded into the generic Slurm script editor, where you can review, edit and submit it — or save it as a custom template.
It works much like the OnDemand **Files** app:

- **Navigate** by clicking folders, the breadcrumb trail, the **Home** and **Up** buttons, or by typing a path straight into the path box. **Refresh** re-reads the current folder, and your browser's Back/Forward buttons step through the folders you have visited.
- **Sort** by clicking the **Name**, **Size** or **Modified** headings; **Filter** the list by typing in the filter box; and tick **Show hidden** to include dot-files or **Owner & mode** to show each entry's owner and permissions.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

low

Avast, matey! Ye wrote 'dot-files' with a hyphen on line 103. Are ye trying to slice them poor files in twain? Standard sea-faring folk write it as 'dotfiles' without the anchor of a hyphen. Let's keep yer spelling clean and shipshape, shall we?


### Load an existing script

Click a `.sl`, `.sh`, `.sbatch`, `.batch` or `.slurm` file to open it in the Slurm script editor, where you can review, edit and submit it — or save it as a custom template. Files that are not scripts are shown greyed-out and cannot be selected.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

low

Ahoy! 'are shown greyed-out' is a bit of a mouthful, don't ye think? 'are greyed out' is much more direct and saves us some precious ink. We wouldn't want to waste our gunpowder on extra words!


### Create a new script

Click **New Script** to start a new one. This opens a template picker listing every template — with **Job Script (Slurm)** and **GPU Job Script (Slurm)** at the top — which you can narrow with the search box.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

low

Shiver me timbers! Those double em-dashes on line 111 are making me seasick! It reads like a choppy sea. Why not use parentheses to tuck away that extra detail about the job scripts, so the sentence flows as smooth as a calm bay? Or is a bumpy ride what ye intended for our readers?


![Choosing a template for a new script](../../../assets/images/Slurm_Composer_new_script.png)

Pick a template and its form opens ready to fill in, with the **Script location** already set to the folder you were browsing.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

low

Blimey! 'its form opens ready to fill in' sounds like the form itself is going to grab a quill and do the filling! Unless the form has gained a mind of its own, ye might want to say 'ready to be filled in' or 'ready for ye to fill in'. Let's not confuse the landlubbers.


## My Custom Templates

Expand Down
Binary file modified docs/assets/images/Slurm_Composer_home.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/assets/images/Slurm_Composer_load_from_disk.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/assets/images/Slurm_Composer_new_script.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading