splitting off fire_pixels3d.m
[wrffire.git] / wrfv2_fire / README.DA
blobaeab818a069b6be607fcb2e8ea7b2745182bd20b
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.4 Release Notes :
26 -------------------
28 Version 3.4 is released on April 6, 2012.
30 - The WRFPLUS (WRF adjoint and tangent linear model) has been upgraded to V3.4 and it is consistent with the released WRF version 3.4. Added parallel WRF TL/AD based on WRF 3.4.
32 - WRFDA 4D-Var now supports compilation to run in parallel.
34 - WRFDA 4D-Var now supports precipitation data (such as stage IV) assimilation.
36 - The ability to generate forecast sensitivity to observations has been updated.
38 - WRFDA Hybrid 3D-Var has been updated.
40 ======================================
42 V3.3.1 Release Notes :
43 -------------------
45 Version 3.3.1 is released on September 27, 2011.
47 - WRF 4D-Var has been improved on lateral boundary condition control, analysis scheme for surface observation etc.
48   
49 - Lots of bug fixes.
51 ======================================
53 V3.3 Release Notes:
54 -----------------------
56 Version 3.3 is released on April 6, 2011.
58 - RTTOV interfaces has been upgraded to version 10.0
59   Please download RTTOV v10.0 and install it in appropriate location 
60   if you want to use RTTOV to assimilate radiance observation with bufr format
62 - crtm_atmosphere is removed from the namelist. 
63   Now the CRTM reference climatology is determined inside WRFDA based on 
64   latitude and month.
66 - New WRF 4D-Var
67   The WRFPLUS (WRF adjoint and tangent linear model) has been upgraded to V3.3 
68   and it is consistent with the released WRFV version 3.3. However, only dry dynamic 
69   processes are included in WRFPLUS version 3.3 and only serial run is supported
70   at this release.
71   WRFDA is also upgraded to consistent with WRFPLUS version 3.3 and the new 4D-Var 
72   system is a single executable application. Please refer to Users' guide for the
73   details.
75 - Lots of bug fixes.
77 V3.2.1 Release Notes:
78 -----------------------
80 Version 3.2.1 is released on August 18, 2010.
82 - CRTM interface for radiance assimilation has been upgraded to version 2.0.2.
84 - CRTM V2.0.2 has been included as an internal library in WRFDA codes.
85   Setting environmental variable CRTM to ANYTHING to activate the CRTM installation 
86   during WRFDA compilation.
88 - Multivariate gen_be method which considers the correlations between moisture and 
89   other variables is included, but the support for the new capability will be very
90   limited.
92 - Lots of bug fixes.
94 V3.2 Release Notes:
95 -----------------------
97 Version 3.2 is released on March 31, 2010.
99 - Improvements on  multiple outer loop which handling nonlinearity issue
101 - Adjoint sensitivity tool
103 - Improved software performance
105 - Improved WRF adjoint codes.
107 V3.1.1 Release Notes:
108 -----------------------
110 Version 3.1.1 is released on July 31, 2009.
112 - Radiance data assimilation using K Matrix capability is completed in V3.1.1 release, 
113   which dramatically speedup the analysis. To use K Matrix , please 
114   set USE_CRTM_KMATRIX=true in wrfvar14@namelist.input. 
115   Note: it only applied on CRTM in V3.1.1.
117 - Improved software portability; only NETCDF library is mandatory 
118   if only LITTLE_R formated conventional observational data to be used. 
119   To use Prepbufr observational files, just set environmental variable 
120   BUFR equal to 1 before the code is compiled. To use radiance BUFR 
121   format data, CRTM or RTTOV is needed.
124 V3.1 Release Notes:
125 -----------------------
127 Version 3.1 is released on April 9, 2009.
129 - For more information on WRFDA, visit the new WRFDA Users home page
130   http://www.mmm.ucar.edu/wrf/users/wrfda/index.html
131   and read the online User's Gudie.
133 - 4DVAR and radiance data assimilation capabilities are included in V3.1.
135 - New README files under WRFDA/var (README.namelist, README.basics, 
136   README.radiance)
138 - WRFDA V3.1 executable will work with V3.0 wrfinput/wrfbdy (but requires 
139   inserting a new namelist variable use_baseparam_fr_nml in &dynamics).
140   However, rerunning V3.1 WPS/real.exe is recommended.
142 - Changes to namelist variables.
143     * Some obsolete or unused namelist variables are removed, some new namelist 
144       variables are added, purposes of some namelist variables are changed.
145       See WRFDA/var/README.namelist for descriptions of supported namelist 
146       variables.
148 - Changes to obsproc:
149     * the executable is renamed to be obsproc.exe from 3dvar_obs.exe and
150       namelist.3dvar_obs is renamed to be namelist.obsproc to reflect
151       its capabilitiy of producing WRFDA-ready observations for 3DVAR, FGAT,
152       or 4DVAR applications.
153       See WRFDA/var/obsproc/README.
154     * compilation of obsproc.exe is included in "compile all_wrfvar"
156 - Changes to diagnostic output files
157     * gts_omb_oma becomes gts_omb_oma_01 (01 indicates outer loop index)
158     * observations that fail check_max_iv are listed in rej_obs_conv_01.000
159       ( 01 is outer loop index, 000 is processor id)
160     * qcstat_conv_01 (01 indicates outer loop index) contains observation 
161       number counts
163 - Most of the scripts under WRFDA/var/scripts are removed from the main source
164   code tar file. They can still be downloaded separately.
165   See http://www.mmm.ucar.edu/wrf/users/wrfda/download/tools.html
167 For questions, send mail to wrfhelp@ucar.edu
169 ======================================
171 WRFDA update history:
173 - V3.0:     Apr  4, 2008
174 - V3.0.1:   Aug  6, 2008
175 - V3.0.1.1: Aug 29, 2008
176 - V3.1:     Apr  9, 2009
177 - V3.1.1:   Jul 31, 2009
178 - V3.2:     Mar 31, 2010
179 - V3.2.1:   Aug 18, 2010
181 ======================================
183 How to compile and run?
184 -----------------------
186 - In WRFDA directory, type 'configure wrfda - this will create a configure.wrf
187   file that has appropriate compile options for the supported computers.
189   Note: WRFDA only requires netCDF library starting with V3.1.1.
190         Install netCDF library with the same compiler that will be used to compile WRFDA.
191         NCEP BUFR and CRTM 2.0.2 libs are included in the WRFDA tar file. 
192         Set environment variables properly according to your applications
193         before you type 'configure wrfda'. For example, 
195         setenv NETCDF /usr/local/netcdf-pgi
196         setenv BUFR 1 (optional, set to compile WRFDA with NCEP BUFR capability)
197         setenv CRTM 1 (optional, set to compile WRFDA with CRTM capability)
198         setenv RTTOV /usr/local/rttov10 (optional, set to compile WRFDA with RTTOV capability)
200 - Type 'compile all_wrfvar' when your are ready:
202 - If sucessful, this will create da_wrfvar.exe and a set of utilities
203   in directory WRFDA/var/build/. 
205 - cd to the appropriate test or run directory to run WRFDA.
207      Some basic instruction/namelist.input are available in sub-directories
208      of WRFDA/var/test.