cp namelist.wps namelist.wps.fire for safekeeping
[WPS-merge.git] / README
blob816a708ec4ae119af9d444c12f16ed4822b6b437
1 WRF Pre-Processing System Version 3.0.1, r.457 (August 4, 2008)
3 http://www.mmm.ucar.edu/wrf/users/
5 The WRF Pre-Processing System (WPS) is a collection
6 of Fortran and C programs that provides data which are
7 input to the real.exe program.  There are three main
8 programs and a number of auxillary programs that
9 are part of WPS.  Both the ARW and NMM dynamical cores
10 in WRF are supported by WPS.
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/contents.html
14 and send email to wrfhelp@ucar.edu.
16 ===================================================
18 Main programs: geogrid.exe, ungrib.exe, metgrid.exe
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.
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 IO API
34 ungrib
35 ------
36 1) Decodes Grib Edition 1 and 2 data
37 2) Uses tables to decide which variables to extract
38 3) Isobaric and generalized vertical coordinates
39 4) Output is in non WRF-API form, referred to as an
40    intermediate format
42 metgrid
43 -------
44 1) Ingest static data and raw met fields
45 2) Horizontally interpolate met fields to the model
46    domain
47 3) Output conforms to WRF IO API
52 Parallelism
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).
63 Grib Edition 2
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.
75 Building WPS
77 Similar to the WRF package, WPS uses a two-step:
78 ./configure
79 ./compile
80 build mechanism, 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 Grib 2" option).  For some OS options,
85 there are multiple compilers that are supported.
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.
92 There are a number of utility programs that will be
93 built in WPS/util/ directory:
95 avg_tsfc.exe
96 ------------
97 purpose: computes a daily mean of the surface air 
98 temperature, reads the namelist.wps file
100 usage:
101 ./avg_tsfc.exe
104 g1print.exe
105 -----------
106 purpose: read a Grib Edition 1 file, output 
107 information to build a Vtable
109 usage:
110 ./g1print.exe GRIB1_file
113 g2print.exe
114 -----------
115 purpose: read a Grib Edition 2 file, output
116 information to build a Vtable
118 usage:
119 ./g2print.exe GRIB2_file
122 mod_levs.exe
123 ------------
124 purpose: reduce levels in a intermediate file
125 so that different Grib sources may be used
126 for the initial and lateral boundary time periods
128 usage:
129 ./mod_levs.exe OLD_intermetdiate:date_string \
130                NEW_intermetdiate:date_string
131 Processes a single file at a time, uses the 
132 pressure levels defined in the namelist.wps file.
134 plotfmt.exe
135 -----------
136 purpose: generate NCAR Graphics metacode 2d
137 horizontal plots of each field and level in the
138 intermediate file
140 usage:
141 ./plotfmt.exe intermediate_file:date_string
144 plotgrids.exe
145 -------------
146 purpose: generate an NCEAR Graphics metacode
147 plot of the domain locations, one frame with
148 all of the domain locations plotted, reads the
149 namelist.wps file to get the domain information
151 usage:
152 ./plotgrids.exe
155 rd_intermediate.exe
156 -------------------
157 purpose: read an intermediate file and print
158 the information to the screen
160 usage:
161 ./rd_intermediate.exe intermediate_file:date_string
166 Static Input Data
168 The static input data is provided in two tar files: one
169 contains full resolution data (30", 2', 5' and 10') and the other
170 contains only 10' low resolution data. The data may be downloaded 
171 from http://www.mmm.ucar.edu/wrf/users/download/get_source.html.
176 Meteorological Input Data
178 The meteorological input data for WPS is the Grib
179 Edition 1 GFS data from NCEP.  A test
180 data set (Jan 2000, 24/12Z to 25/12Z) is available from
181 http://www.mmm.ucar.edu/wrf/users/download/get_source.html.
185 Sample WPS output data for WRF
187 Samples of the output data from WPS for use in WRF for the
188 Jan 2000 and June 2001 cases are provided from
189 http://www.mmm.ucar.edu/wrf/users/download/get_source.html.