CliMA / ClimaShallowWater.jl

2 stars 0 forks source link

ClimaShallowWater.jl

Documentation Build status

This is an implementation of the shallow water equations using ClimaCore.jl.

Installation

You will need an installation of Julia (https://julialang.org/downloads/), and then run

julia --project -e 'using Pkg; Pkg.instantiate()'

to download and install any necessary dependencies.

Running

The main driver file is shallowwater. Run

./shallowwater --help

to see the arguments. The driver will automatically make use of CUDA if a GPU is available.

To run with MPI, the driver can be run inside the MPI launcher:

mpiexec ./shallowater [args]

Note that using CUDA + MPI will require a CUDA-aware MPI installation.

See MPI.jl: Configuration on how to configure MPI.

Post-processing

To generate an animation of the resulting output, use

./create-movie