Skip to content
University of Miami Wave Model
Fortran Python Makefile
Branch: master
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
docs
input
namelists
output
restart
src
tools
.gitignore
.gitmodules
.travis.yml
CNAME
CONTRIBUTORS.md
LICENSE
Makefile
PUBLICATIONS.md
README.md
_config.yml
clean.sh

README.md

University of Miami Wave Model (UMWM)

Build Status GitHub issues

A third-generation spectral ocean wave model.

This is the reference implementation of UMWM, described by Donelan et al. (2012). UMWM solves the wave energy balance equation on a curvilinear grid. It has been used to simulate:

  • Global swell and windsea
  • Waves in coastal and hurricane conditions
  • Wave-induced material transport (Stokes drift)
  • Ancient Martian seas and methane lakes on Titan
  • Waves in laboratory settings such as wave tanks

Getting started

Getting the code

git clone --recursive https://github.com/umwm/umwm

System dependencies

  • make
  • cmake
  • GNU, Intel, or Cray Fortran compiler
  • NetCDF for I/O
  • MPI for parallel processing (optional)

Building UMWM

Edit the following variables in the top-level Makefile:

  • FC: Fortran compiler (e.g. mpif90 for parallel builds)
  • FCFLAGS: Flags to pass to the Fortran compiler
  • CPPFLAGS: Pre-processor flags -- set to -DMPI if building for parallel execution, and leave blank for serial builds.

Path to the NetCDF library must be set as NETCDF environment variable. If your library is installed in non-standard directories (something other than $NETCDF/lib for library files and $NETCDF/include for modules) edit the NETCDFLIB and NETCDFINC variables in src/Makefile.

Type make. Executable umwm will be built in the top-level directory. Auxilliary tools executables will be built in tools/. Documentation will be built in docs/.

Running UMWM

Running in serial mode:

./umwm

Running in parallel, for example on 16 cores:

mpiexec -n 16 ./umwm

Read the docs for more information.

Publications

See publications for a full list of publications.

Thanks

UMWM development is currently supported by NSF Award 1745384. It has previously been supported by the Gulf of Mexico Research Initiative and the National Oceanographic Partnership Program.

UMWM has also been improved by a number of open source contributors.

You can’t perform that action at this time.