Build 4.2 is set up for straightforward management of Redbook graphics. Five files in /data/fxa/nationalData are used to control the storage and display of these products, including
Since these are in nationalData, they are visible to all workstations. Further, in most cases, no localization is required to effect the changes.
While field sites can manage these files as they see fit, it makes more sense for this to be directed from headquarters, to avoid confusion or upgrade hassles.
Let's look at each file in turn. As our example, we'll trace the late 1999 addition of the four CPC threats assessment graphics, PEIY50, PTIY98, PYIY88, and PYIA88.
This file lists all of the Redbook graphics and various characteristics of their storage. Of particular interest are the key number and the storage directory.
By convention, Redbook graphics use key numbers in the 5000-5999 range. Before the CPC graphics were added, there were 249 Redbook graphics keys set up in the system, with 5288 being the highest number in use. Thus, 5289-5292 were used for the new products, to wit:
5289|||156||||redbook/sfc/drought|PEIY50KWNC.||PEIY50 3-10 day precip threat 5290|||156||||redbook/sfc/drought|PTIY98KWNC.||PTIY98 3-10 day temp/wind threat 5291|||156||||redbook/sfc/drought|PYIY88KWNC.||PYIY88 3-10 day soil/wildfire threat 5292||| 0||||redbook/sfc/drought|PYIA88KWNC.||PYIA88 2-week drought assessment
(I trimmed whitespace that you'll see in the actual file, to allow it to fit on the display.)
The columns used are
| key | an arbitrary number that identifies this product |
| projection | the forecast time of the graphic, in days if negative, in seconds if >240, otherwise in hours |
| directory | The path under /data/fxa where this product will be stored. The directory tree under /data/fxa/redbook is rich enough to accommodate most new products. If a new directory is needed, it can be created by running the -dirs target of localization on ds1. |
| filename | The root name of the file in which the product will be stored. A
time stamp will be added to this root name, so it should end with a
period for ease of reading. The TTAAii part of this name must match
what is received; the CCCC part should, but it will store under the
name given here, even if it differs from what's in the product.
Note that the time stamp is created by reading the product - the producer includes a valid time in the product header immediately following the TTAAii CCCC. |
| description | plain-language description of the product |
Another sometimes-used column immediately precedes the directory:
| frequency/offset | Time frequency and offset used to modify the time stamp in the product to make an appropriate file name. Examples: radar summaries show 3600,2100 in this field. The 3600 truncates the time stamp back to the top of the hour (if necessary), and then the 2100 rolls it forward to :35. So a radar chart internally stamped 2200 will yield a file name of 2235. Similarly, ECMWF graphics have 86400,43200 to put them at 12Z. This is not a very straightforward field to set, because time stamps are not consistent among all the Redbook graphics. Note: In 4.2, if a non-zero offset is indicated, then the column immediately preceding this one must have a 1 in it. This requirement is eliminated in 4.3; presence or absence of the 1 will have no effect. |
For the same keys as above, display information is included here. Using our same example,
5289|33|5289||0|1|CPC Precip Threat Assessment |Precip Threat |1|0|1| 5290|33|5290||0|1|CPC Temp/Wind Threat Assessment |Temp/Wind Threat |1|0|1| 5291|33|5291||0|1|CPC Soil/Wildfire Threat Assessment|Soil/Wildfire Threat|1|0|1| 5292|33|5292||0|1|CPC Drought Monitor |Drought Monitor |1|0|1|
The columns used here include
| key | An arbitrary number that identifies this product. This key is referred to by the redbookProductButtons entries, which see below. |
| type | 33 = REDBOOK_DEPICT |
| dataKeys | The corresponding data key or keys that are used to make this product. In most cases, this matches the first-column key. In others, multiple data keys are used - for example, a single button selects maximum and minimum temperatures. Key 5140 refers to dataKeys 5140 and 5141 to display them both. The same approach is used for QPFs, models, etc.; MRF products include 16 data keys. |
| maps | A key for the map background to use. Zero here means use the default map for the scale. |
| isGraphic | 1 = this is a graphic |
| longName | name used to label the product when displayed |
| shortName | name used in the history list |
| depth | 1 = one-bit (monochrome) graphic |
| isMap | 0 = not a map |
| isPlanView | 1 = plan view display |
This file includes information regarding on which scale(s) to display the products. Our example:
5289 | >700, 5289 | Precip |Precip Threat | 0 5290 | >700, 5290 | Temperature/Wind |Temp/Wind Threat | 0 5291 | >700, 5291 | Soil/Wildfire |Soil/Wildfire Threat | 0 5292 | >700, 5292 | Drought Monitor |Drought Monitor | 0
These entries describe
| key | A key that will be referred to in the menu file. For Redbooks, it should match a redbookDepictKeys.txt entry. |
| scales | This field describes which product is displayed at which scale. There are many ways that this can be described, as documented in the comments section of productButtonInfo.txt. For most Redbook graphics, the form shown above is used. The >700 means that this product will be available on any scale whose dimension is >700 km, and the key refers to redbookDepictKeys.txt. The lightning graphic shows just the key, which means display on all scales. |
| button label | this is the text that will appear on the menu |
| toggle menu label | populated, but unused |
| static | 0 = show an inventory time |
This file lists the Redbooks products and the order in which they appear on the Surface menu. The example CPC graphics were added to the "Surface Obs and Progs" submenu (renamed from "Surface Obs"). They were put under a "CPC Threats Assessment" subheading, and the menu was reorganized a bit for clarity, as shown here.
Old:
title: "" productButton: 5056 # PEWA31 Daily Precipitation productButton: 5057 # PEWA32 Snow Cover Plot productButton: 5170 # PYWS46 Drought Index productButton: 5171 # PYWS47 Crop Moisture Index title: "" productButton: 5154 # PYWA31 Sfc Geostrophic Wind productButton: 5155 # PYWA32 Sfc Geo Relative Vort title: "" productButton: 5245 # WATL wind/wave productButton: 5248 # EPAC wind/wave productButton: 5251 # SIG wave hgt productButton: 5255 # PRIM wave dir productButton: 5259 # PRIM wave period
New:
title: "" productButton: 5056 # PEWA31 Daily Precipitation productButton: 5057 # PEWA32 Snow Cover Plot title: "" productButton: 5154 # PYWA31 Sfc Geostrophic Wind productButton: 5155 # PYWA32 Sfc Geo Relative Vort title: "Marine" productButton: 5245 # WATL wind/wave productButton: 5248 # EPAC wind/wave productButton: 5251 # SIG wave hgt productButton: 5255 # PRIM wave dir productButton: 5259 # PRIM wave period title: "CPC Threats Assessment" productButton: 5289 # PEIY50 precip productButton: 5290 # PTIY98 temp/wind productButton: 5291 # PYIY88 soil/wildfire productButton: 5292 # PYIA88 drought monitor title: "" productButton: 5170 # PYWS46 Drought Index productButton: 5171 # PYWS47 Crop Moisture Index
On the menu, a blank title appears as a horizontal separator, while a named title has the separator plus a blue italic name.
This has the same form as the Surface menu, but appears on the Upper Air pull-down.
It's also necessary to include any new graphics in the purger. One must modify ds1:/awips/fxa/bin/redbook.purge (and ds2 for failover). The necessary changes should be obvious by inspection. An example for the recent addition of CPC threats assessment graphics:
purgeRedbookDir redbook/sfc/drought '^PEIY50.*' 2 purgeRedbookDir redbook/sfc/drought '^PTIY98.*' 2 purgeRedbookDir redbook/sfc/drought '^PYIA88.*' 2 purgeRedbookDir redbook/sfc/drought '^PYIY88.*' 2