Removing svn revision number from README; "v3.5" should be sufficient for users.
[WPS-merge.git] / README
blobce95840ac12027c1bd6d12059fa9df4742231936
1 WRF Pre-Processing System Version 3.5 (18 April 2013)
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 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.
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.
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 I/O 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) 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
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
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 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.
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.
94 Running WPS (for serially compiled code)
96 geogrid.exe
97 -----------
98 - edit namelist.wps (&share and &geogrid sections)
99 - make sure the correct GEOGRID.TBL is used (ls -l geogrid/GEOGRID.TBL*)
100 - type 'geogrid.exe' to run
101 - check output in geogrid.log
103 ungrib.exe
104 ----------
105 - edit namelist.wps for start_date and end_date, output file prefix 
106   (&share and &ungrib sections)
107 - link correct Vtable:
108   ls -l ungrib/Variable_Tables
109   For example, for NCEP GFS (or AVN, FNL) data,
110   ln -sf ungrib/Variable_Tables/Vtable.GFS Vtable
111 - link grib data files:
112   link_grib.csh /data-directory/file*
113 - type 'ungrib.exe >& ungrib.out' to run
114 - check output in ungrib.log and ungrib.out
116 metgrid.exe
117 -----------
118 - edit namelist.wps (&share and &metgrid sections)
119 - make sure the correct METGRID.TBL is used (ls -l metgrid/METGRID.TBL*)
120 - type 'metgrid.exe' to run
121 - check output in metgrid.log
124 There are a number of utility programs that will be
125 built in WPS/util/ directory:
127 avg_tsfc.exe
128 ------------
129 purpose: computes a daily mean of the surface air 
130 temperature, reads the namelist.wps file
132 usage:
133 avg_tsfc.exe
136 g1print.exe
137 -----------
138 purpose: read a Grib Edition 1 file, output 
139 information to build a Vtable
141 usage:
142 g1print.exe GRIB1_file
145 g2print.exe
146 -----------
147 purpose: read a Grib Edition 2 file, output
148 information to build a Vtable
150 usage:
151 g2print.exe GRIB2_file
154 mod_levs.exe
155 ------------
156 purpose: reduce levels in a intermediate file
157 so that different GRIB sources may be used
158 for the initial and lateral boundary time periods
160 usage:
161 mod_levs.exe OLD_intermetdiate:date_string \
162              NEW_intermetdiate:date_string
163 Processes a single file at a time, uses the 
164 pressure levels defined in the namelist.wps file.
166 plotfmt.exe
167 -----------
168 purpose: generate NCAR Graphics metacode 2d
169 horizontal plots of each field and level in the
170 intermediate file
172 usage:
173 plotfmt.exe intermediate_file:date_string
176 plotgrids.exe
177 -------------
178 purpose: generate an NCEAR Graphics metacode
179 plot of the domain locations, one frame with
180 all of the domain locations plotted, reads the
181 namelist.wps file to get the domain information
183 usage:
184 plotgrids.exe
187 rd_intermediate.exe
188 -------------------
189 purpose: read an intermediate file and print
190 the information to the screen
192 usage:
193 rd_intermediate.exe intermediate_file:date_string
197 calc_ecmwf_p.exe
198 -------------------
199 purpose: when using ECMWF model data in GRIB format,
200 computes the 3-d pressure, height, and RH fields from
201 the output of ungrib.exe, and writes these fields to
202 a new set of intermediate files to be used in addition
203 to those produced by ungrib. All times between the start_date
204 and end_date specified in the &share namelist will be
205 processed.
207 usage:
208 calc_ecmwf_p.exe
212 Static Input Data
214 The static input data is provided in two tar files: one
215 contains full resolution data (30", 2', 5' and 10') and the other
216 contains only 10' low-resolution data. The data may be downloaded 
217 from http://www.mmm.ucar.edu/wrf/users/download/get_source.html.
222 Meteorological Input Data
224 The meteorological input data for WPS is the GRIB
225 Edition 1 GFS data from NCEP.  A test
226 data set (Jan 2000, 24/12Z to 25/12Z) is available from
227 http://www.mmm.ucar.edu/wrf/users/download/get_source.html.
231 Sample WPS output data for WRF
233 Samples of the output data from WPS for use in WRF for the
234 Jan 2000 and June 2001 cases are provided from
235 http://www.mmm.ucar.edu/wrf/users/download/get_source.html.