This is the UFS weather model source code
Start at the wiki which has quick start instructions.
User's reference guide is hosted on read the docs.
The top level directory structure groups source code and input files as follow:
| File/directory | Purpose |
|---|---|
LICENSE.md |
A copy of the GNU Lesser General Public License, Version 3. |
README.md |
This file with basic pointers to more information. |
AQM/ |
Contains air quality modeling component |
CMEPS-interface/ |
Contains CMEPS mediator |
CICE-interface/ |
Contains CICE sea-ice model component including CICE6 and Icepack |
CDEPS-interface/ |
Contains CDEPS data components, including data-atmosphere (DATM) and data-ocean (DOCN) model components |
FV3/ |
Contains FV3 atmosphere model component including FV3 dynamical core, dynamics to physics driver, physics and IO. |
GOCART/ |
Contains GOCART aerosol model component |
HYCOM-interface/ |
Contains HYCOM ocean model component |
LM4-driver/ |
Contains LM4 land component |
MOM6-interface/ |
Contains MOM6 ocean model component |
NOAHMP-interface/ |
Contains Noah-MP land model component |
WW3/ |
Contains community wave modeling framework WW3 |
stochastic_physics/ |
Contains the stochastic physics source code |
cmake/ |
Contains compile option files on various platforms. |
modulefiles/ |
Contains module files on various platforms. |
tests/ |
Regression and unit testing framework scripts. |
build.sh |
Script to build the model executable (also used by tests/) |
E.g. use of build.sh to build the coupled model with FV3_GFS_v15p2 as the CCPP suite.
$> CMAKE_FLAGS="-DAPP=S2S" CCPP_SUITES="FV3_GFS_v15p2" ./build.sh
The build system is regularly tested with Tier-1 and Tier-2 platforms. Configurations for other platforms that are available with UFS should be used with the understanding that they are not regularly tested and users will have to adapt those to make it work.
The United States Department of Commerce (DOC) GitHub project code is provided on an "as is" basis and the user assumes responsibility for its use. DOC has relinquished control of the information and no longer has responsibility to protect the integrity, confidentiality, or availability of the information. Any claims against the Department of Commerce stemming from the use of its GitHub project will be governed by all applicable Federal law. Any reference to specific commercial products, processes, or services by service mark, trademark, manufacturer, or otherwise, does not constitute or imply their endorsement, recommendation or favoring by the Department of Commerce. The Department of Commerce seal and logo, or the seal and logo of a DOC bureau, shall not be used in any manner to imply endorsement of any commercial product or activity by DOC or the United States Government.