SMS:CSTORM-MS

Create HPC scripts

File:Create HPC Scripts.jpg

Create HPC Script dialog

CSTORM-MS is a set of models organized into a system that work together to create models relative to coastal storms. Many of the models in the system are very compute intensive models and may run for long periods of time. Often it is desirable to run these models in a HPC (supercomputer) environment to take advantage of many processors.

Some users may not be as familiar with the HPC environment or want a system to help regenerate scripts as needed. The Create HPC Scripts tool within SMS helps users create scripts from parameters. The parameters may be changed and the scripts regenerated as necessary. The parameters can be saved with the project, exported/loaded into other projects, and stored as the default parameters for future CSTORM-MS simulations.

The Create HPC Scripts tool is accessed by right-clicking on the CSTORM-MS simulation and selecting the Create HPC Scripts command.

Platforms

Platforms are the term used for a collection of script parameters because often the scripts will be created to target a specific HPC platform. However, a user could create multiple sets of scripts for the same platform if there are different run parameters for different types of simulations. The user can create, delete, or copy the scripts from one platform to a new platform.

Programs

Each of the programs within the CSTORM-MS system has its own script within the platform. Each program has its own run requirements which are handled through SMS defined variables (see below).

Variables

Variables are used to modify the script text for export. Variables can make it easier to change a script by identifying the items that should be changed in a script and giving a description for the variable. When the script is generated, every instance of the variable within the script will be replaced with the text in the 'value' column. It is recommended but not required that variables use a naming convention similar to the SMS defined variables for easy identification.

SMS defined variables (program specific)

SMS defined variables provide information to scripts based upon simulation parameters. These parameters are specified elsewhere but may need to be incorporated into individual scripts. One example of this type of variable is the number of processors to use for ADCIRC. SMS knows how many processors ADCIRC wants to use and can automatically make this part of the script.

User defined variables (global)

User defined variables allow scripts to be generated generically and give descriptions for the script parameters needed. User defined variables are global (shared between all programs/platforms). If wanting to have a similar variable specified differently for separate programs, add the program name to the variables. For example, if PBL and ADCIRC both needed a walltime but it should be different use $PBL_WALLTIME and $ADCIRC_WALLTIME rather than $WALLTIME within the scripts.

Model Project Summary

The ERDC-CSTORM-MS Model Project Summary dialog is accessed by right-clicking on the CSTORM-MS simulation and selecting Properties from the menu. The dialog has several tabs and options as follows:

Overview

File:CSTORM Model Project Sum Over.jpg

ERDC-CSTORM-MS Model Project Summary dialog showing the Overview tab

The dialog gives an overview of the components of the Hurricane simulation. It also allows the user to designate the number of processors to be use by each model in the simulation.

• Simulation Name – Name of the Hurricane simulation as set in the project explore
• Properties – Properties of the Hurricane simulation

• Model Name – Name of models found in the simulation

• ADCIRC <mesh name> (1 required) – Name of the adcirc mesh used in the hurricane simulation.
• STWAVE <grid name> (1 required) – Name of the stwave cgrid used in the hurricane simulation.
• PBL <pbl cov name> (optional) – Name of pbl wind coverage used in the hurricane simulation.
• WAM <wam sim name> (optional) – Name of wam simulation used in the hurricane simulation.

• Projection – Projection type of model.

• Geo – Geographic (Latitude/Longitude)
• STPL <#> – State Plane number
• Other – Other type of projection

• Start Time – Temporal starting time of model.
• End Time – Temporal ending time of model.
• Threads – Number of processor threads used by model for computation or I/O processing.
• Function – Function used to adjust the processor threads used by each model.

• Set Threads – Set the number of processor threads for:

• Computational or I/O processing (ADCIRC)
• Grid Partition I and J processing (STWAVE)

• NONE – WAM and PBL use only one processor thread.

File:CSTORM Set Thread1.jpg CSTORM-MS Set Thread Count dialog for ADCIRC

File:CSTORM St Thread2.jpg CSTORM-MS Set Thread Count dialog for STWAVE

ESMF

File:CSTORM Model Project Sum ESMF.jpg

ERDC-CSTORM-MS Model Project Summary dialog showing the ESMF tab

• Set the ESMF simulation options in the Data Exchange and Area Mapping sections of the dialog

• Data Exchange

• Model A – The meshed based model to be use (hard-coded to ADCIRC)
• Data Exchange – Controls how data is exchanged between the two models (↔ bi-directional, → uni-direction A to B, ← uni-directional B to A)
• Model B – The grid based model to be use (hard-coded to STWAVE)
• Model A → B – How frequently the results of Model A are passed to Model B
• Units – Frequency units for A to B exchange (days/hours/minutes/seconds)
• Model A ← B – How frequently the results of Model B are passed to Model A
• Units – Frequency units for B to A exchange (days/hours/minutes/seconds)

• Area Mapping

• ID – Polygon identifier correlated to the ids visible in the main graphics window.
• Mapping

• Single – Model A exchanges data with a single instance of Model B
• Combined – Model A exchanges data with multiple instances of Model B. Model A can receive either the average or maximum values from the instances of Model B.

• Option – If the "Mapping" field is set to "Single" and multiple grids overlap the identified polygon, this field allows the user to select which grid will be used. If the "Mapping" field is set to "Combined", this field allows the user to select how the data from the grids will be combined (Average or Maximum.)

Spatial View

This dialog provides a view of any grid boundaries (WAM and STWAVE), grid frames (PBL), and the ADCIRC mesh boundary associated with the simulation.

File:CSTORM Model Project Sum Spatial.jpg

ERDC-CSTORM-MS Model Project Summary dialog showing the Spatial View tab

Timeline

This dialog displays the timelines for each simulation (WAM, STWAVE, PBL, and ADCIRC) that are part of the hurricane simulation. The start and end times need to be set for each simulation individually.

File:CSTORM Model Project Sum.jpg

ERDC-CSTORM-MS Model Project Summary dialog showing the Timeline tab

Related Topics

• ESMF - Earth System Modeling Framework