Merge branch 'master' into jm2/perimeter
[wrffire.git] / wrfv2_fire / README
blobf1b9ae396d8cf5c55ee7cafbc761292c91ecd11c
1 WRF Model Version 3.4 (April 6, 2012)
2 http://wrf-model.org/users/users.php
4 ------------------------
5 WRF PUBLIC DOMAIN NOTICE
6 ------------------------
8 WRF was developed at the National Center for Atmospheric Research
9 (NCAR) which is operated by the University Corporation for
10 Atmospheric Research (UCAR). NCAR and UCAR make no proprietary
11 claims, either statutory or otherwise, to this version and
12 release of WRF and consider WRF to be in the public domain for
13 use by any person or entity for any purpose without any fee or
14 charge. UCAR requests that any WRF user include this notice on
15 any partial or full copies of WRF. WRF is provided on an "AS
16 IS" basis and any warranties, either express or implied,
17 including but not limited to implied warranties of
18 non-infringement, originality, merchantability and fitness for a
19 particular purpose, are disclaimed. In no event shall
20 UCAR be liable for any damages, whatsoever, whether direct,
21 indirect, consequential or special, that arise out of or in
22 connection with the access, use or performance of WRF, including
23 infringement actions.
26 ======================================
27 This is the main directory for the WRF Version 3 source code release.
28 ======================================
30 V3.4 Release Notes:
31 -------------------
33 Version 3.4 is released on April 6, 2012 (rev xxxx).
35 - For more information on WRF V3.4 release, visit WRF User's home pages
36   http://www.mmm.ucar.edu/wrf/users/, and
37   http://www.dtcenter.org/wrf-nmm/users/, and read the online User's Guide.
39 ======================================
41 V3.3.1 Release Notes (9/16/11) (rev 5130):
42 -------------------
44 This is a bug fix release. The detailed updates for WRF-ARW can be found at
45 http://www.mmm.ucar.edu/wrf/users/wrfv3.3/updates-3.3.1.html,
46 and for WRF-NMM at
47 http://www.dtcenter.org/wrf-nmm/users/model/wrfv3/updates.php
49 ======================================
51 V3.3 Release Notes:
52 -------------------
54 Version 3.3 is released on April 6, 2011 (rev 4896).
56 - For more information on WRF V3.3 release, visit WRF User's home pages
57   http://www.mmm.ucar.edu/wrf/users/, and
58   http://www.dtcenter.org/wrf-nmm/users/, and read the online User's Guide.
61 ======================================
63 V3.2.1 Release Notes (8/18/10):
64 ------------------
66 This is a bug fix release. The detailed updates for WRF-ARW can be found at
67 http://www.mmm.ucar.edu/wrf/users/wrfv3.2/updates-3.2.1.html, and
68 for WRF-NMM at
69 http://www.dtcenter.org/wrf-nmm/users/model/wrfv3/updates.php
71 See online User's Guides for latest information.
73 ======================================
75 V3.2 Release Notes:
76 -------------------
78 Version 3.2 is released on March 31, 2010.
80 - For more information on WRF V3.2 release, visit WRF User's home pages
81   http://www.mmm.ucar.edu/wrf/users/, and 
82   http://www.dtcenter.org/wrf-nmm/users/, and read the online User's Guide.
85 ======================================
87 V3.1.1 Release Notes (7/31/09):
88 ------------------
90 This is a bug fix release. The detailed updates for WRF-ARW can be found at
91 http://www.mmm.ucar.edu/wrf/users/wrfv3.1/updates-3.1.1.html, and
92 for WRF-NMM at
93 http://www.dtcenter.org/wrf-nmm/users/model/wrfv3/updates.php
95 See online User's Guides for latest information.
97 ======================================
99 V3.1 Release Notes:
100 -------------------
102 Version 3.1 is released on April 9, 2009.
104 - For more information on WRF V3.1 release, visit WRF Users home page
105   http://www.mmm.ucar.edu/wrf/users/, and read the online User's Guide.
106 - WRF V3 executable will work with V3.0 wrfinput/wrfbdy (but requires 
107   inserting a new namelist variable use_baseparam_fr_nml in &dynamics). As
108   always, rerunning the new programs is recommended.
109 - WRF V3.1 has changed a number of namelists. For example, ucmcall has
110   become sf_urban_physics, pd_moist(scalar/tke/chem) has become 
111   moist_adv_opt (scalar/tke/chem_adv_opt). Helpful messages will be printed
112   to aid you.
115 V3.0.1.1 Release Notes:
116 -----------------------
118 Version 3.0.1.1 has only limited bug fixes compared to version 3.0.1.
119 The detailed updates for WRF-ARW can be found at
120 http://www.mmm.ucar.edu/wrf/users/wrfv3/updates-3.0.1.1.html.
123 V3.0.1 Release Notes:
124 ---------------------
126 This is a bug fix release. The detailed updates for WRF-ARW can be found at
127 http://www.mmm.ucar.edu/wrf/users/wrfv3/updates-3.0.1.html.
129 Online User's Guides have also been updated.
131 ======================================
133 V3.0 Release Notes:
134 ------------------
136 - For directions on compiling WRF, see below or Users Web page.
137 - For more information on WRF V3 release, visit WRF Users home page
138   http://www.mmm.ucar.edu/wrf/users/
139 - WRF V3 works with WPS, and SI is no longer supported. 
140   Please see User' Guide for WPS.
141 - WRF V3 executable does not work with wrfinput/wrfbdy produced by previous versions.
142 - WRF V3 has removed one obsolete namelist variable, dyn_opt. Edit with caution.
144 ======================================
146 WRF update history:
148 - V2.0.1: May 21, 2004
149 - V2.0.2: June 3, 2004
150 - V2.0.3: Nov 12, 2004 
151   V2.0.3.1: Dec 3, 2004
152 - V2.1: August 4, 2005
153 - V2.1.1: Nov 8, 2005
154 - V2.1.2: Jan 27, 2006
155 - V2.2: Dec 21, 2006
156 - V2.2.1: Nov 1, 2007
157 - V3.0: April 4, 2008
158 - V3.0.1: August 5, 2008
159 - V3.0.1.1: August 22, 2008
160 - V3.1: April 9, 2009
161 - V3.1.1: July 31, 2009
162 - V3.2: March 31, 2010
163 - V3.2.1: August 18, 2010
164 - V3.3: April 6, 2011
165 - V3.3.1: Sept 16, 2011
167 ======================================
169 How to compile and run?
170 -----------------------
172 - In WRFV3 directory, type 'configure' - this will create a configure.wrf
173   file that has appropriate compile options for the supported computers.
175   Note: WRF requires netCDF library. If your netCDF library is installed in
176         some odd directory, set environment variable NETCDF before you type
177         'configure'. For example, 
179         setenv NETCDF /usr/local/netcdf-pgi
181 - Type 'compile case_name' where you can find the case_names by simply typing
182   compile. The following are available:
184       compile em_b_wave
185       compile em_grav2d_x
186       compile em_heldsuarez
187       compile em_hill2d_x
188       compile em_les
189       compile em_quarter_ss
190       compile em_real
191       compile em_seabreeze2d_x
192       compile em_squall2d_x
193       compile em_squall2d_y
194       compile em_scm_xy
195       compile em_tropical_cyclone
197   Notes: 1. If you are going to create model output file that is more than 2Gb,
198       you should consider using netCDF large file support function. To activate
199       this, one must set the environment variable WRFIO_NCD_LARGE_FILE_SUPPORT.
200       In c-shell environment, do
202       setenv WRFIO_NCD_LARGE_FILE_SUPPORT 1
204       2. Since V3.2, we support using multiple processors for compilation. The
205       default number of processors used is 2. But if you have any problem with
206       compilation, please try using one processor to compile. To do this, set
207       the following environment variable before compile:
209       setenv J "-j 1"
211 - If sucessful, this will create either real.exe or ideal.exe and wrf.exe
212   in directory main/, and the appropriate executables will be linked into
213   the test directoires under test/case_name, or run/.
215 - cd to the appropriate test or run directory to run ideal/real/wrf.
217 - If it is one of the idealized cases (b_wave, hill2d_x, grav2d_x, quarter_ss,
218   squall2d_x, squall2d_y, em_les or em_heldsuarez), cd the the appropriate directory, type
220   ./ideal.exe 
222   to produce wrfinput_d01 file for wrf model. Then type
224   ./wrf.exe 
226   to run. 
228 - If it is real-data case (real), place files from WPS (met_em.*)
229   in the appropriate directory, type
231   ./real.exe
233   to produce wrfbdy_d01 and wrfinput_d01. Then type
235   ./wrf.exe
237   to run.
239 - If you use mpich, type
241   mpirun -np number-of-processors wrf.exe
243 - For information on how to make nested runs, visit
244   http://www.mmm.ucar.edu/wrf/users/
247 ======================================
249 What is in WRF V3?
251 - Advanced Research WRF (ARW) solver: Eulerian mass, hydrostatic and non-hydrostatic
252   * Arakawa C-grid staggering
253   * Runge-Kutta 2nd and 3rd order timestep options
254   * scalar-conserving flux form for prognostic variables
255   * 2nd to 6th order advection options (horizontal and vertical)
256   * time-split small step for acoustic modes
257   * small step horizontally explicit, vertically implicit
258   * divergence damping option and vertical time off-centering
259   * external-mode filtering option for mass model
260   * hydrostatic option via namelist option
261   * positive-definite and monotonic advection for moisture, scalar, tke and chemical tracers
262   * global modeling capability on latitude-longitude grid
263   * digital filter initialization
265 - Two-way nesting:
266   * multiple domains and multiple nest levels
267   * supports integer nest grid ratio
268   * feedback option for both odd and even nest grid ratios 
269   * smoothing options
271 - One-way nesting 
273 - Moving nest 
274   * Specified move
275   * Automatic move using a mid-level vortex-following algorithm
277 - Physics options:
278   * microphysics (Kessler/ WRF Single Moment 3, 5 and 6 classes / Lin et al./ Mibrandt 2-moment /
279     Eta Ferrier / Thompson / Goddard / 2-moment Morrison / WRF Double Moment 5 and 6 classes /
280     SBU-Lin 5-classes / NSSL 2-moment )
281   * cumulus parameterization (Kain-Fritsch with shallow convection / 
282     Betts-Miller-Janjic / Grell-Devenyi ensemble / New Grell (with shallow convection option) /
283     Tiedtke (with shallow conv and momentum transport) / NSAS (with shallow conv and momentum transport) /
284     SAS (with shallow conv for ARW) / Zhang-McFarlane (with momentum transport) )
285   * UW shallow convection
286   * planetary boundary layer (Yosei University / Mellor-Yamada-Janjic / ACM2 / QNSE-EDMF / MYNN / 
287     BouLac / UW / TEMF )
288   * slab soil model (5-layer thermal diffusion / Noah land-surface model (4 levels) /
289     RUC LSM (6 levels) / Pleim-Xu (2 levels / Noah-MP (4 levels) / SSiB (3 levels) )
290   * Urban canopy model, BEP multi-layer and BEM  (works with Noah LSM, BEP and 
291     BEM also requires MYJ or BouLac)
292   * longwave radiation (RRTM / CAM / RRTMG / new Goddard / FLG )
293   * shortwave radiation (Dudhia / old Goddard / CAM / RRTMG / new Goddard / FLG ), 
294     terrain slope and shading effect
295   * sub-grid turbulence (constant K diffusion/ 2-D Smagorinsky/ predicted TKE /
296     2-D, 6th order diffusion / Nonlinear Backscatter Anisotropic (NBA) sub-grid turbulence stress for LES )
297   * Rayleigh damping for w at the upper boundary layer
298   * gravity wave drag
299   * land-use categories determine surface properties; support for 24 category USGS and 
300     20 category MODIS (Noah LSM only in V3.1)
301   * Options for modifying SST, sea ice, vegetation fraction, albedo, and deep soil temp
302     for long simulations
303   * fractional sea ice option for polar regions; modified snow/ice physics
304   * single-column ocean mixed layer model
305   * drag and enthalpy flux formulation for hurricane applications
307 - Nudging:
308   * three-dimensional and surface analysis nudging 
309   * observation nudging 
310   * spectral nudging
312 - Software
314   * Hierarchical software architecture that insulates scientific code
315     (Model Layer) from computer architecture (Driver Layer)
316   * Multi-level parallelism supporting shared-memory (OpenMP), distributed-memory (MPI), 
317     and hybrid share/distributed modes of execution
318   * Active data registry: defines and manages model state fields, I/O,
319     nesting, configuration, and numerous other aspects of WRF through a single file, 
320     called the Registry
321   * Two-way nesting:
322       Easy to extend: forcing and feedback of new fields specified by
323         editing a single table in the Registry
324       Efficient: 5-8% overhead on 64 processes of IBM
325       Moving nests.
326   * Enhanced I/O options:
327       NetCDF and Parallel HDF5 formats
328       Nine auxiliary input and history output streams separately controllable through the namelist
329       Special input streams for analysis and observation nudging
330       Output file names and time-stamps specifiable through namelist
331       Special output stream for 3DVAR
332   * Efficient execution on a range of computing platforms:
333       IBM SP systems, (e.g. NCAR "bluevista","blueice","bluefire" Power5-based system)
334       IBM Blue Gene
335       SGI Origin and Altix
336       Linux/Intel
337          IA64 MPP (HP Superdome, SGI Altix, NCSA Teragrid systems)
338          IA64 SMP
339          x86_64 (e.g. TACC's "Ranger", NOAA/GSD "wJet" )
340          PGI, Intel, Pathscale, gfortran, g95 compilers supported
341       Sun Solaris (single threaded and SMP)
342       Cray X1, X1e (vector), XT3/4 (Opteron)
343       Mac Intel/ppc, PGI/ifort/g95
344       NEC SX/8
345       HP-UX
346       Fujitsu VPP 5000
347   * RSL_LITE: communication layer, scalable to very large domains, supports nesting.
348   * I/O: NetCDF, parallel NetCDF (Argonne), HDF5, GRIB, raw binary, Quilting (asynchronous I/O), MCEL (coupling)
349   * ESMF Time Management, including exact arithmetic for fractional
350     time steps (no drift).
351   * ESMF integration - WRF can be run as an ESMF component.
352   * Improved documentation, both on-line (web based browsing tools) and in-line