Allow stanza selection and direct option pass-through without user prompt, useful...
[WPS.git] / README
blob230c2709e58b81f278ff0c2b4bdb5e1d2dbd263d
1 WRF Pre-Processing System Version 4.4
3 http://www2.mmm.ucar.edu/wrf/users/
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.
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.
15 ===================================================
17 Main programs: geogrid.exe, ungrib.exe, metgrid.exe
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.
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
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
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
51 Parallelism
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).
62 Grib Edition 2
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.
74 Building WPS
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.
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 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
99 Running WPS (for serially compiled code)
101 geogrid.exe
102 -----------
103 - edit namelist.wps (&share and &geogrid sections)
104 - make sure the correct GEOGRID.TBL is used (ls -l geogrid/GEOGRID.TBL*)
105 - type 'geogrid.exe' to run
106 - check output in geogrid.log
108 ungrib.exe
109 ----------
110 - edit namelist.wps for start_date and end_date, output file prefix 
111   (&share and &ungrib sections)
112 - link correct Vtable:
113   ls -l ungrib/Variable_Tables
114   For example, for NCEP GFS (or AVN, FNL) data,
115   ln -sf ungrib/Variable_Tables/Vtable.GFS Vtable
116 - link grib data files:
117   link_grib.csh /data-directory/file*
118 - type 'ungrib.exe >& ungrib.out' to run
119 - check output in ungrib.log and ungrib.out
121 metgrid.exe
122 -----------
123 - edit namelist.wps (&share and &metgrid sections)
124 - make sure the correct METGRID.TBL is used (ls -l metgrid/METGRID.TBL*)
125 - type 'metgrid.exe' to run
126 - check output in metgrid.log
129 There are a number of utility programs that will be
130 built in WPS/util/ directory:
132 avg_tsfc.exe
133 ------------
134 purpose: computes a daily mean of the surface air 
135 temperature, reads the namelist.wps file
137 usage:
138 avg_tsfc.exe
141 g1print.exe
142 -----------
143 purpose: read a Grib Edition 1 file, output 
144 information to build a Vtable
146 usage:
147 g1print.exe GRIB1_file
150 g2print.exe
151 -----------
152 purpose: read a Grib Edition 2 file, output
153 information to build a Vtable
155 usage:
156 g2print.exe GRIB2_file
159 mod_levs.exe
160 ------------
161 purpose: reduce levels in a intermediate file
162 so that different GRIB sources may be used
163 for the initial and lateral boundary time periods
165 usage:
166 mod_levs.exe OLD_intermetdiate:date_string \
167              NEW_intermetdiate:date_string
168 Processes a single file at a time, uses the 
169 pressure levels defined in the namelist.wps file.
171 plotfmt.exe
172 -----------
173 purpose: generate NCAR Graphics metacode 2d
174 horizontal plots of each field and level in the
175 intermediate file
177 usage:
178 plotfmt.exe intermediate_file:date_string
181 plotgrids.exe
182 -------------
183 purpose: generate an NCEAR Graphics metacode
184 plot of the domain locations, one frame with
185 all of the domain locations plotted, reads the
186 namelist.wps file to get the domain information
188 usage:
189 plotgrids.exe
192 rd_intermediate.exe
193 -------------------
194 purpose: read an intermediate file and print
195 the information to the screen
197 usage:
198 rd_intermediate.exe intermediate_file:date_string
202 calc_ecmwf_p.exe
203 -------------------
204 purpose: when using ECMWF model data in GRIB format,
205 computes the 3-d pressure, height, and RH fields from
206 the output of ungrib.exe, and writes these fields to
207 a new set of intermediate files to be used in addition
208 to those produced by ungrib. All times between the start_date
209 and end_date specified in the &share namelist will be
210 processed.
212 usage:
213 calc_ecmwf_p.exe
217 Static Input Data
219 The static input data is provided in two tar files: one
220 contains full resolution data (30", 2', 5' and 10') and the other
221 contains only 10' low-resolution data. The data may be downloaded 
222 from http://www2.mmm.ucar.edu/wrf/users/download/get_source.html.
227 Meteorological Input Data
229 The meteorological input data for WPS is the GRIB
230 Edition 1 GFS data from NCEP.  A test data set 
231 (Jan 2000, 24/12Z to 25/12Z) is available from
232 http://www2.mmm.ucar.edu/wrf/users/download/get_source.html.
236 Sample WPS output data for WRF
238 Samples of the output data from WPS for use in WRF for the
239 Jan 2000 and June 2001 cases are provided from
240 http://www2.mmm.ucar.edu/wrf/users/download/get_source.html.