merge standard release WRF/WPS V3.0.1.1 into wrffire
[wrffire.git] / wrfv2_fire / README.NMM
blob1f1883b68eb8934ea7d1b6d67974742f652c542d
2 WRF-NMM Model Version 3 (April 2008)
4 ----------------------------
5 WRF-NMM PUBLIC DOMAIN NOTICE
6 ----------------------------
8 WRF-NMM was developed at National Centers for
9 Environmental Prediction (NCEP), which is part of
10 NOAA's National Weather Service.  As a government
11 entity, NCEP makes no proprietary claims, either
12 statutory or otherwise, to this version and release of
13 WRF-NMM and consider WRF-NMM to be in the public
14 domain for use by any person or entity for any purpose
15 without any fee or charge. NCEP requests that any WRF
16 user include this notice on any partial or full copies
17 of WRF-NMM. WRF-NMM is provided on an "AS IS" basis
18 and any warranties, either express or implied,
19 including but not limited to implied warranties of
20 non-infringement, originality, merchantability and
21 fitness for a particular purpose, are disclaimed. In
22 no event shall NOAA, NWS or NCEP be liable for any
23 damages, whatsoever, whether direct, indirect,
24 consequential or special, that arise out of or in
25 connection with the access, use or performance of
26 WRF-NMM, including infringement actions.
28 ================================================
30 V3 Release Notes:
31 -----------------
33 This is the main directory for the WRF Version 3 source code release.
35 - For directions on compiling WRF for NMM, see below or the WRF-NMM Users' Web page (http://www.dtcenter.org/wrf-nmm/users/)
36 - Read the README.namelist file in the run/ directory (or on the WRF-NMM Users' page), 
37   and make changes carefully.
39 For questions, send mail to wrfhelp@ucar.edu
41 ======================================
43 The ./compile script at the top level allows for easy selection of 
44 NMM and ARW cores of WRF at compile time. 
46    - Specify your WRF-NMM option by setting the appropriate environment variable:
48            setenv WRF_NMM_CORE 1
49            setenv WRF_NMM_NEST 1 (if nesting capability is desired)
51    - The Registry files for NMM and ARW are not integrated
52      yet. There are separate versions:
54           Registry/Registry.NMM         <-- for NMM
55           Registry/Registry.NMM_NEST    <-- for NMM with nesting
56           Registry/Registry.EM          <-- for ARW (formerly known as Eulerian Mass)
59 How to configure, compile and run?
60 ----------------------------------
62 - In WRFV3 directory, type:
64    configure
66   this will create a configure.wrf file that has appropriate compile 
67   options for the supported computers. Edit your configure.wrf file as needed.
69   Note: WRF requires netCDF library. If your netCDF library is installed in
70         some odd directory, set environment variable NETCDF before you type
71         'configure'. For example: 
73         setenv NETCDF /usr/local/lib32/r4i4
75 - Type: 
76         compile nmm_real
77        
78 - If sucessful, this command will create nmm_real.exe and wrf.exe
79   in directory main/, and the appropriate executables will be linked into
80   the run directories under test/nmm_real, or run/.
82 - cd to the appropriate test or run directory to run "nmm_real.exe" and "wrf.exe".
84 - Place files from WPS (met_nmm.*, geo_nmm_nest*)
85   in the appropriate directory, type
87   real_nmm.exe
89   to produce wrfbdy_d01 and wrfinput_d01. Then type
91   wrf.exe
93   to run.
95 - If you use mpich, type
97   mpirun -np number-of-processors wrf.exe
99 =============================================================================
101 What is in WRF-NMM V3.0?
103 * Dynamics:
105   - The WRF-NMM model is a fully compressible, non-hydrostatic model with a
106     hydrostatic option. 
107   
108   - Supports One-way and two-way static nesting.
110   - The terrain following hybrid pressure sigma vertical coordinate is used. 
111   
112   - The grid staggering is the Arakawa E-grid. 
113   
114   - The same time step is used for all terms.  
116   - Time stepping:
117      - Horizontally propagating fast-waves: Forward-backward scheme
118      - Veryically propagating sound waves: Implicit scheme
120   - Advection (time):
121      T,U,V:
122       - Horizontal: The Adams-Bashforth scheme
123       - Vertical:   The Crank-Nicholson scheme
124      TKE, water species: Forward, flux-corrected (called every two timesteps).
126   - Advection (space):
127      T,U,V:
128       - Horizontal: Energy and enstrophy conserving, 
129       quadratic conservative,second order
130       
131       - Vertical: Quadratic conservative,second order TKE, 
132         
133       - Water species: Upstream, flux-corrected, positive definite, conservative
135   - Horizontal diffusion: Forward, second order "Smagorinsky-type" 
137   - Vertical Diffusion:
138      See "Free atmosphere turbulence above surface layer" section
139      in "Physics" section given in below. 
141 * Physics:
143   - Explicit Microphysics (WRF Single Moment 5 and 6 class /
144     Ferrier (Used operationally at NCEP.)/ Thompson [a new version in 2.2])
146   - Cumulus parameterization (Kain-Fritsch with shallow convection / 
147     Betts-Miller-Janjic (Used operationally at NCEP.)/ Grell-Devenyi ensemble
148     / Simplified Arakawa-Schubert)
149   
150   - Free atmosphere turbulence above surface layer: Mellor-Yamada-Janjic (Used operationally at NCEP.)
151   
152   - Planetary boundary layer: YSU /  Mellor-Yamada-Janjic (Used operationally at NCEP.)
153     / GFS
154   
155   - Surface layer: Similarity theory scheme with viscous sublayers 
156                    over both solid surfaces and water points (Janjic - Used operatinally at NCEP). 
157     / GFS / YSU
159   - Slab soil model: Noah land-surface model (4-level - Used operationally at NCEP) /
160     RUC LSM (6-level) 
162   - Radiation:
163     - Longwave radiation: GFDL Scheme  (Fels-Schwarzkopf) (Used operationally at NCEP.) / RRTM
164     - Shortwave radiation: GFDL-scheme (Lacis-Hansen) (Used operationally at NCEP.) / Dudhia
166   - Gravity wave drag: none
169 * WRF Software:
171   - Hierarchical software architecture that insulates scientific code
172     (Model Layer) from computer architecture (Driver Layer)
173   - Multi-level parallelism supporting shared-memory (OpenMP), distributed-memory (MPI), 
174     and hybrid share/distributed modes of execution
175   - Serial compilation can be used for single-domain runs but not for runs with
176 nesting at this time.
177   - Active data registry: defines and manages model state fields, I/O,
178     configuration, and numerous other aspects of WRF through a single file, 
179     called the Registry
180   - Enhanced I/O options:
181       NetCDF and Parallel HDF5 formats
182       Five auxiliary history output streams separately controllable through the namelist
183       Output file names and time-stamps specifiable through namelist
185   - Testing: Various regression tests are performed on HP/Compaq systems at
186     NCAR/MMM whenever a change is introduced into WRF cores. 
188   - Efficient execution on a range of computing platforms:
189       IBM SP systems, (e.g. NCAR "bluevista","blueice" and NCEP's "blue", Power4-based system)
190       HP/Compaq Alpha/OSF workstation, SMP, and MPP systems (e.g. Pittsburgh 
191          Supercomputing Center TCS)
192       SGI Origin and Altix
193       Linux/Intel
194          IA64 MPP (HP Superdome, SGI Altix, NCSA Teragrid systems)
195          IA64 SMP
196          Pentium 3/4 SMP and SMP clusters (NOAA/FSL iJet system)
197       PGI and Intel compilers supported
198       Alpha Linux (NOAA/FSL Jet system)
199       Sun Solaris (single threaded and SMP)
200       Cray X1
201       HP-UX
202       Other ports under development:
203          NEC SX/6
204          Fujitsu VPP 5000
205   - RSL_LITE: communication layer, scalable to very
206     large domains 
207   - ESMF Time Management, including exact arithmetic for fractional
208     time steps (no drift); model start, stop, run length and I/O frequencies are
209     now specified as times and time intervals 
210   - Improved documentation, both on-line (web based browsing tools) and in-line
212 --------------------------------------------------------------------------