use with Apptainer or Singularity

The SWASH docker image can be used with Apptainer and Singularity. These container platforms are especially useful for running SWASH on HPC clusters, either locally or in the cloud (e.g., Microsoft Azure and Amazon Web Services).

First, pull the docker image in the following way:

apptainer pull docker://delftwaves/swash:latest

This pull creates a singularity image named swash_latest.sif, which can then be run with standard Apptainer commands. For example:

apptainer run --bind .:/home/swash swash_latest.sif swashrun -input <SWASH-command-file-without-extension> -mpi <nprocs> > swashout &

where <SWASH-command-file-without-extension> is the name of your command file without extension and <nprocs> indicates how many processors need to be launched for a parallel MPI run.

To interactively execute commands within the SWASH container, enter:

apptainer shell swash_latest.sif

Consult this page to explore the possibilities with Apptainer.

Note

Apptainer is compatible with Singularity, implying that you may use the command singularity instead of apptainer.