updated top-level README and version_decl for V4.5 (#1847)
[WRF.git] / var / obsproc / README.namelist
blobab5719e95679d5b50019cba8a1c7e66333f368d0
2 ;-----------------------------------------------------------------------------
3 ; README for the namelist of the 3/4DVAR observation processor (obsproc).
4 ; Users can create namelist.obsproc by editing sample namelist.obsproc.wrfvar-tut
6 ; The meanings of the namelist records are explained below.
8 ;-----------------------------------------------------------------------------
10 &record1
11 ;obs_gts_filename: name and path of decoded observation file
12 ;fg_format       : 'MM5' for MM5 application, 'WRF' for WRF application
13 ;obserr.txt      : name and path of observational error file
14 ;first_guess_file: name and path of the first guess file, for MM5 application only
15 ;gts_from_mmm_archive:  set to .true. if decoded observation file is from
16 ;                       NCAR/MMM hsi:/BRESCH/RT/DATA/ccyymm/obs.ccyymmddhh.gz
19 &record2
20 ;time_window_min = '2007-01-01_23:00:00',: The earliest time edge as ccyy-mm-dd_hh:mn:ss
21 ;time_analysis = '2007-01-02_00:00:00', : The analysis time as ccyy-mm-dd_hh:mn:ss
22 ;time_window_max = '2007-01-02_11:00:00',: The latest time edge as ccyy-mm-dd_hh:mn:ss
23 ; Only observations between 
24 ;       [time_window_min,time_window_max] will be kept.
25
26 ; When no first guess as input file:
27 ; time_window_min: Beginning of time window (included) as ccyy-mm-dd_hh:mn:ss
28 ; time_window_max: End of time window (included) as ccyy-mm-dd_hh:mn:ss
29 ; Only observations between [time_window_min, time_window_max] will be kept.
32 &record3
33 ; max_number_of_obs: Maximum number of observations to be loaded, 
34 ;                    ie in domain and time window, this is independant of 
35 ;                    the number of obs actually read.
36 ; fatal_if_exceed_max_obs: .TRUE.  will stop when more than max_number_of_obs 
37 ;                                  are loaded
38 ;                          .FALSE. will process the first max_number_of_obs
39 ;                                  loaded observations.
42 &record4
43 ; qc_test_vert_consistency: .TRUE. will perform a vertical consistency
44 ;                                  quality control check on sounding 
45 ; qc_test_convective_adj:   .TRUE. will perform a convective adjustement
46 ;                                  quality control check on sounding 
47 ; qc_test_above_lid:        .TRUE. will flag the observation above model lid
48 ; remove_above_lid :        .TRUE. will remove the observation above model lid
49 ; domain_check_h   : .TRUE. will discard the observations outside the domain
50 ; Thining_SATOB    : .FALSE. no thining for SATOB data,
51 ;                    .TRUE. thining procedure applied to SATOB data.
52 ; Thining_SSMI     : .FALSE. no thining for SSMI data,
53 ;                    .TRUE. thining procedure applied to SSMI data.
54 ; Thining_QSCAT    : .FALSE. no thining for QSCAT data,
55 ;                    .TRUE. thining procedure applied to QSCAT data.
56 ; calc_psfc_from_QNH: valid for gts_from_mmm_archive=.true. only.
57 ;                     set to .true. for calculating surface pressure from METAR
58 ;                     QNH value. QNH value is stored in psfc field in the 
59 ;                     NCAR/MMM decoded observation file.
62 &record5
63 ;print_gts_read:     .TRUE. will write diagnostic on the decoded obs reading
64 ;                     in file obs_gts_read.diag
65 ;print_gpspw_read:   .TRUE. will write diagnostic on the gpsppw obs reading
66 ;                     in file obs_gpspw_read.diag
67 ;print_recoverp:     .TRUE. will write diagnostic on the obs pressure recovery
68 ;                     in file obs_recover_pressure.diag
69 ;print_duplicate_loc :.TRUE. will  write diagnostic on space duplicate removal
70 ;                      in file obs_duplicate_loc.diag
71 ;print_duplicate_time:.TRUE. will  write diagnostic on time duplicate removal
72 ;                      in file obs_duplicate_time.diag
73 ;print_recoverh: .TRUE will write diagnostic on the obs height recovery
74 ;                 in file obs_recover_height.diag
75 ; print_qc_vert: .TRUE will write diagnostic on the vertical consistency check
76 ;                 in file obs_qc1.diag
77 ; print_qc_conv: .TRUE will write diagnostic on the convective adjustement 
78 ;                 check in file obs_qc1.diag
79 ; print_qc_lid : .TRUE. will write diagnostic on the above model lid height 
80 ;                 check in file obs_qc2.diag
81 ; print_uncomplete: .TRUE. will write diagnostic on the uncomplete obs removal
82 ;                    in file obs_uncomplete.diag
83 ; user_defined_area: .TRUE. read in the record6: x_left, x_right, 
84 ;                           y_top, y_bottom,
85 ;                    .FALSE. not read in the record6. 
88 &record6
89 ; x_left   : West border of sub-domain
90 ; x_right  : East border of sub-domain
91 ; y_bottom : South border of sub-domain
92 ; y_top    : North border of sub-domain
93 ;   In current implementation, these values are not used at all.
95 ; When no first guess as input file:
96
97 ; Ptop: Reference pressure at model top
98 ; ps0:  Reference sea level pressure
99 ; base_pres: same as ps0. User must set either ps0 or base_pres. 
100 ; ts0:  Mean sea level temperature
101 ; base_temp: same as ts0. User must set either ts0 or base_temp.
102 ; tlp:  Temperature lapse rate 
104 ; base_lapse: same as tlp. User must set either tlp or base_lapse.
105 ; pis0: Tropopause pressure, the default = 20000.0 Pa
106 ; base_tropo_pres: same as pis0. User must set either pis0 or base_tropo_pres
107 ; tis0: Isothermal temperature above tropopause (K), the default = 215 K.
108 ; base_start_temp: same as tis0. User must set either tis0 or base_start_temp.
110 ; Note: In general, users do not need to set pis0 and tis0 or base_tropo_pres
111 ;       and base_start_temp. In most cases, their default values are OK. Here
112 ;       just provides a chance to change them under necessary situation.
114 ; All these parameters can be found in the MM5 INTERPF namelist
116 ; For WRF application, user may set the constants: ps0 = 100000, ts0 = 300, 
117 ;      tlp = 50., and ptop from wrfsi namelist file: wrfsi.nl
120 &record7
121 ; When no first guess as input file:
122 ; IPROJ:  Map projection (0 = Cylindrical Equidistance, 1 = Lambert Conformal,
123 ;                          2 = Polar stereographic,      3 = Mercator)
124 ; PHIC:   Central latitude of the doamin
125 ; XLONC:  Central longitude of the domain
126 ;         For MM5 application, PHIC and XLONC are the central Lat/Lon of the
127 ;         coarse domain.
128 ;         For WRF application, PHIC and XLONC area the central Lat/Lon of the
129 ;         working domain. 
131 ; TRUELAT1: True latitude 1
132 ; TRUELAT2: True latitude 2
134 ; MOAD_CEN_LAT: the cetral latitude for the Mother Of All Domains,
135 ; STANDARD_LON: the standard longitude (Y-direction) of the working domain.
136 ;         These two variables (MOAD_CEN_LAT, STANDARD_LON) are only used
137 ;         for WRF application, ignored them for the MM5 application.
139 ; For MM5 application, all these parameters can be found in MM5 TERRAIN 
140 ;         namelist
142 ; For WRF application, these can be found from WRFSI namelist file: wrfsi.nl
145 &record8
146 ; For MM5 application, all these parameters, except IDD which is set by user, 
147 ;     can be found in MM5 TERRAIN namelist
148 ; For WRF application, these parameters can be found from WRFSI namelist 
149 ;     file: wrfsi.nl (see note below).
151 ; IDD:    Domain ID (1=< ID =< MAXNES), Only the observations 
152 ;         geographically located on that domain will be processed.
153 ;         For WRF application with XLONC /= STANDARD_LON, set IDD=2,
154 ;         otherwise set 1.
155 ; MAXNES: Maximum numbe of domains as needed. 
156 ; NESTIX: The I(y)-direction dimension for each of the domains
157 ; NESTJX: The J(x)-direction dimension for each of the domains
158 ; DIS:    The grid size for each of the domains
159 ;         For WRF application, always set NESTIX(1),NESTJX(1), and DIS(1)
160 ;         based on the infomation in wrfinput.
161 ; NUMC:   The mother domain ID number for each of the domains
162 ; NESTI:  The I location in its mother domain of the nest domain's low left
163 ;          corner -- point (1,1)
164 ; NESTI:  The J location in its mother domain of the nest domain's low left
165 ;         corner -- point (1,1)
166 ;         For WRF application, NUMC(1), NESTI(1), and NESTJ(1) are always set
167 ;         to be 1.
170 &record9
171   prepbufr_output_filename ; Name of the prebufr OBS file.
172   prepbufr_table_filename='prepbufr_table_filename' ; not change
173   output_ob_format=3 ; output 1, prebufr OBS file only;
174                      ;        2, ASCII OBS file only;
175                      ;        3, Both prebufr and ASCII OBS files.
176 ;    Select the obs_gts (ASCII) files used for 3DVAR, FGAT, and 4DVAR:
177  use_for          = '3DVAR',  ; '3DVAR' obs file, same as before, default 
178                               ; 'FGAT ' obs files for FGAT
179                               ; '4DVAR' obs files for 4DVAR
180 ;     num_slots_past and num_slots_ahead are used ONLY for FGAT and 4DVAR: 
181  num_slots_past   = 3, ; the number of time slots before time_analysis
182  num_slots_ahead  = 3, ; the number of time slots after time_analysis
183 ;     Select the specific type of obs in obs_gts (ASCII) files. 
184 ;     .true. is default
185 ;     .false. to remove that type of obs in obs_gts (ASCII) files. 
186  write_synop = .true., 
187  write_ship  = .true.,
188  write_metar = .true.,
189  write_buoy  = .true., 
190  write_pilot = .true.,
191  write_sound = .true.,
192  write_amdar = .true.,
193  write_satem = .true.,
194  write_satob = .true.,
195  write_airep = .true.,
196  write_gpspw = .true.,
197  write_gpsztd= .true.,
198  write_gpsref= .true.,
199  write_gpseph= .true.,
200  write_ssmt1 = .true.,
201  write_ssmt2 = .true.,
202  write_ssmi  = .true.,
203  write_tovs  = .true.,
204  write_qscat = .true.,
205  write_profl = .true.,
206  write_bogus = .true.,
207  write_airs  = .true.,
210 &record10
211  wind_sd        = .false.  ; .false., default to use wind_uv; 
212                           ;          still can use wind_sd by setting wind_sd_${type} true
213                           ; .true.,  using wind_sd for all wind types.
214  wind_sd_buoy   = .false.
215  wind_sd_synop  = .false.
216  wind_sd_ships  = .false.
217  wind_sd_metar  = .false.
218  wind_sd_sound  = .false.
219  wind_sd_pilot  = .false.
220  wind_sd_airep  = .false.
221  wind_sd_qscat  = .false.
222  wind_sd_tamdar = .false.
223  wind_sd_geoamv = .false.
224  wind_sd_profiler = .false.