README

   1 WRF Model Version 4.5
   2
   3 https://www2.mmm.ucar.edu/wrf/users/
   4
   5 ------------------------
   6 WRF PUBLIC DOMAIN NOTICE
   7 ------------------------
   8
   9 WRF was developed at the National Center for Atmospheric Research
  10 (NCAR) which is operated by the University Corporation for
  11 Atmospheric Research (UCAR). NCAR and UCAR make no proprietary
  12 claims, either statutory or otherwise, to this version and
  13 release of WRF and consider WRF to be in the public domain for
  14 use by any person or entity for any purpose without any fee or
  15 charge. UCAR requests that any WRF user include this notice on
  16 any partial or full copies of WRF. WRF is provided on an "AS
  17 IS" basis and any warranties, either express or implied,
  18 including but not limited to implied warranties of
  19 non-infringement, originality, merchantability and fitness for a
  20 particular purpose, are disclaimed. In no event shall
  21 UCAR be liable for any damages, whatsoever, whether direct,
  22 indirect, consequential or special, that arise out of or in
  23 connection with the access, use or performance of WRF, including
  24 infringement actions.
  25
  26
  27 ======================================
  28 This is the main directory for the WRF Version 4 source code release.
  29 ======================================
  30
  31 Other README files are located in the WRF/doc directory:
  32 doc/README.crtm
  33 doc/README.CTSM
  34 doc/README.cygwin.md
  35 doc/README.DA
  36 doc/README.hybrid_vert_coord
  37 doc/README.hydro
  38 doc/README.io_config
  39 doc/README.irr_diag
  40 doc/README.madwrf
  41 doc/README.NMM
  42 doc/README.rsl_output
  43 doc/README.SSIB
  44 doc/README_test_cases
  45 doc/README.windturbine
  46 doc/README.WRFPLUS
  47
  48 - Beginning with version 4.0, for more information on the releases, visit
  49   the WRF GitHub Release Page:
  50   https://github.com/wrf-model/WRF/releases
  51
  52
  53
  54 V3.9.1.1 Release Notes (8/28/17):
  55 -------------------
  56
  57 - Version 3.9.1.1 has only limited bug fixes compared to version 3.9.1.
  58   For more information on WRF V3.9.1.1 release, visit WRF User's home pages
  59   http://www2.mmm.ucar.edu/wrf/users/, and
  60   http://www.dtcenter.org/wrf-nmm/users/, and read the online User's Guide.
  61
  62
  63 V3.9.1 Release Notes (8/17/17):
  64 -------------------
  65
  66 - For more information on WRF V3.9.1 release, visit WRF User's home pages
  67   http://www2.mmm.ucar.edu/wrf/users/, and
  68   http://www.dtcenter.org/wrf-nmm/users/, and read the online User's Guide.
  69
  70
  71 V3.9 Release Notes (4/17/17):
  72 -------------------
  73
  74 - For more information on WRF V3.9 release, visit WRF User's home pages
  75   http://www2.mmm.ucar.edu/wrf/users/, and
  76   http://www.dtcenter.org/wrf-nmm/users/, and read the online User's Guide.
  77
  78
  79 V3.8.1 Release Notes (8/12/16) (rev 9553):
  80 -------------------
  81
  82 - For more information on WRF V3.8.1 release, visit WRF User's home pages
  83   http://www2.mmm.ucar.edu/wrf/users/, and
  84   read the online User's Guide.
  85
  86 V3.8 Release Notes (4/8/16) (rev 9345):
  87 -------------------
  88
  89 - For more information on WRF V3.8 release, visit WRF User's home pages
  90   http://www2.mmm.ucar.edu/wrf/users/, and
  91   http://www.dtcenter.org/wrf-nmm/users/, and read the online User's Guide.
  92
  93 V3.7.1 Release Notes (8/14/15) (rev 8584):
  94 -------------------
  95
  96 - For more information on WRF V3.7.1 release, visit WRF User's home pages
  97   http://www2.mmm.ucar.edu/wrf/users/
  98
  99 V3.7 Release Notes (4/17/15) (rev 8345):
 100 -------------------
 101
 102 - For more information on WRF V3.7 release, visit WRF User's home pages
 103   http://www2.mmm.ucar.edu/wrf/users/, and
 104   http://www.dtcenter.org/wrf-nmm/users/, and read the online User's Guide.
 105
 106 V3.6.1 Release Notes (8/14/14) (rev 7630):
 107 -------------------
 108
 109 - For more information on WRF V3.6.1 release, visit WRF User's home pages
 110   http://www2.mmm.ucar.edu/wrf/users/, and
 111   http://www.dtcenter.org/wrf-nmm/users/, and read the online User's Guide.
 112
 113 V3.6 Release Notes (4/18/14) (rev 7412):
 114 -------------------
 115
 116 - For more information on WRF V3.6 release, visit WRF User's home pages
 117   http://www2.mmm.ucar.edu/wrf/users/, and
 118   http://www.dtcenter.org/wrf-nmm/users/, and read the online User's Guide.
 119
 120 ======================================
 121
 122 V3.5.1 Release Notes (9/23/13) (rev 6868):
 123 -------------------
 124
 125 - For more information on WRF V3.5.1 release, visit WRF User's home pages
 126   http://www2.mmm.ucar.edu/wrf/users/, and
 127   http://www.dtcenter.org/wrf-nmm/users/, and read the online User's Guide.
 128
 129 ======================================
 130
 131 V3.5 Release Notes (4/18/13) (rev 6660):
 132 -------------------
 133
 134 - For more information on WRF V3.5 release, visit WRF User's home pages
 135   http://www2.mmm.ucar.edu/wrf/users/, and
 136   http://www.dtcenter.org/wrf-nmm/users/, and read the online User's Guide.
 137
 138 ======================================
 139
 140 V3.4.1 Release Notes (8/16/12) (rev 5930):
 141 -------------------
 142
 143 This is a bug fix release. The detailed updates for WRF-ARW can be found at
 144 http://www2.mmm.ucar.edu/wrf/users/wrfv3.4/updates-3.4.1.html,
 145 and for WRF-NMM at
 146 http://www.dtcenter.org/wrf-nmm/users/model/wrfv3/updates.php
 147
 148 ======================================
 149
 150 V3.4 Release Notes:
 151 -------------------
 152
 153 Version 3.4 is released on April 6, 2012 (rev 5745).
 154
 155 - For more information on WRF V3.4 release, visit WRF User's home pages
 156   http://www2.mmm.ucar.edu/wrf/users/, and
 157   http://www.dtcenter.org/wrf-nmm/users/, and read the online User's Guide.
 158
 159 ======================================
 160
 161 V3.3.1 Release Notes (9/16/11) (rev 5130):
 162 -------------------
 163
 164 This is a bug fix release. The detailed updates for WRF-ARW can be found at
 165 http://www2.mmm.ucar.edu/wrf/users/wrfv3.3/updates-3.3.1.html,
 166 and for WRF-NMM at
 167 http://www.dtcenter.org/wrf-nmm/users/model/wrfv3/updates.php
 168
 169 ======================================
 170
 171 V3.3 Release Notes:
 172 -------------------
 173
 174 Version 3.3 is released on April 6, 2011 (rev 4896).
 175
 176 - For more information on WRF V3.3 release, visit WRF User's home pages
 177   http://www2.mmm.ucar.edu/wrf/users/, and
 178   http://www.dtcenter.org/wrf-nmm/users/, and read the online User's Guide.
 179
 180
 181 ======================================
 182
 183 V3.2.1 Release Notes (8/18/10):
 184 ------------------
 185
 186 This is a bug fix release. The detailed updates for WRF-ARW can be found at
 187 http://www2.mmm.ucar.edu/wrf/users/wrfv3.2/updates-3.2.1.html, and
 188 for WRF-NMM at
 189 http://www.dtcenter.org/wrf-nmm/users/model/wrfv3/updates.php
 190
 191 See online User's Guides for latest information.
 192
 193 ======================================
 194
 195 V3.2 Release Notes:
 196 -------------------
 197
 198 Version 3.2 is released on March 31, 2010.
 199
 200 - For more information on WRF V3.2 release, visit WRF User's home pages
 201   http://www2.mmm.ucar.edu/wrf/users/, and
 202   http://www.dtcenter.org/wrf-nmm/users/, and read the online User's Guide.
 203
 204
 205 ======================================
 206
 207 V3.1.1 Release Notes (7/31/09):
 208 ------------------
 209
 210 This is a bug fix release. The detailed updates for WRF-ARW can be found at
 211 http://www2.mmm.ucar.edu/wrf/users/wrfv3.1/updates-3.1.1.html, and
 212 for WRF-NMM at
 213 http://www.dtcenter.org/wrf-nmm/users/model/wrfv3/updates.php
 214
 215 See online User's Guides for latest information.
 216
 217 ======================================
 218
 219 V3.1 Release Notes:
 220 -------------------
 221
 222 Version 3.1 is released on April 9, 2009.
 223
 224 - For more information on WRF V3.1 release, visit WRF Users home page
 225   http://www2.mmm.ucar.edu/wrf/users/, and read the online User's Guide.
 226 - WRF V3 executable will work with V3.0 wrfinput/wrfbdy (but requires
 227   inserting a new namelist variable use_baseparam_fr_nml in &dynamics). As
 228   always, rerunning the new programs is recommended.
 229 - WRF V3.1 has changed a number of namelists. For example, ucmcall has
 230   become sf_urban_physics, pd_moist(scalar/tke/chem) has become
 231   moist_adv_opt (scalar/tke/chem_adv_opt). Helpful messages will be printed
 232   to aid you.
 233
 234
 235 V3.0.1.1 Release Notes:
 236 -----------------------
 237
 238 Version 3.0.1.1 has only limited bug fixes compared to version 3.0.1.
 239 The detailed updates for WRF-ARW can be found at
 240 http://www2.mmm.ucar.edu/wrf/users/wrfv3/updates-3.0.1.1.html.
 241
 242
 243 V3.0.1 Release Notes:
 244 ---------------------
 245
 246 This is a bug fix release. The detailed updates for WRF-ARW can be found at
 247 http://www2.mmm.ucar.edu/wrf/users/wrfv3/updates-3.0.1.html.
 248
 249 Online User's Guides have also been updated.
 250
 251 ======================================
 252
 253 V3.0 Release Notes:
 254 ------------------
 255
 256 - For directions on compiling WRF, see below or Users Web page.
 257 - For more information on WRF V3 release, visit WRF Users home page
 258   http://www2.mmm.ucar.edu/wrf/users/
 259 - WRF V3 works with WPS, and SI is no longer supported.
 260   Please see User' Guide for WPS.
 261 - WRF V3 executable does not work with wrfinput/wrfbdy produced by previous versions.
 262 - WRF V3 has removed one obsolete namelist variable, dyn_opt. Edit with caution.
 263
 264 ======================================
 265
 266 WRF update history:
 267
 268 - V2.0.1: May 21, 2004
 269 - V2.0.2: June 3, 2004
 270 - V2.0.3: Nov 12, 2004
 271   V2.0.3.1: Dec 3, 2004
 272 - V2.1: August 4, 2005
 273 - V2.1.1: Nov 8, 2005
 274 - V2.1.2: Jan 27, 2006
 275 - V2.2: Dec 21, 2006
 276 - V2.2.1: Nov 1, 2007
 277 - V3.0: April 4, 2008
 278 - V3.0.1: August 5, 2008
 279 - V3.0.1.1: August 22, 2008
 280 - V3.1: April 9, 2009
 281 - V3.1.1: July 31, 2009
 282 - V3.2: March 31, 2010
 283 - V3.2.1: August 18, 2010
 284 - V3.3: April 6, 2011
 285 - V3.3.1: Sept 16, 2011
 286 - V3.4: April 6, 2012
 287 - V3.4.1: Aug 16, 2012
 288 - V3.5: April 18, 2013
 289 - V3.5.1: Sept 23, 2013
 290 - V3.6: April 18, 2014
 291 - V3.6.1: Aug 14, 2014
 292 - V3.7: April 20, 2015
 293 - V3.7.1: Aug 14, 2015
 294 - V3.8: April 8, 2016
 295 - V3.8.1: Aug 12, 2016
 296 - V3.9: Apr 17, 2017
 297 - V3.9.1: Aug 17, 2017
 298 - V3.9.1.1: Aug 28, 2017
 299 - V4.0: June 8, 2018
 300
 301 ======================================
 302
 303 How to compile and run?
 304 -----------------------
 305
 306 - In WRF directory, type 'configure' - this will create a configure.wrf
 307   file that has appropriate compile options for the supported computers.
 308
 309   Note: WRF requires netCDF library. If your netCDF library is installed in
 310         some odd directory, set environment variable NETCDF before you type
 311         'configure'. For example,
 312
 313         setenv NETCDF /usr/local/netcdf-pgi
 314
 315 - Type 'compile case_name' where you can find the case_names by simply typing
 316   compile. The following are available:
 317
 318       compile em_b_wave
 319       compile em_grav2d_x
 320       compile em_heldsuarez
 321       compile em_hill2d_x
 322       compile em_les
 323       compile em_quarter_ss
 324       compile em_real
 325       compile em_seabreeze2d_x
 326       compile em_convrad
 327       compile em_squall2d_x
 328       compile em_squall2d_y
 329       compile em_scm_xy
 330       compile em_tropical_cyclone
 331
 332   Notes: 1. If you are going to create model output file that is more than 2Gb,
 333       you should consider using netCDF large file support function. To activate
 334       this, one must set the environment variable WRFIO_NCD_LARGE_FILE_SUPPORT.
 335       In c-shell environment, do
 336
 337       setenv WRFIO_NCD_LARGE_FILE_SUPPORT 1
 338
 339       This becomes default since V3.9.
 340
 341       2. Since V3.2, we support using multiple processors for compilation. The
 342       default number of processors used is 2. But if you have any problem with
 343       compilation, please try using one processor to compile. To do this, set
 344       the following environment variable before compile:
 345
 346       setenv J "-j 1"
 347
 348 - If sucessful, this will create either real.exe or ideal.exe and wrf.exe
 349   in directory main/, and the appropriate executables will be linked into
 350   the test directoires under test/case_name, or run/.
 351
 352 - cd to the appropriate test or run directory to run ideal/real/wrf.
 353
 354 - If it is one of the idealized cases (b_wave, hill2d_x, grav2d_x, quarter_ss,
 355   squall2d_x, squall2d_y, em_les or em_heldsuarez), cd the the appropriate directory, type
 356
 357   ./ideal.exe
 358
 359   to produce wrfinput_d01 file for wrf model. Then type
 360
 361   ./wrf.exe
 362
 363   to run.
 364
 365 - If it is real-data case (real), place files from WPS (met_em.*)
 366   in the appropriate directory, type
 367
 368   ./real.exe
 369
 370   to produce wrfbdy_d01 and wrfinput_d01. Then type
 371
 372   ./wrf.exe
 373
 374   to run.
 375
 376 - If you use mpich, type
 377
 378   mpirun -np number-of-processors wrf.exe
 379
 380 - For information on how to make nested runs, visit
 381   http://www2.mmm.ucar.edu/wrf/users/
 382
 383
 384 ======================================
 385
 386 What is in WRF V4?
 387
 388 - Advanced Research WRF (ARW) solver: Eulerian mass, hydrostatic and non-hydrostatic
 389   * Arakawa C-grid staggering
 390   * Runge-Kutta 2nd and 3rd order timestep options
 391   * scalar-conserving flux form for prognostic variables
 392   * 2nd to 6th order advection options (horizontal and vertical)
 393   * time-split small step for acoustic modes
 394   * small step horizontally explicit, vertically implicit
 395   * divergence damping option and vertical time off-centering
 396   * external-mode filtering option for mass model
 397   * hydrostatic option via namelist option
 398   * positive-definite and monotonic advection for moisture, scalar, tke and chemical tracers
 399   * global modeling capability on latitude-longitude grid
 400   * digital filter initialization
 401   * WENO advection options
 402   * Hybrid sigma-pressure vertical coordinate (since V3.9)
 403
 404 - Two-way nesting:
 405   * multiple domains and multiple nest levels
 406   * supports integer nest grid ratio
 407   * feedback option for both odd and even nest grid ratios
 408   * smoothing options
 409
 410 - One-way nesting
 411
 412 - Moving nest
 413   * Specified move
 414   * Automatic move using a mid-level vortex-following algorithm
 415
 416 - Physics options:
 417   * microphysics (Kessler/ WRF Single Moment 3, 5 and 6 classes / Lin et al./ Mibrandt 2-moment /
 418     Eta Ferrier / Thompson / Goddard / 2-moment Morrison / WRF Double Moment 5 and 6 classes /
 419     SBU-Lin 5-classes / NSSL 2-moment and 1-moment / CAM 5.1 ) / Thompson aerosol-aware /
 420     HUJI full and fast SBM / P3 / 2-moment Morrison with CESM aerosol
 421   * cumulus parameterization (Kain-Fritsch with shallow convection /
 422     Betts-Miller-Janjic / Grell-Devenyi ensemble / Grell 3D (with shallow convection option) /
 423     Grell-Freitas ensemble /
 424     Tiedtke (with shallow conv and momentum transport) / NSAS (with shallow conv and momentum transport) /
 425     SAS (with shallow conv for ARW) / Zhang-McFarlane (with momentum transport) ) /
 426     New Tiedtke (with shallow conv and momentum transport) / Multi-scale KF (with shallow convection) /
 427     Kain-Fritsch Cumulus Potential (with shallow convection)
 428   * UW shallow convection / GRIMS shallow convection
 429   * planetary boundary layer (Yosei University / Mellor-Yamada-Janjic / ACM2 / QNSE-EDMF / MYNN /
 430     BouLac / UW / TEMF / Grenier-Bretherton-McCaa ) / Shin-Hong
 431   * slab soil model (5-layer thermal diffusion / Noah land-surface model (4 levels) /
 432     RUC LSM (6 levels) / Pleim-Xu (2 levels / Noah-MP (4 levels) / SSiB (3 levels) / CLM4 (10 levels) )
 433   * Urban canopy model, BEP multi-layer and BEM  (works with Noah LSM, BEP and
 434     BEM also requires MYJ or BouLac)
 435   * longwave radiation (RRTM / CAM / RRTMG / new Goddard / FLG )
 436   * shortwave radiation (Dudhia / old Goddard / CAM / RRTMG / new Goddard / FLG ),
 437     terrain slope and shading effect
 438   * sub-grid turbulence (constant K diffusion/ 2-D Smagorinsky/ predicted TKE /
 439     2-D, 6th order diffusion / Nonlinear Backscatter Anisotropic (NBA) sub-grid turbulence stress for LES )
 440   * Rayleigh damping for w at the upper boundary layer
 441   * gravity wave drag (including flow blocking)
 442   * land-use categories determine surface properties; support for 24 category USGS and
 443     20 category MODIS
 444   * Options for modifying SST, sea ice, vegetation fraction, albedo, and deep soil temp
 445     for long simulations
 446   * fractional sea ice option for polar regions; modified snow/ice physics
 447   * single-column ocean mixed layer model / 3D Price-Weller-Pinkel (PWP) ocean model
 448   * drag and enthalpy flux formulation for hurricane applications
 449   * CLM lake model
 450   * windfarm drag
 451
 452 - Nudging:
 453   * three-dimensional, surface analysis nudging, and flux-adjusting surface data nudging
 454   * observation nudging
 455   * spectral nudging
 456   * flux-adjusting surface data nudging
 457
 458 - Software
 459
 460   * Hierarchical software architecture that insulates scientific code
 461     (Model Layer) from computer architecture (Driver Layer)
 462   * Multi-level parallelism supporting shared-memory (OpenMP), distributed-memory (MPI),
 463     and hybrid share/distributed modes of execution
 464   * Active data registry: defines and manages model state fields, I/O,
 465     nesting, configuration, and numerous other aspects of WRF through a single file,
 466     called the Registry
 467   * Two-way nesting:
 468       Easy to extend: forcing and feedback of new fields specified by
 469         editing a single table in the Registry
 470       Efficient: 5-8% overhead on 64 processes of IBM
 471       Moving nests.
 472   * Enhanced I/O options:
 473       NetCDF and Parallel HDF5 formats
 474       Nine auxiliary input and history output streams separately controllable through the namelist
 475       Special input streams for analysis and observation nudging
 476       Output file names and time-stamps specifiable through namelist
 477       Special output stream for 3DVAR
 478   * Efficient execution on a range of computing platforms:
 479       IBM SP systems, (e.g. NCAR "bluevista","blueice","bluefire" Power5-based system)
 480       IBM Blue Gene
 481       SGI Origin and Altix
 482       Linux/Intel
 483          IA64 MPP (HP Superdome, SGI Altix, NCSA Teragrid systems)
 484          IA64 SMP
 485          x86_64 (e.g. TACC's "Ranger", NOAA/GSD "wJet" )
 486          PGI, Intel, Pathscale, gfortran, g95 compilers supported
 487       Sun Solaris (single threaded and SMP)
 488       Cray X1, X1e (vector), XT3/4 (Opteron)
 489       Mac Intel/ppc, PGI/ifort/g95
 490       NEC SX/8
 491       HP-UX
 492       Fujitsu VPP 5000, FX10
 493       Intel MIC
 494   * RSL_LITE: communication layer, scalable to very large domains, supports nesting.
 495   * I/O: NetCDF, parallel NetCDF (Argonne), HDF5, GRIB, raw binary, Quilting (asynchronous I/O), MCEL (coupling)
 496   * ESMF Time Management, including exact arithmetic for fractional
 497     time steps (no drift).
 498   * ESMF integration - WRF can be run as an ESMF component.
 499   * Improved documentation, both on-line (web based browsing tools) and in-line
 500