README

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