README

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