WRF OVERVIEW AND

COMPILING PROCESS
Kelly Werner / Dave Gill
NCAR/MMM
February 2019
INTRODUCTION TO WRF

• What is WRF?
• Weather Research and Forecasting Model
• Used for both research and operational forecasting
• Supported community model
• Free & shared resource with distributed development and centralized support

• Current Version: V4.0.3

WRF APPLICATIONS
• Research
• Meteorological case-studies for various applications and scales
• Regional climate and seasonal time-scale
• Air quality, wind energy, hydrology, tropical cyclones, etc.

• Real-time numerical weather prediction (forecasting)

• Idealized simulations
• Data Assimilation (WRFDA)
• Chemistry applications (WRF-Chem) Developed
& supported
• Hydrological coupling (WRF-Hydro) by other groups
• Wildfire Modeling (WRF-Fire)
INTRODUCTION TO WPS

• What is WPS?
• WRF Preprocessing System
• Prepares input to WRF for real-data simulations

• Current Version: V4.0.3

WPS PROGRAMS & THEIR FUNCTIONS

• Geogrid
• Defines simulation domain area
• Produces terrain, landuse, soil type, etc. on the domain

• Ungrib
• De-gribs GRIB-formatted meteorological input data files
• Converts to intermediate format (expected by metgrid)

• Metgrid
• Horizontally interpolates meteorological to WRF model grid
WPS/WRF FLOWCHART

External Data
Sources WRF Preprocessing System WRF Model
Static
Geographical
geogrid
Data

metgrid real wrf

Gridded
Meteorological ungrib
Data
COMPILING WRF/WPS
INSTALLING STEPS

• Check system requirements

• Installing libraries
• Download source data
• Compile WRF
• Compile WPS
• Download initial/BC datasets
SYSTEM REQUIREMENTS

• On what kinds of systems will WRF run?

• Generally any 32- or 64-bit hardware, running a UNIX-like operating system
• You may also use dual-booting into a UNIX-like OS (e.g., Windows with Linux
built parallel)

• Examples of acceptable systems:

• Laptops, desktops, and clusters running Linux
• Laptops and desktops running MacOS X
• Clusters running Unix-like: Linux, AIX
CHECK SYSTEM REQUIREMENTS
• Webpage:
http://www2.mmm.ucar.edu/wrf/OnLineTutorial/compilation_tutorial.php
CHECK SYSTEM REQUIREMENTS
• It is mandatory to have a Fortran
(e.g., gfortran) compiler, a C
compiler, and cpp on your system.
To test whether these exist on
your system, type:
• which gfortran
• which cpp
• which gcc
• If installed, you will be given a path for
each

• Fortran compiler should be

version 4.4.0, or later
• Check this by typing (csh e.g.):
gcc -–version

• Tests available for checking that

your fortran compiler is built
properly, and that it is compatible
with the C compiler.
ADDITIONAL NECESSARY
REQUIREMENTS

• Scripting languages (testing available in test package):

• csh
• perl
• sh

• UNIX Commands
ar awk head sed hostname sleep
cat ls sort tar cd cp
make touch mkdir tr expr mv
wc uname grep rm file printf
nm which
INSTALLING STEPS

• Check system requirements

• Installing libraries
• Download source data
• Compile WRF
• Compile WPS
• Download initial/BC datasets
INSTALLING LIBRARIES
• NetCDF (needed by WRF and WPS)
• netCDF Version 3 or 4 are acceptable
• If using netCDF4 capabilities
http://www2.mmm.ucar.edu/wrf/users/building_netcdf4.html

• Optional libraries for GRIB2 meteorological data support

• JasPer (JPEG 2000 “lossy” compression library)
• PNG (“lossless” compression library)
• Zlib (compression library used by PNG)

• Optional MPI library (for building in parallel):

• MPICH2
INSTALLING LIBRARIES
• Installation of these libraries (MPICH2, NetCDF, JasPer,
zlib, and libpng) is NOT part of the WPS and WRF
installation scripts

