Adjusting include paths for removal of redundant code
[WRF.git] / run / README.tslist
blobeb04130ec2f4b689ab2ff2e4782e7c0fd4e7db33
1 To activate time series output in WRF, a file named "tslist" must be present
2 in the WRF run directory. The tslist file contains a list of locations, given
3 by their latitude and longitude, or i/j coordinates, along with a short 
4 description and an abbreviation for each location. The first three lines in 
5 the file are regarded as header information, and are used to determine if the
6 given coordinates are lat/long or i/j. The contents of an example tslist file 
7 for coordinate specification are shown below. 
10 #-----------------------------------------------#
11 # 24 characters for name | pfx |  LAT  |   LON  |
12 #-----------------------------------------------#
13 Cape Hallett              hallt -72.330  170.250 
14 McMurdo Station           mcm   -77.851  166.713 
15 Bogus point A             pt_a   29.718  -75.772 
16 Bogus point B             pt_b   37.614  -74.650
19 If cell locations are to be used (such as for idealized cases), the i/j 
20 locations are to be specified as follows:
22 #-----------------------------------------------#
23 # 24 characters for name | pfx |   I   |    J   |
24 #-----------------------------------------------#
25 tower0001                 t0001  10       10
26 tower0002                 t0002  20       20
27 tower0003                 t0003  30       30
29 Given a tslist file, for each location inside a model domain (either coarse 
30 or nested), the following files are created:
32 1. pfx*.dNN.TS containing the regular time series output of surface variables.
33 2. pfx.dNN.UU containing a vertical profile of u wind component for each time step
34 3. pfx.dNN.VV containing a vertical profile of v wind component for each time step
35 4. pfx.dNN.WW containing a vertical profile of w wind component for each time step
36 5. pfx.dNN.TH containing a vertical profile of potential temperature for time step
37 6. pfx.dNN.PH containing a vertical profile of geopotential height for each time step
38 7. pfx.dNN.QV containing a vertical profile of water vapor mixing ratio for each time step
39 8. pfx.dNN.PR containing a vertical profile of pressure for each time step
42 Where pfx is the specified prefix for the dd location in the tslist file, 
43 and NN is the domain ID, as given in 
44 namelist.input. If locations not in any model domain are specified in the 
45 tslist file, they will be simply ignored by the time series capability.
47 The maximum number of time series locations is controlled by the namelist
48 variable max_ts_locs, which may be specified in the &domains namelist. Also, 
49 the number of entries in the buffers for time series output can be set with 
50 the ts_buf_size variable, also found in &domains. Decreasing the size of the
51 buffers will reduce the amount of memory that is allocated for time series; 
52 however, smaller buffers will need to be flushed to disk more often than 
53 larger buffers. Thus, it is recommended that the size of the buffer be set 
54 to the maximum number of time steps for any domain in a model run. 
56 By default, the u, v, and w component winds are output on the staggered grid. 
57 To unstagger them, the namelist variable tslist_unstagger_winds can be set to true.
59 Namelist.input variables related to to this new capability:
61  * max_ts_locs = maximum number of locations in 'tslist' ( default is 5)
62  * ts_buf_size = buffer size for time series output (default is 200)
63  * max_ts_level = number of model levels for time series vertical profiles, the default is 15. 
64    The maximum number of max_ts_level is e_vert-1 (the number of half layers in the model run)
65  * tslist_unstagger_winds = output the unstaggered u, v, and w component
66    winds (default is false)
68 The first line in a time-series output of surface variables (pfx*.dNN.TS) looks like this:
70 NZCM McMurdo               2  7 mcm   (-77.850, 166.710) ( 153, 207) (-77.768, 166.500)   81.8 meters
72 Those are name of the station, grid ID, time-series ID, station lat/lon, grid indices (nearest grid point to
73 the station location), grid lat/lon, elevation.
75 The variables from the time series output are:
77 id, ts_hour, id_tsloc, ix, iy, t, q, u, v, psfc, glw, gsw, hfx, lh, tsk, tslb(1), rainc, rainnc, clw
78 id:             grid ID
79 ts_hour:        forecast time in hours
80 id_tsloc:       time series ID
81 ix,iy:          grid location (nearest grid to the station)
82 t:              2 m Temperature (K)
83 q:              2 m vapor mixing ratio (kg/kg)
84 u:              10 m U wind (earth-relative)
85 v:              10 m V wind (earth-relative)
86 psfc:           surface pressure (Pa)
87 glw:            downward longwave radiation flux at the ground (W/m^2, downward is positive)
88 gsw:            net shortwave radiation flux at the ground (W/m^2, downward is positive)
89 hfx:            surface sensible heat flux (W/m^2, upward is positive)
90 lh:             surface latent heat flux (W/m^2, upward is positive)
91 tsk:            skin temperature (K)
92 tslb(1):        top soil layer temperature (K)
93 rainc:          rainfall from a cumulus scheme (mm)
94 rainnc:         rainfall from an explicit scheme (mm)
95 clw:            total column-integrated water vapor and cloud variables
96 Example:
97  2     0.033333    7  153  207     -39.49153       0.00104      -4.57959       7.21139   99064.35938     168.17384      12.06811     -41.77642       0.00001     259.18286     271.35104       0.00000       0.00000       0.00000
100 If solar_diagnostics is activated (see README.namelist) and tslist is present, then time series variables relevant to solar forecasting.
101 These additional variables from the time series output are:
103 cldfrac2d:     2-D MAX CLOUD FRACTION (%)
104 wvp:           WATER VAPOR PATH (kg m-2)
105 lwp:           LIQUID CLOUD WATER PATH (kg m-2)
106 iwp:           ICE CLOUD WATER PATH (kg m-2)
107 swp:           SNOW CLOUD WATER PATH (kg m-2)
108 wp_sum:        SUM OF LWP+IWP+SWP (kg m-2)
109 lwp_tot:       LIQUID CLOUD WATER PATH RES + UNRES (kg m-2)
110 iwp_tot:       ICE CLOUD WATER PATH RES + UNRES (kg m-2)
111 wp_tot_sum:    SUM OF LWP+IWP+SWP RES + UNRES (kg m-2)
112 re_qc:         MASS-WEIGHTED LIQUID CLOUD EFFECTIVE RADIUS (m)
113 re_qi:         MASS-WEIGHTED ICE EFFECTIVE RADIUS (m)
114 re_qs:         MASS-WEIGHTED SNOW EFFECTIVE RADIUS (m)
115 re_qc_tot:     MASS-WEIGHTED LIQUID CLOUD EFFECTIVE RADIUS RES + UNRES (m)
116 re_qi_tot:     MASS-WEIGHTED ICE EFFECTIVE RADIUS RES + UNRES (m)
117 tau_qc:        MASS-WEIGHTED LIQUID CLOUD OPTICAL THICKNESS ()
118 tau_qi:        MASS-WEIGHTED ICE OPTICAL THICKNESS ()
119 tau_qs:        MASS-WEIGHTED SNOW OPTICAL THICKNESS ()
120 tau_qc_tot:    MASS-WEIGHTED LIQUID CLOUD OPTICAL THICKNESS RES + UNRES ()
121 tau_qi_tot:    MASS-WEIGHTED ICE OPTICAL THICKNESS RES + UNRES ()
122 cbaseht:       CLOUD BASE HEIGHT (m)
123 ctopht:        CLOUD TOP HEIGHT (m)
124 cbaseht_tot:   CLOUD BASE HEIGHT RES + UNRES (m)
125 ctopht_tot:    CLOUD TOP HEIGHT RES + UNRES (m)
126 clrnidx:       CLEARNESS INDEX ()
127 sza:           SOLAR ZENITH ANGLE (deg)
128 ghi_accum:     ACCUMULATED GHI (J m-2)
129 swdown:        DOWNWARD SHORT WAVE FLUX AT GROUND SURFACE (W m-2)
130 swddni:        SHORTWAVE SURFACE DOWNWARD DIRECT NORMAL IRRADIANCE (W m-2)
131 swddif:        SHORTWAVE SURFACE DOWNWARD DIFFUSE IRRADIANCE (W m-2)
132 swdownc:       DOWNWARD CLEAR-SKY SHORTWAVE FLUX AT GROUND SURFACE (W m-2)
133 swddnic:       CLEAR-SKY SHORTWAVE SURFACE DOWNWARD DIRECT NORMAL IRRADIANCE (W m-2)
134 swdown2:       DOWNWARD SHORT WAVE FLUX AT GROUND SURFACE FROM FARMS (W m-2)
135 swddni2:       SHORTWAVE SURFACE DOWNWARD DIRECT NORMAL IRRADIANCE FROM FARMS (W m-2)
136 swddif2:       SHORTWAVE SURFACE DOWNWARD DIFFUSE IRRADIANCE FROM FARMS (W m-2)
137 swdownc2:      DOWNWARD CLEAR-SKY SHORTWAVE FLUX AT GROUND SURFACE FROM FARMS (W m-2)
138 swddnic2:      CLEAR-SKY SHORTWAVE SURFACE DOWNWARD DIRECT NORMAL IRRADIANCE FROM FARMS (W m-2)
141 Format of the files of vertical  profile:
142 each line starting with the model time in hours, followed by the variable 
143 at model level 1,2,3, ... up to the highest model level of interest