WRF v2 Software Tools and Documentation

 

This page contains links to tools and documentation for users interested in understanding and working with the WRF software. Please direct questions and problems to the WRF Help Desk, (wrfhelp at ucar dot edu).

 

-- CLICK HERE to read WRF Software Framework testimonials --

 

Online Code and Documentation Utility (updated, unified for WRF v2.1)

 

Functionality from the NCAR-developed WRF Code Database browser and the University of Oklahoma-developed WRF Code Browser have been integrated to provide on-line code and documentation access to WRF version 2.0.3.  The interface is through the Unified WRF Code Browser shown below.  The routine-by-routine “man page” style documents that were a feature of the WRF Code Database browser are now available directly through the OU WRF Code Browser, by clicking on the name of a Subroutine, Function, Program, or Module in its declaration. The older WRF Code Database browser is still available and can be used with v2.0.3 by clicking here.


 


Unified WRFv2.1 Code Browser

 

 

 

Automatically generated from WRF source code using the f90tohtml tool by Brian Fiedler, Rafal Jabrzemski, and Chris Hudgin at the School of Meteorology at the University of Oklahoma.

 

Very rich functionality, including ability to list code directories by both source file and subroutine, color coding of links, and notations of numbers of calls to a subroutine. Main display frames show hyperlink annotated source listings. Clicking on subroutine calls, USE statements, include statements, and other elements displays the information in another frame keeping the original document visible. Many other features, including on-line documentation for the tool itself.

 

Additional functionality from the WRF Code Database browser has been integrated into the code browser: clicking a subprogram name will display man-page information for the subprogram and provide traceback information of arguments back up through the call tree.

 

 

 

 

TOPICS  http://www.lib.chattanooga.gov/localHist/guide.html

·        WRF documentation for Registry-generated code

o        State definition and allocation (html)

 

·        Moving nesting implementation.  (html)

·        Setting/changing WRF tiling using the “set_tiles” routine (html)

·        Information about DEREF_KLUDGE.  (html)

 

 

Additional WRF Software Documentation

 

Documents in this section have been produced through the efforts of the WRF Tiger Team .

 

Description of WRF Registry (click here)

 

Of the 165,000 lines of WRF V2.x source code, some 40,000 lines are automatically generated at compile time using the Registry. This document, by Michalakes (NCAR) and Schaffer (FSL), specifies the semantics for the entries in the WRF Registry (Registry/Registry.EM and Registry/Registry.NMM in the current WRF distribution).

 

WRF I/O and Model Coupling API (click here, Word) (click here, PDF)

 

This is the specification document for the WRF Application Program Interface to external packages providing I/O functionality to the WRF model.  For example, NetCDF is one such package for self-describing data used for WRF input and output datasets. Examples of coupling interfaces include the MCT package from Argonne National Laboratory and the Model Coupling Environment Library from the University of Southern Mississippi (MCT and MCEL are currently experimental interfaces, and are not intended for general use in the WRF 2.0 distribution).

 

Description of WRF Moving Nest Implementation (click here)

 

Draft document, by John Michalakes. This document, designed to be integrated with the Unified WRF Code Browser above, is part of the WRF Training and Documentation Tiger Team-produced documentation.

 

Description of WRF Lateral Boundary Condition I/O (click here)

 

This draft document, by Sundararaman G. Gopalakrishnan of NOAA/NCEP, is part of a comprehensive of WRF Software Developer document being developed by the WRF Training and Documentation Tiger Team.

 

Description of WRF Call Tree, Modules, and Top-level routine

 

These draft contributions to the WRF documentations contributed by Tom Black at NOAA/NCEP as part of Tiger Team activties.

 

Older (pre 2.0) Documentation (click here)

 

The above link points to the Weather Research and Forecast Model 1.2: Software Design and Implementation Document. Though somewhat out of date with WRF 2.0, the document contains useful information.

 

 

 


Page created: May 14, 2004, John Michalakes ( michalak@ucar.edu ), NCAR

Updated: March 14, 2005, John Michalakes