• VERY IMPORTANT!
• Make sure these libraries are installed using the same compilers
as will be used to install WRF and WPS

• Downloads for the libraries, with installation

instructions, and library compatibility tests are also
included on the compilation website
BEFORE INSTALLING LIBRARIES:
SET ENVIRONMENT VARIABLES
> setenv DIR directory-where-your-tar-files-are
> setenv CC gcc
> setenv CXX g++
> setenv FC gfortran
> setenv FCFLAGS –m64 # FCFLAGS may be needed on some systems
> setenv F77 gfortran
> setenv FFLAGS –m64 # FFLAGS may be needed on some systems
> setenv LDFLAGS -L$DIR/grib2/lib
> setenv CPPFLAGS –I$DIR/grib2/include

**Keep these set until all libraries are built**

INSTALLING LIBRARIES: NETCDF
> tar xzvf netcdf-4.1.3.tar.gz # no ‘.gz’ if downloaded to
# most Macs
> cd netcdf-4.1.3
>./configure –-prefix=$DIR/netcdf –-disable-dap \
--disable-netcdf-4 -–disable-shared
> make
> make install
> setenv PATH $DIR/netcdf/bin:$PATH
> setenv NETCDF $DIR/netcdf
> cd ..
INSTALLING LIBRARIES: MPICH2
In principle, any implementation of the MPI-2 standard should work
with WRF; however, we have the most experience with MPICH

> tar xzvf mpich-3.0.4.tar.gz # no ‘.gz’ if downloaded to

# most Macs
> cd mpich-3.0.4
> ./configure –-prefix=$DIR/mpich
> make
> make install
> setenv PATH $DIR/mpich/bin:$PATH
> cd ..
INSTALLING LIBRARIES: ZLIB

> tar xzvf zlib-1.2.7.tar.gz # no ‘.gz’ if downloaded to

# most Macs
> cd zlib-1.2.7
>./configure –-prefix=$DIR/zlib
> make
> make install
> cd ..
INSTALLING LIBRARIES: LIBPNG

> tar xzvf libpng-1.2.50.tar.gz # no ‘.gz’ if downloaded to

# most Macs
> cd libpng-1.2.50
>./configure –-prefix=$DIR/libpng
> make
> make install
> cd ..
INSTALLING LIBRARIES: JASPER

> tar xzvf jasper-1.900.1.tar.gz # no ‘.gz’ if downloaded to

# most Macs
> cd jasper-1.900.1
> ./configure –-prefix=$DIR/jasper
> make
> make install
> cd ..
INSTALLING LIBRARIES: COMPATIBILITY
• Make sure libraries are
compatible with compilers

• Test 1
• Fortran + C + netCDF

• Test 2
• Fortran + C + netCDF + MPI
INSTALLING STEPS

• Check system requirements

• Installing libraries
• Download source data
• Compile WRF
• Compile WPS
• Download initial/BC datasets
DOWNLOAD WRF & WPS CODE
• Download WRF & WPS source code from:
http://www2.mmm.ucar.edu/wrf/users/download/get_source.html
• Click ‘New User,’ register and download, or
• Click ‘Returning User,’ enter your email, and go to download information page.

All Code now available

From GitHub!

2 Download Methods:
- Clone from Github
- Download archived
tar file from GitHub
DOWNLOAD WRF & WPS CODE
• Cloning WRF from GitHub repository:

**Must have ‘git’ installed on your system!

 DOWNLOAD STATIC GEOGRAPHICAL DATA
• From the WRF Download page:
http://www2.mmm.ucar.edu/wrf/users/download/get_sources_new.php

Click Here
DOWNLOAD STATIC GEOGRAPHICAL DATA

• Geographical Input and Data Download Page:

http://www2.mmm.ucar.edu/wrf/users/download/get_sources_wps_geog.html

geog_high_res_mandatory.tar.gz
~ 29 GB when
uncompressed

