README

   1 WRF Pre-Processing System Version 3.6 (18 April 2014)
   2
   3 http://www.mmm.ucar.edu/wrf/users/
   4
   5 The WRF Pre-Processing System (WPS) is a collection
   6 of Fortran and C programs that provides data used as
   7 input to the real.exe and real_nmm.exe programs. There
   8 are three main programs and a number of auxillary
   9 programs that are part of WPS.  Both the ARW and NMM
  10 dynamical cores in WRF are supported by WPS.
  11
  12 For questions and help to run the program, please see the
  13 User's Guide at http://www.mmm.ucar.edu/wrf/users/docs/user_guide_V3/contents.html
  14 and send email to wrfhelp@ucar.edu.
  15
  16 ===================================================
  17
  18 Main programs: geogrid.exe, ungrib.exe, metgrid.exe
  19
  20 Input to the main programs is through the namelist
  21 file "namelist.wps".  Each main program has an
  22 exclusive namelist record (named "geogrid", "ungrib",
  23 or "metgrid", respectively), and the three programs
  24 have a group record (named "share") that each program
  25 reads.
  26
  27 geogrid
  28 -------
  29 1) Defines the model horizontal domain
  30 2) Horizontally interpolates static data to the model
  31 domain
  32 3) Output conforms to the WRF I/O API
  33
  34 ungrib
  35 ------
  36 1) Decodes Grib Edition 1 and 2 data
  37 2) Uses tables to decide which variables to extract
  38 3) Supports isobaric and generalized vertical coordinates
  39 4) Output is in a non-WRF-I/O-API form, referred to as an
  40    intermediate format
  41
  42 metgrid
  43 -------
  44 1) Ingest static data and raw meteorological fields
  45 2) Horizontally interpolate meteorological fields to the
  46    model domain
  47 3) Output conforms to WRF I/O API
  48
  49
  50
  51
  52 Parallelism
  53
  54 The geogrid and metgrid programs may be run as
  55 distributed memory parallel jobs to reduce the
  56 time-to-solution.  These two programs use MPI calls
  57 directly, compared to WRF, which has an abstraction
  58 layer (RSL or RSL_LITE).
  59
  60
  61
  62
  63 Grib Edition 2
  64
  65 The Grib Edition 2 compression requires three libraries
  66 external to the WPS source code: zlib, png, and jasper.
  67 It is recommended that users request support from their
  68 system administrators when installing these packages.
  69 Users can compile the code without these libraries by
  70 selecting the "NO GRIB2" options in the build.
  71
  72
  73
  74
  75 Building WPS
  76
  77 Similar to the WRF package, WPS uses a two-step build
  78 mechanism,
  79    ./configure
  80    ./compile
  81 which directs the unix make underneath.
  82 If the user is on a recognized architecture, the
  83 configure script will display a list of available
  84 compile options (usually serial vs parallel, Grib 2
  85 enabled vs a "NO GRIB2" option).  For some OS options,
  86 there are multiple compilers that are supported.
  87
  88 The configure option lists both "build GRIB2" and
  89 "do not build GRIB2" options.  It is suggested that
  90 the first builds be without the GRIB Edition 2
  91 capability.
  92
  93 The utility plotting programs requiring NCAR Graphics are not
  94 compiled automatically. Library paths must be set correctly
  95 in configure.wps and then compiled using
  96 ./compile plotfmt
  97 ./compile plotgrids
  98
  99
 100 Running WPS (for serially compiled code)
 101
 102 geogrid.exe
 103 -----------
 104 - edit namelist.wps (&share and &geogrid sections)
 105 - make sure the correct GEOGRID.TBL is used (ls -l geogrid/GEOGRID.TBL*)
 106 - type 'geogrid.exe' to run
 107 - check output in geogrid.log
 108
 109 ungrib.exe
 110 ----------
 111 - edit namelist.wps for start_date and end_date, output file prefix
 112   (&share and &ungrib sections)
 113 - link correct Vtable:
 114   ls -l ungrib/Variable_Tables
 115   For example, for NCEP GFS (or AVN, FNL) data,
 116   ln -sf ungrib/Variable_Tables/Vtable.GFS Vtable
 117 - link grib data files:
 118   link_grib.csh /data-directory/file*
 119 - type 'ungrib.exe >& ungrib.out' to run
 120 - check output in ungrib.log and ungrib.out
 121
 122 metgrid.exe
 123 -----------
 124 - edit namelist.wps (&share and &metgrid sections)
 125 - make sure the correct METGRID.TBL is used (ls -l metgrid/METGRID.TBL*)
 126 - type 'metgrid.exe' to run
 127 - check output in metgrid.log
 128
 129
 130 There are a number of utility programs that will be
 131 built in WPS/util/ directory:
 132
 133 avg_tsfc.exe
 134 ------------
 135 purpose: computes a daily mean of the surface air
 136 temperature, reads the namelist.wps file
 137
 138 usage:
 139 avg_tsfc.exe
 140
 141
 142 g1print.exe
 143 -----------
 144 purpose: read a Grib Edition 1 file, output
 145 information to build a Vtable
 146
 147 usage:
 148 g1print.exe GRIB1_file
 149
 150
 151 g2print.exe
 152 -----------
 153 purpose: read a Grib Edition 2 file, output
 154 information to build a Vtable
 155
 156 usage:
 157 g2print.exe GRIB2_file
 158
 159
 160 mod_levs.exe
 161 ------------
 162 purpose: reduce levels in a intermediate file
 163 so that different GRIB sources may be used
 164 for the initial and lateral boundary time periods
 165
 166 usage:
 167 mod_levs.exe OLD_intermetdiate:date_string \
 168              NEW_intermetdiate:date_string
 169 Processes a single file at a time, uses the
 170 pressure levels defined in the namelist.wps file.
 171
 172 plotfmt.exe
 173 -----------
 174 purpose: generate NCAR Graphics metacode 2d
 175 horizontal plots of each field and level in the
 176 intermediate file
 177
 178 usage:
 179 plotfmt.exe intermediate_file:date_string
 180
 181
 182 plotgrids.exe
 183 -------------
 184 purpose: generate an NCEAR Graphics metacode
 185 plot of the domain locations, one frame with
 186 all of the domain locations plotted, reads the
 187 namelist.wps file to get the domain information
 188
 189 usage:
 190 plotgrids.exe
 191
 192
 193 rd_intermediate.exe
 194 -------------------
 195 purpose: read an intermediate file and print
 196 the information to the screen
 197
 198 usage:
 199 rd_intermediate.exe intermediate_file:date_string
 200
 201
 202
 203 calc_ecmwf_p.exe
 204 -------------------
 205 purpose: when using ECMWF model data in GRIB format,
 206 computes the 3-d pressure, height, and RH fields from
 207 the output of ungrib.exe, and writes these fields to
 208 a new set of intermediate files to be used in addition
 209 to those produced by ungrib. All times between the start_date
 210 and end_date specified in the &share namelist will be
 211 processed.
 212
 213 usage:
 214 calc_ecmwf_p.exe
 215
 216
 217
 218 Static Input Data
 219
 220 The static input data is provided in two tar files: one
 221 contains full resolution data (30", 2', 5' and 10') and the other
 222 contains only 10' low-resolution data. The data may be downloaded
 223 from http://www.mmm.ucar.edu/wrf/users/download/get_source.html.
 224
 225
 226
 227
 228 Meteorological Input Data
 229
 230 The meteorological input data for WPS is the GRIB
 231 Edition 1 GFS data from NCEP.  A test
 232 data set (Jan 2000, 24/12Z to 25/12Z) is available from
 233 http://www.mmm.ucar.edu/wrf/users/download/get_source.html.
 234
 235
 236
 237 Sample WPS output data for WRF
 238
 239 Samples of the output data from WPS for use in WRF for the
 240 Jan 2000 and June 2001 cases are provided from
 241 http://www.mmm.ucar.edu/wrf/users/download/get_source.html.