Skip to content

Quick Start for Users

Jessica Meixner edited this page Jul 12, 2023 · 18 revisions

Quick Start for Users

This quick start for users is describing how to run the public release version 6.07.1.

Users may access and install the WAVEWATCH III® software package in two ways:

  • Clone the WW3 GitHub repo, or
  • Download the tar bundle.

Installing from the GitHub clone

Note that the WW3 package has two parts that need to be combined if you want to run the regression tests: the GitHub repo itself and a binary data file bundle that needs to be obtained from our ftp site. To do that follow the steps below.

Step 1: Clone the repo and checkout the Public Release

git clone -b 6.07.1 https://github.com/NOAA-EMC/WW3

If you are using ssh:

git clone -b 6.07.1 ssh://git@github.com/NOAA-EMC/WW3

cd WW3

Note the "-b 6.07.1" checks out the public release v6.07. We recommend for users to use the latest public release or the main branch.

Step 2: Download and expand large/binary/netcdf files

cd WW3

sh model/bin/ww3_from_ftp.sh

Step 3: Set up your model environment

./model/bin/w3_setup model -c <comp> -s <switch>

Run the command without options to see usage.

Step 4: Compile the code

cd model/bin

./w3_automake

Frequently-Asked Questions

We will be regularly updating a FAQs page with answers to common questions.

For information on contributing development back to WW3, please see the Development Portal