Skip to content

Templates & Cases

Below is a breakdown of the different templates and use cases that are provided in WAVIhpc.

Platform Templates

Not sure which platform to use? See the section on platforms.

template

The template case is the boilerplate template on which all other templates are based.

It contains the following structure:

cases
└── template
    ├── code
    ├── ensemble
    |   └── template.yaml
    ├── input
    |   ├── drive.jl
    |   └── driver.jl.j2
    ├── run
    └── scripts
        ├── prep_run
        ├── run_driver
        ├── run_ensemble_member
        └── run_ensemble_member.j2

All other cases also follow this structure. The directories contain the following:

  • /code: Empty in templates, but could contain additional (e.g. Julia) code required to run your ensemble.
  • /ensemble: Contains a model-ensembler configuration file, template.yaml.
  • /input: Contains input files, in this case driver.jl/driver.jl.j2, files which instantiate, configure and run the WAVI simulation. Also see WAVI API Overview.
  • /run: An empty folder, which will contain output files for each run.
  • /scripts: Contains scripts prep_run, run_driver.jl, run_ensemble_member/run_ensemble_member.j2, whose execution are configured by /ensemble/template.yaml

template_bas

The BAS template structure is identical to the boilerplate template, but there are changes to ensemble/template.yaml and scripts/run_ensemble_member tailored to running on the BAS HPC.

(BAS internal only) See the HPC training guides on Slurm scheduling and Slurm Advanced for more information on the BAS HPC cluster, node choices and sbatch header options.

template_archer

The ARCHER2 template structure is identical to the boilerplate template, but there are changes to ensemble/template.yaml and scripts/run_ensemble_member tailored to running on the ARCHER2 cluster.

See ARCHER2's running jobs documentation for more information on ARCHER2's cluster, node choices and sbatch header options.

template_jasmin

Identical to ARCHER2, with JASMIN-specific changes to ensemble/template.yaml and script/run_ensemble_member.

See JASMIN's batch computing documentation for more information on JASMIN's cluster, node choices and sbatch header options.

Use Case Templates

ATTR_666

MISMIP_666

This case is intended to simulate the Marine Ice Sheet Model Intercomparison, which you can also follow in the WAVI documentation.

Configured to run on ARCHER2, MISMIP_666 contains changes to input/driver.jl, as well as additional files under /scripts: prep_run.sh, rsync_jld2.sh, rsync_mat.sh, rsync.sh, run_repeat.sh and sub_run.sh.

MISOMIP_666

This case is intended to simulate the Marine Ice Sheet-Ocean Model Intercomparison Project (MISOMIP)

Configured to run on ARCHER2, MISOMIP_666 contains changes to input/driver.jl, as well as additional input data files: bathyREAL_408.box, hinit400_40_24_2.box, hmask400_40_24_2_edit.bin, and Streamice_Thickness_out.data.

It also contains additional files under /scripts: prep_run.sh, rsync.sh, run_repeat.sh and sub_run.sh.