This is the one

you want
STATIC GEOGRAPHICAL DATA: OTHER OPTIONS
• Geographical Input and Data Download Page:
http://www2.mmm.ucar.edu/wrf/users/download/get_sources_wps_geog.html
INSTALLING STEPS

• Check system requirements

• Installing libraries
• Download source data
• Compile WRF
• Compile WPS
• Download initial/BC datasets
CHOOSING A COMPILER
Compiler Compile Time Run Time

GNU 6.3.0 6.82 Mins 3.92 Mins

**FREE**
• Compile
• WRF V4.0
Intel 17.0.1 46.77 Mins 2.20 Min
• dmpar/nesting
• 4 processors
PGI 17.9 28.35 Mins 1.95 Min

• Run
• Single domain
• Small domain (75x70), 30km resolution
• 12 hours
• 8 processors
STEP 1: CONFIGURE FOR WRF
• Inside the WRF/ directory, type: ./configure
CONFIGURE OPTIONS FOR WRF
DEBUGGING OPTIONS OLDER VERSIONS
• ./configure –d • Large-file support
• No optimization • For output files > 2GB
• Extra debugging • Default since V3.9
• Before configuring, set (csh e.g.)
setenv WRFIO_NCD_LARGE_FILE_SUPPORT 1
• ./configure –D
• No optimization
• Checks uninitialized variables, floating
point traps, etc.
• Hybrid coordinate
• Default since V4.0
• Version 3.9 – v3.9.1.1 needs:
• ./configure –r8 • ./configure -hyb
• Double-precision
• Works for GNU, Intel, & PGI compilers
PARALLEL COMPILE OPTION FOR WRF
• To build WRF with multiple compilers, set (csh e.g.):
setenv J “-j2”

# of Processors Time to Compiler

1 17.25 Mins

2 9.95 Mins

3 8.05 Mins

4 6.82 Mins

5 6.32 Mins

6 6.12 Mins

Compiled with GNU V6.3.0

STEP 2: COMPILE WRF
• In the WRF/ directory, type:
./compile em_case >& log.compile

Where em_case is one of the following

(type ./compile to see all options)

em_real (3d real case)

em_hill2d_x
em_quarter_ss em_squall2d_x
em_b_wave em_squall2d_y 2d Ideal
em_les 3d Ideal em_grav2d_x
em_heldsuarez em_seabreeze2d_x
em_tropical_cyclone
em_convrad em_scm_xy (1d ideal)

**Compilation time depends on compiler**

SUCCESSFUL COMPILATION
• If the compilation is successful, you should find these executables in
WRF/main (non-zero size):
Real data case:
wrf.exe - model executable
real.exe – real data initialization
ndown.exe – one-way nesting
tc.exe – for tc bogusing (serial only)

Ideal case:
wrf.exe – model executable
ideal.exe – ideal case initialization
*Note: Each ideal case compile creates a different executable,
but with the same name

• These executables are linked to 2 different directories (WRF/run and

WRF/test/em_real). You can go to either place to run WRF. 36
UNSUCCESSFUL COMPILATION
• Use your ‘log.compile’ file to search for compiler errors!
• Search for Error with a capital E

• Use our Frequently Asked Questions web page for help

• www2.mmm.ucar.edu/wrf/users/FAQ_files/FAQ_wrf_intallation.html

• Visit the wrfhelp Forum:

http://forum.mmm.ucar.edu/

• Before recompiling:
• issue a ‘clean –a’
• Reconfigure: If you need to make changes to the configure.wrf file, do
this after issuing ./configure, and then save the edited file.
• Recompile

37
INSTALLING STEPS

• Check system requirements

• Installing libraries
• Download source data
• Compile WRF
• Compile WPS
• Download initial/BC datasets
INSTALLING STEPS

• Check system requirements

