small changes adde ids, etc
[wrffire.git] / wrfv2_fire / README.VAR
blobe8129a7f4a8a3d217122b7ba08545450ca475d98
1 ------------------------
2 WRFDA PUBLIC DOMAIN NOTICE
3 ------------------------
5 WRF Data Assimilation System (WRFDA) was developed at the National 
6 Center for Atmospheric Research (NCAR) which is operated by the 
7 University Corporation for Atmospheric Research (UCAR). NCAR and 
8 UCAR make no proprietary claims, either statutory or otherwise, 
9 to this version and release of WRFDA and consider WRFDA to be in 
10 the public domain for use by any person or entity for any purpose 
11 without any fee or charge. UCAR requests that any WRFDA user include
12 this notice on any partial or full copies of WRFDA. WRFDA is provided
13 on an "AS IS" basis and any warranties, either express or implied, 
14 including but not limited to implied warranties of non-infringement, 
15 originality, merchantability and fitness for a particular purpose, 
16 are disclaimed. In no event shall UCAR be liable for any damages, 
17 whatsoever, whether direct, indirect, consequential or special, that 
18 arise out of or in connection with the access, use or performance of 
19 WRFDA, including infringement actions.
21 ======================================
22 This is the main directory for the WRFDA Version 3 source code release.
23 ======================================
25 V3.2 Release Notes:
26 -----------------------
28 Version 3.2 is released on March 31, 2010.
30 - Improvements on  multiple outer loop which handling nonlinearity issue
32 - Adjoint sensitivity tool
34 - Improved software performance
36 - Improved WRF adjoint codes.
38 V3.1.1 Release Notes:
39 -----------------------
41 Version 3.1.1 is released on July 31, 2009.
43 - Radiance data assimilation using K Matrix capability is completed in V3.1.1 release, 
44   which dramatically speedup the analysis. To use K Matrix , please 
45   set USE_CRTM_KMATRIX=true in wrfvar14@namelist.input. 
46   Note: it only applied on CRTM in V3.1.1.
48 - Improved software portability; only NETCDF library is mandatory 
49   if only LITTLE_R formated conventional observational data to be used. 
50   To use Prepbufr observational files, just set environmental variable 
51   BUFR equal to 1 before the code is compiled. To use radiance BUFR 
52   format data, CRTM or RTTOV is needed.
55 V3.1 Release Notes:
56 -----------------------
58 Version 3.1 is released on April 9, 2009.
60 - For more information on WRFDA, visit the new WRFDA Users home page
61   http://www.mmm.ucar.edu/wrf/users/wrfda/index.html
62   and read the online User's Gudie.
64 - 4DVAR and radiance data assimilation capabilities are included in V3.1.
66 - New README files under WRFDA/var (README.namelist, README.basics, 
67   README.radiance)
69 - WRFDA V3.1 executable will work with V3.0 wrfinput/wrfbdy (but requires 
70   inserting a new namelist variable use_baseparam_fr_nml in &dynamics).
71   However, rerunning V3.1 WPS/real.exe is recommended.
73 - Changes to namelist variables.
74     * Some obsolete or unused namelist variables are removed, some new namelist 
75       variables are added, purposes of some namelist variables are changed.
76       See WRFDA/var/README.namelist for descriptions of supported namelist 
77       variables.
79 - Changes to obsproc:
80     * the executable is renamed to be obsproc.exe from 3dvar_obs.exe and
81       namelist.3dvar_obs is renamed to be namelist.obsproc to reflect
82       its capabilitiy of producing WRFDA-ready observations for 3DVAR, FGAT,
83       or 4DVAR applications.
84       See WRFDA/var/obsproc/README.
85     * compilation of obsproc.exe is included in "compile all_wrfvar"
87 - Changes to diagnostic output files
88     * gts_omb_oma becomes gts_omb_oma_01 (01 indicates outer loop index)
89     * observations that fail check_max_iv are listed in rej_obs_conv_01.000
90       ( 01 is outer loop index, 000 is processor id)
91     * qcstat_conv_01 (01 indicates outer loop index) contains observation 
92       number counts
94 - Most of the scripts under WRFDA/var/scripts are removed from the main source
95   code tar file. They can still be downloaded separately.
96   See http://www.mmm.ucar.edu/wrf/users/wrfda/download/tools.html
98 For questions, send mail to wrfhelp@ucar.edu
100 ======================================
102 WRFDA update history:
104 - V3.0:     Apr  4, 2008
105 - V3.0.1:   Aug  6, 2008
106 - V3.0.1.1: Aug 29, 2008
107 - V3.1:     Apr  9, 2009
108 - V3.1.1:   Jul 31, 2009
109 - V3.2:     Mar 31, 2010
111 ======================================
113 How to compile and run?
114 -----------------------
116 - In WRFDA directory, type 'configure wrfda - this will create a configure.wrf
117   file that has appropriate compile options for the supported computers.
119   Note: WRFDA only requires netCDF library starting with V3.1.1.
120         If using prepbufr or/and radiance data, NCEP BUFR and CRTM 1.2/RTTOV 8.7 are required.
121         Install required libraries and set environment variables properly 
122         before you type 'configure wrfda'. For example, 
124         setenv NETCDF /usr/local/netcdf-pgi
125         setenv BUFR 1 (optional)
126         setenv CRTM /usr/local/crtm_1_2 (optional)
127         setenv RTTOV /usr/local/rttov87 (optional)
129 - Type 'compile all_wrfvar' when your are ready:
131 - If sucessful, this will create da_wrfvar.exe and a set of utilities
132   in directory WRFDA/var/build/. 
134 - cd to the appropriate test or run directory to run WRFDA.
136      Some basic instruction/namelist.input are available in sub-directories
137      of WRFDA/var/test.