Skip to content

Quick Start

JessicaMeixner-NOAA edited this page Mar 20, 2019 · 12 revisions

Quick Start

There are three essential things you need to know to get started with WW3:

Given you know what WW3 and GitHub, this is a quick-start guide to cloning and building WW3.

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

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

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>

Next Steps

  • Once you become familiar with the code and are ready to become a developer, read the Developer Guide and our Coding Best Practices.
  • If you decide to start adding stuff to the WW3 repo before reading the Developer Guide (NOT recommended), we are assuming that you are committing to the following rules shared by our development community:
    • We shall not put any large/binary/netcdf/etc files in the git repo! This makes the git repo large & slow. We use the ftp site for this (let us know if you need to add large/binary files as part of your contribution),
    • See the "Overview" for instructions on how to sign up for the development group email list & info on the monthly development call (info on this sent through email list not through GitHub),
    • See the wiki tab for more in-depth information on any topic. Feel free to update/add to the wiki pages.
    • We use the Roadmap to track upcoming versions,
    • Use Issues to keep track of bugs and developments.

Frequently-Asked Questions

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