Hazard Type Default and Order in Storm Track Tool - Hazard Services

Purpose:

Tasks:

AT-A-GLANCE:

• What? Perform a class-based override of getDefaultHazardTypeBySettingsCategory in StormTrackTool.py to update the default hazard type when using the Storm Track Tool. Perform a class-based override of hazardTypeDict in StormTrackTool.py to change the order of hazards in the Storm Track Tool Dialog window. Perform a class-based override of activeTurnKeyOptions in TurnKeyUtilities.py to enable Extreme Wind Warnings in the Storm Track Tool.

• Hazard category configuration. The hazard types that appear as options in the Storm Track Tool depend on the hazard category configuration of your console in Hazard Services. See the image below for Storm Track Tool and hazard viewing options for each configuration. >

• Extreme Wind Warnings. The Extreme Wind Warning (EW.W) hazard can be issued using the Storm Track Tool but is not turned on by default. Coastal WFOs at risk for hurricane landfalls and their backup sites should enable EW.W using a simple override. 

Follow the steps below for more detailed guidance.

SECTIONS

1. Changing the Default Hazard Type in the Storm Track Tool
2. Changing the Order of Hazard Types in the Storm Track Tool Dialog Window
3. Activating the Extreme Wind Warning Hazard in the Storm Track Tool

1. Changing the Default Hazard Type in the Storm Track Tool

*NOTE: The default hazard type is set to Severe Thunderstorm Warning (SV.W) when running the Storm Track Tool in the Short Fuse and Convective console configurations. While most sites with routine severe weather won’t want to change that, the example in this section is provided for WFOs that use Special Marine Warning (MA.W) more frequently and would like to set that as the default. Other hazards can be set as default using the same steps.

1. In the Localization perspective navigate to Hazard Services –> Recommenders –> StormTrackTool.py and double click on BASE to load.

2. If a USER override for StormTrackTool.py does not already exist, create one by right-clicking BASE –> Create Override File and selecting User. Open the USER override file.

3. In the BASE file, use Ctrl+F to launch the Find/Replace tool and search for the function getDefaultHazardTypeBySettingsCategory. Copy the entire function definition into the USER override file.

   *NOTE: If running an older version of the RPM, within hazardTypeDict, "Short Fuse" will actually be labeled as "Convective". You will need to replace it with "Short Fuse".

4. Change the defaultHazardType variable and the dictionary values within hazardTypeDict so your preferred default hazard type appears when opening the Storm Track Tool within the Short Fuse category ("MA.W" below).

   

   *NOTE: The dictionary entries for “Marine”, “Non-Precipitation”, and “Winter Weather” can be disregarded as the Storm Track Tool is not enabled for those console configurations.

5. There is also code in the getDefaultHazardTypeBySettingsCategory function that prepares for the Threats-In-Motion paradigm. While this code will not be used for years, you may also choose to change the default hazard type within that section of the code. 

   
   *NOTE: If running an older version of the RPM, make sure to also change “Convective” to “Short Fuse” in hazardTypeDict.

6. Save the override file using Ctrl+S. Merge if it asks you to.

7. Return to the D2D perspective. Load Hazard Services and run the Storm Track Tool to verify that your preferred hazard now appears as the default in the Storm Track Tool Dialog pop-up. 

   

8. When you are comfortable that the USER override is working as you want, return to the Localization perspective. Promote the USER override to a SITE override by right-clicking USER under StormTrackTool.py in the File Browser and selecting Copy To –> Site.

2. Changing the Order of Hazard Types in the Storm Track Tool Dialog Window

*NOTE: Severe Thunderstorm Warning (SV.W) and Tornado Warning (TO.W) default to the top of the Hazard Type list in the latest RPM (21.4.1-20231013322), so you can skip this step if you have this installed and don't wish to change the order type. If running an older RPM (21.4.1-2023083020), there is a mislabeled key in the programming that causes the Hazard Type dropdown list in the Storm Track Tool Dialog popup to default to an alphabetical order instead. This section will show how to enable the correct default order for the older RPM, and how to change that order if you wish. However, note that in the Hazard Information Dialog window, hazard types default to alphabetical order in the Type dropdown and this cannot be overridden. 

If you are unsure of which RPMs you currently have installed, you can run the following command in your terminal:

rpm -qa | grep -i hazard

1. In the Localization perspective navigate to Hazard Services –> Recommenders –> StormTrackTool.py and double click on BASE to load.

2. If a USER override for StormTrackTool.py does not already exist, create one by right-clicking BASE –> Create Override File and selecting User. Open the USER override file.

3. In the BASE file, use Ctrl+F to launch the Find/Replace tool and search for the function defaultHazardTypeOrder. Copy the entire function definition into the USER override file.

   

4. The order of hazard types is contained within hazardTypeDict. The hazard types listed within will be placed at the top of the list in the order they are entered, with all other hazard types appearing below them in alphabetical order.
                    
   *NOTE: If running an older RPM, the hazard types will default to fully alphabetical. To set the proper default functionality, replace both instances of “Convective” in the function with “Short Fuse”.
   
   
   

5. If you wish to change the order in the Hazard Types dropdown, you can add, remove, or rearrange hazards within the hazard list in hazardTypeDict. For example, the change below will insert the Special Weather Statement (SP.S) between the Severe Thunderstorm Warning (SV.W) and Tornado Warning (TO.W) at the top of the list, with all other convective hazards appearing below those three in alphabetical order.
   

6. There is also code in the defaultHazardTypeOrder function that prepares for the Threats-In-Motion paradigm. While this code will not be used for years, you may also choose to change the hazard type order within that section of the code.

   

7. Save the override file using Ctrl+S. Merge if it asks you to.

8. Return to the D2D perspective. Load Hazard Services and run the Storm Track Tool to verify that your preferred hazard order now appears in the Storm Track Tool Dialog pop-up. 

   

9. When you are comfortable that the USER override is working as you want, return to the Localization perspective. Promote the USER override to a SITE override by right-clicking USER under StormTrackTool.py in the File Browser and selecting Copy To –> Site.

3. Activating the Extreme Wind Warning Hazard in the Storm Track Tool

1. Open the Localization perspective and navigate to Hazard Services –> Utilities –> TurnKeyUtilities.py and double click on BASE to load. 

2. If a USER override for TurnKeyUtilities.py does not already exist, create one by right-clicking BASE –> Create Override File and selecting User. Open the USER override file.

3. In the BASE file, find the activeTurnKeyOptions() dictionary. Copy and paste it into your USER file.

4. Between the quotation marks in the return line, insert the letter "e".

5. Save the override file using Ctrl+S. Merge if it asks you to.

6. Test your new settings in the D2D perspective using the Storm Track Tool. When you are comfortable that the USER override is working as you want, return to the Localization perspective. Promote the USER override to a SITE override by right-clicking USER under TextProductCommon.py in the File Browser and selecting Copy To –> SITE.
   

Congratulations, you've configured the Hazard Type list in the Storm Track Tool Dialog pop-up.