Fixed the error checkings in line_interp and four_pnts_interp
[wrffire.git] / wrfv2_fire / README
blobeaa9bb4deafe4d8b01f55799608289fb89c787f2
1 WRF Model Version 3.2.1 (August 18, 2010)
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.2.1 Release Notes (8/18/10):
31 ------------------
33 This is a bug fix release. The detailed updates for WRF-ARW can be found at
34 http://www.mmm.ucar.edu/wrf/users/wrfv3.2/updates-3.2.1.html, and
35 for WRF-NMM at
36 http://www.dtcenter.org/wrf-nmm/users/model/wrfv3/updates.php
38 See online User's Guides for latest information.
40 ======================================
42 V3.2 Release Notes:
43 -------------------
45 Version 3.2 is released on March 31, 2010.
47 - For more information on WRF V3.2 release, visit WRF User's home pages
48   http://www.mmm.ucar.edu/wrf/users/, and 
49   http://www.dtcenter.org/wrf-nmm/users/, and read the online User's Guide.
52 ======================================
54 V3.1.1 Release Notes (7/31/09):
55 ------------------
57 This is a bug fix release. The detailed updates for WRF-ARW can be found at
58 http://www.mmm.ucar.edu/wrf/users/wrfv3.1/updates-3.1.1.html, and
59 for WRF-NMM at
60 http://www.dtcenter.org/wrf-nmm/users/model/wrfv3/updates.php
62 See online User's Guides for latest information.
64 ======================================
66 V3.1 Release Notes:
67 -------------------
69 Version 3.1 is released on April 9, 2009.
71 - For more information on WRF V3.1 release, visit WRF Users home page
72   http://www.mmm.ucar.edu/wrf/users/, and read the online User's Guide.
73 - WRF V3 executable will work with V3.0 wrfinput/wrfbdy (but requires 
74   inserting a new namelist variable use_baseparam_fr_nml in &dynamics). As
75   always, rerunning the new programs is recommended.
76 - WRF V3.1 has changed a number of namelists. For example, ucmcall has
77   become sf_urban_physics, pd_moist(scalar/tke/chem) has become 
78   moist_adv_opt (scalar/tke/chem_adv_opt). Helpful messages will be printed
79   to aid you.
82 V3.0.1.1 Release Notes:
83 -----------------------
85 Version 3.0.1.1 has only limited bug fixes compared to version 3.0.1.
86 The detailed updates for WRF-ARW can be found at
87 http://www.mmm.ucar.edu/wrf/users/wrfv3/updates-3.0.1.1.html.
90 V3.0.1 Release Notes:
91 ---------------------
93 This is a bug fix release. The detailed updates for WRF-ARW can be found at
94 http://www.mmm.ucar.edu/wrf/users/wrfv3/updates-3.0.1.html.
96 Online User's Guides have also been updated.
98 ======================================
100 V3.0 Release Notes:
101 ------------------
103 - For directions on compiling WRF, see below or Users Web page.
104 - For more information on WRF V3 release, visit WRF Users home page
105   http://www.mmm.ucar.edu/wrf/users/
106 - WRF V3 works with WPS, and SI is no longer supported. 
107   Please see User' Guide for WPS.
108 - WRF V3 executable does not work with wrfinput/wrfbdy produced by previous versions.
109 - WRF V3 has removed one obsolete namelist variable, dyn_opt. Edit with caution.
111 ======================================
113 WRF update history:
115 - V2.0.1: May 21, 2004
116 - V2.0.2: June 3, 2004
117 - V2.0.3: Nov 12, 2004 
118   V2.0.3.1: Dec 3, 2004
119 - V2.1: August 4, 2005
120 - V2.1.1: Nov 8, 2005
121 - V2.1.2: Jan 27, 2006
122 - V2.2: Dec 21, 2006
123 - V2.2.1: Nov 1, 2007
124 - V3.0: April 4, 2008
125 - V3.0.1: August 5, 2008
126 - V3.0.1.1: August 22, 2008
127 - V3.1: April 9, 2009
128 - V3.1.1: July 31, 2009
129 - V3.2: March 31, 2010
131 ======================================
133 How to compile and run?
134 -----------------------
136 - In WRFV3 directory, type 'configure' - this will create a configure.wrf
137   file that has appropriate compile options for the supported computers.
139   Note: WRF requires netCDF library. If your netCDF library is installed in
140         some odd directory, set environment variable NETCDF before you type
141         'configure'. For example, 
143         setenv NETCDF /usr/local/netcdf-pgi
145 - Type 'compile case_name' where you can find the case_names by simply typing
146   compile. The following are available:
148       compile em_b_wave
149       compile em_grav2d_x
150       compile em_heldsuarez
151       compile em_hill2d_x
152       compile em_les
153       compile em_quarter_ss
154       compile em_real
155       compile em_seabreeze2d_x
156       compile em_squall2d_x
157       compile em_squall2d_y
158       compile em_scm_xy
160 - If sucessful, this will create either real.exe or ideal.exe and wrf.exe
161   in directory main/, and the appropriate executables will be linked into
162   the test directoires under test/case_name, or run/.
164 - cd to the appropriate test or run directory to run ideal/real/wrf.
166 - If it is one of the idealized cases (b_wave, hill2d_x, grav2d_x, quarter_ss,
167   squall2d_x, squall2d_y, em_les or em_heldsuarez), cd the the appropriate directory, type
169   ./ideal.exe 
171   to produce wrfinput_d01 file for wrf model. Then type
173   ./wrf.exe 
175   to run. 
177 - If it is real-data case (real), place files from WPS (met_em.*)
178   in the appropriate directory, type
180   ./real.exe
182   to produce wrfbdy_d01 and wrfinput_d01. Then type
184   ./wrf.exe
186   to run.
188 - If you use mpich, type
190   mpirun -np number-of-processors wrf.exe
192 - For information on how to make nested runs, visit
193   http://www.mmm.ucar.edu/wrf/users/
196 ======================================
198 What is in WRF V3?
200 - Advanced Research WRF (ARW) solver: Eulerian mass, hydrostatic and non-hydrostatic
201   * Arakawa C-grid staggering
202   * Runge-Kutta 2nd and 3rd order timestep options
203   * scalar-conserving flux form for prognostic variables
204   * 2nd to 6th order advection options (horizontal and vertical)
205   * time-split small step for acoustic modes
206   * small step horizontally explicit, vertically implicit
207   * divergence damping option and vertical time off-centering
208   * external-mode filtering option for mass model
209   * hydrostatic option via namelist option
210   * positive-definite and monotonic advection for moisture, scalar, tke and chemical tracers
211   * global modeling capability on latitude-longitude grid
213 - Two-way nesting:
214   * multiple domains and multiple nest levels
215   * supports integer nest grid ratio
216   * feedback option for both odd and even nest grid ratios 
217   * smoothing options
219 - One-way nesting 
221 - Moving nest 
222   * Specified move
223   * Automatic move using a mid-level vortex-following algorithm
225 - Physics options:
226   * microphysics (Kessler/ WRF Single Moment 3, 5 and 6 classes / Lin et al./ Mibrandt 2-moment /
227     Eta Ferrier / Thompson / Goddard / 2-moment Morrison / WRF Double Moment 5 and 6 classes )
228   * cumulus parameterization (Kain-Fritsch with shallow convection / 
229     Betts-Miller-Janjic / Grell-Devenyi ensemble / New Grell (with shallow convection option) )
230   * planetary boundary layer (Yosei University / Mellor-Yamada-Janjic / ACM2 / QNSE / MYNN / BouLac )
231   * surface layer (similarity theory MM5 / Eta / QNSE / MYNN )
232   * slab soil model (5-layer thermal diffusion / Noah land-surface model (4 levels) /
233     RUC LSM (6 levels) / Pleim-Xu (2 levels)
234   * Urban canopy model, BEP multi-layer and BEM  (works with Noah LSM, BEP and 
235     BEM also requires MYJ or BouLac)
236   * longwave radiation (RRTM / CAM / RRTMG)
237   * shortwave radiation (simple MM5 scheme / Goddard / CAM / RRTMG ), terrain slope and shading effect
238   * sub-grid turbulence (constant K diffusion/ 2-D Smagorinsky/ predicted TKE /
239     2-D, 6th order diffusion / Nonlinear Backscatter Anisotropic (NBA) sub-grid turbulence stress for LES )
240   * Rayleigh damping for w at the upper boundary layer
241   * gravity wave drag
242   * land-use categories determine surface properties; support for 24 category USGS and 
243     20 category MODIS (Noah LSM only in V3.1)
244   * Options for modifying SST, sea ice, vegetation fraction, albedo, and deep soil temp
245     for long simulations
246   * fractional sea ice option for polar regions; modified snow/ice physics
247   * single-column ocean mixed layer model
248   * drag and enthalpy flux formulation for hurricane applications
250 - Nudging:
251   * three-dimensional and surface analysis nudging 
252   * observation nudging 
253   * spectral nudging
255 - Software
257   * Hierarchical software architecture that insulates scientific code
258     (Model Layer) from computer architecture (Driver Layer)
259   * Multi-level parallelism supporting shared-memory (OpenMP), distributed-memory (MPI), 
260     and hybrid share/distributed modes of execution
261   * Active data registry: defines and manages model state fields, I/O,
262     nesting, configuration, and numerous other aspects of WRF through a single file, 
263     called the Registry
264   * Two-way nesting:
265       Easy to extend: forcing and feedback of new fields specified by
266         editing a single table in the Registry
267       Efficient: 5-8% overhead on 64 processes of IBM
268       Moving nests.
269   * Enhanced I/O options:
270       NetCDF and Parallel HDF5 formats
271       Nine auxiliary input and history output streams separately controllable through the namelist
272       Special input streams for analysis and observation nudging
273       Output file names and time-stamps specifiable through namelist
274       Special output stream for 3DVAR
275   * Efficient execution on a range of computing platforms:
276       IBM SP systems, (e.g. NCAR "bluevista","blueice","bluefire" Power5-based system)
277       IBM Blue Gene
278       SGI Origin and Altix
279       Linux/Intel
280          IA64 MPP (HP Superdome, SGI Altix, NCSA Teragrid systems)
281          IA64 SMP
282          x86_64 (e.g. TACC's "Ranger", NOAA/GSD "wJet" )
283          PGI, Intel, Pathscale, gfortran, g95 compilers supported
284       Sun Solaris (single threaded and SMP)
285       Cray X1, X1e (vector), XT3/4 (Opteron)
286       Mac Intel/ppc, PGI/ifort/g95
287       NEC SX/8
288       HP-UX
289       Fujitsu VPP 5000
290   * RSL_LITE: communication layer, scalable to very large domains, supports nesting.
291   * I/O: NetCDF, parallel NetCDF (Argonne), HDF5, GRIB, raw binary, Quilting (asynchronous I/O), MCEL (coupling)
292   * ESMF Time Management, including exact arithmetic for fractional
293     time steps (no drift).
294   * ESMF integration - WRF can be run as an ESMF component.
295   * Improved documentation, both on-line (web based browsing tools) and in-line