Template for an Application Page#

Write a brief description of the program here.

Getting Started#

This section provides the minimum amount of information necessary to successfully run a basic job on an NREL Cluster. This information should be as complete and self-contained as possible.

Instructions should be step-by-step and include copy-and-pastable commands where applicable.

For example, describe how the user can load the program module with module avail and module load:

module avail program
   program/2.0.0    program/1.0.0

module load program/2.0.0

Include a section on how to run the job, e.g. with job script examples or commands for an interactive session.

Example Job Scripts#

Kestrel CPU

#!/bin/bash

# In a comment summarize the hardware requested, e.g. number of nodes, 
    # number of tasks per node, and number of threads per task

#SBATCH --time=
#SBATCH --nodes=
#SBATCH --ntasks-per-node=
#SBATCH --cpus-per-task=
#SBATCH --partition=
#SBATCH --account=

# include a section of relevant export and module load commands, e.g.:

module load gcc/8.4.0

export OMP_NUM_THREADS=

# include a sample srun command or similar
srun program.x

Vermillion

If the submit script for Vermillion differs from Kestrel, then include a Vermillion example script here. If the submit script does not differ, then remove this section (starting from the ??? example "Vermillion" line)

Swift

If the submit script for Swift differs from Kestrel, then include a Swift example script here. If the submit script does not differ, then remove this section (starting from the ??? example "Swift" line)

Template

Here's a template of a collapsible example.

You can include blocked sections

And unblocked sections.

Note

You can use a note to draw attention to the information in this section

Note

If the submit scripts for Vermillion, Swift, and Kestrel are all the same, remove all of the submit script collapsible sections (remove the ??? example headers that are inside the ### Example Job Scripts header), and give a submit script directly below the ### Example Job Scripts header.

Include instructions on how to submit the job script

Advanced#

Include advanced user information about the code here (see BerkeleyGW pages for example)

Troubleshooting#

Include known problems and workarounds here, if applicable