WRF & WPS Source Code Description
=================================

Within the top-level WRF and WPS directories are several files and additional directories. Below are descriptions for some of the important components. 

|

.. note::
   *README* files are available throughout the WRF and WPS source code. These files contain helpful information about the code and how to interpret and run specific options. 

|

WRF Directories
---------------

*   **Registry** : contains WRF code data dictionaries that control and define variables, communications, and namelist options
*   **arch** : contains configuration and compile options
*   **chem** : contains code specific to running WRF-chem
*   **cmake** : contains options for using CMake to build the model
*   **confcheck** : contains WRF configuration checks for building the model with CMake
*   **doc** : contains numerous *README* files for different WRF options and programs
*   **dyn_em** : contains files specific to dynamics and numerics
*   **external** : contains external packages, such as for I/O, time-keeping, and MPI
*   **frame** : contains modules for the WRF framework
*   **hydro** : contains code specific to running WRF-Hydro
*   **inc** : contains "include" files
*   **main** : contains the primary rountines (e.g., wrf.F), and executables built during compilation
*   **phys** : contains all physics modules
*   **run** : one of the directories where WRF may be run
*   **share** : primarily contains modules for the WRF mediation layer and wrf I/O
*   **test** : contains test case directories for running WRF
*   **tools** : contains development tools
*   **var** : contains files specific to WRFDA
*   **wrftladj** : contains files specific to WRFDA

|

|

WRF Scripts
-----------

*   **clean** : script that cleans the code when needing to recompile (it does not clean modifications to \*.F files - only cleans files created during the build process)
*   **cleanCMake.sh** : similar to the above, but used when building WRF with CMake
*   **compile** : script to build the WRF code 
*   **compile_new** : script for building the WRF code with CMake
*   **configure** : script to configure compiler and building options prior to compiling WRF
*   **configure_new** : same as above, but used when building WRF with CMake

|

|

|

WPS Directories
---------------

*   **arch** : contains configuration and compile options
*   **cmake** : contains options for using CMake to build WPS
*   **external** : contains external packages, such as for I/O, time-keeping, and MPI
*   **geogrid** : contains code specific to domain setup and interpolation of static fields to the domain
*   **metgrid** : contains code specific to horizontal interpolation of meteorological fields onto the domain
*   **ungrib** : contains code specific to converting meteorological gribbed data into intermediate file format
*   **util** : contains utilities specific to WPS

|

|

WPS Files and Scripts
---------------------

*   **CMakeLists.txt** : a text file used during a WPS build using CMake
*   **README** : a text file containing general information about the WPS
*   **clean** : script that cleans the code when needing to recompile (it does not clean modifications to \*.F files - only cleans files created during the build process)
*   **cleanCMake.sh** : similar to the above *clean* script, but used when building WPS with CMake
*   **compile** : script that builds WPS code
*   **compile_new** : script that builds WPS code using CMake
*   **configure** : script to configure the compiler and building options prior to compiling WPS
*   **configure_new** : same as above, but used when building WPS with CMake
*   **link_grib.csh** : script used to link meterological grib-formatted files to the WPS directory prior to running ungrib.exe
*   **namelist.wps** : a file with all namelist declarations for running WPS
*   **namelist.wps.all_options** : a reference file with all additional namelist options that can be used in namelist.wps
*   **namelist.wps.fire** : a namelist file setup for running WPS for WRF-fire
*   **namelist.wps.global** : a namelist file setup for running a global application of WRF - *NOTE: global WRF applications are no longer recommended. For running global simulations, please use the `MPAS model`_, instead*

|

|

|

|

|

.. rst-class:: horizbuttons-next-m
   :align: right

* `Next: Program Flow ->`_

.. _`MPAS Model`: https://www2.mmm.ucar.edu/mpas/mpas-a-typo3/index.html
.. _`Next: Program Flow ->`: ./program_flow.html