• Installing libraries
• Download source data
• Compile WRF
• Compile WPS  MUST BE BUILT AFTER WRF
• Download initial/BC datasets
STEP 1: CONFIGURE FOR WPS
• Inside the WPS/ directory, type:
./configure

• Choose to compile WPS serially, even if you compile WRF

with a parallel option (unless you have a very large domain)
**NOTE: if you do compile WPS in parallel, ungrib.exe must run
serially

• Output from configuration: a file called ‘configure.wps’ 40

STEP 2: COMPILE WPS

• In the WPS/ directory, type:

./compile >& log.compile

• Compilation should only take a few minutes

• If successful, these executables should be in your WPS/

directory (and they are linked, respectively, from their
source code directories):

geogrid.exe -> geogrid/src/geogrid.exe

ungrib.exe -> ungrib/src/ungrib.exe
metgrid.exe -> metgrid/src/metgrid.exe

41
UNSUCCESSFUL WPS COMPILATION
No geogrid.exe or metgrid.exe

• WPS makes use of the external I/O libraries in the

WRF/external/ directory - The libraries are built when WRF is
installed

• Check that you used the same compiler (and version) as you used
to compile WRF

• Check that you are using the same netCDF that you used to build
WRF

• Have you changed the name or path of the WRF/ directory?

• If so, you need to change the following line in the configure.wps file:
WRF_DIR = ../WRF
• Save the file and recompile

42
UNSUCCESSFUL WPS COMPILATION

No ungrib.exe

• Make sure you have installed your jasper, zlib, and libpng libraries
correctly.

• Make sure that you are using the correct path and format for the
following lines in the configure.wps file
COMPRESSION_LIBS = -L/${DIR}/UNGRIB_LIBRARIES/lib –ljasper –lpng –lz
COMPRESSION_INC = -I/${DIR}/UNGRIB_LIBRARIES/include

Save configure.wps and recompile

43
THE CLEAN COMMAND

• The ‘./clean –a’ command is something that should be used when

you have made corrections to your configure.wrf file, configure.wps
file, or any changes to the registry. If you have made any of these
changes, or if you plan to recompile your code from scratch, you
must issue a ‘clean –a’ before recompiling.

• If you make any changes to any subroutines within the code, you will
need to recompile your code, but you do NOT need to issue the
‘./clean –a’ command, nor do you need to reconfigure. You will
simply just recompile. This compilation should take a lot less time
than a clean compile.

44
INSTALLING STEPS

• Check system requirements

• Installing libraries
• Download source data
• Compile WRF
• Compile WPS
• Download initial/BC datasets
 DOWNLOAD DATASETS
• From the WRF Users’ page: http://www2.mmm.ucar.edu/wrf/users/

Step 1: Click Download,

then scroll down and click
‘Input Data from NCAR’

Step 2: Click the dataset

you wish to use (for this
example, we will use
‘FNL from GFS’)

*Note: The NOMADS site has several types of useful data:

http://nomads.ncdc.noaa.gov
46
DOWNLOAD DATASETS (CONT’D)

Step 3: Register, or sign

in, if you already have
an account

Step 4: Click ‘Data Access’

Step 5: Click ‘Web File

Listing’ for the span of
years you need

47
DOWNLOAD DATASETS (CONT’D)

Step 6: Click ‘Complete

File List’

Step 7: Click the year you need. After this,

You will click the month you need (not shown)

48
DOWNLOAD DATASETS (CONT’D)

Step 9: Once you

have chosen
All your times, click
on the ‘View
Selected Files/Get As
a Tar File’ button
To download one tar
Step 8: Click a box file with all your
for each time Dates/times
span that you need

49
STEPS TO RUN WRF
• Run WPS processes from the WPS/ directory

• cd to WRF/run or WRF/test/em_real

• Link metgrid output files from WPS/ to running directory

• Make appropriate edits to namelist.input file

• Run real.exe: mpirun –np XX ./real.exe

• Run wrf.exe: mpirun –np XX ./wrf.exe

QUESTIONS?

51