Setting up an AWIPS II Localization

TO11d3

12 Jun 09

Client Setup

  1. Create site localization map backgrounds for WFO, State(s) and Regional Scales.
    This step can be completed in one of two ways.
    1. Select Map Projection... from the CAVE->New button on the CAVE toolbar. Enter in the exact coordinates for the desired lat/lon map background projection. Select OK.
      Example: To make a "north up" WFO map for BOU:
      1. Select Polar Stereographic as the projection
      2. Use the KFTG radar location coordinates:
        central_meridian: -104.99
        latitude_of_origin: 39.78
      3. Use the following coordinates for the latitude and longitude:
        Lower left: 37.45 -107.31
        Upper right: 42.00 -101.60
        Pan or zoom as desired (the original map probably will have some blank space on the right).
    2. Use CAVE's Zoom and Pan features to display the desired map background. The scroll wheel on the mouse, if available, works best for zooming into the desired location.
  2. Save each map background projection, from Step 1, as a bundle by selecting CAVE->Procedures->Save Bundle... Use "Browse for other folders" to save the files as follows in the .../etc/bundles directory:
    1. WFO map background = XXX-wfo.xml
    2. State(s) map background = XXX-state.xml
    3. Regional map background = XXX-regional.xml
  3. Edit each new .xml file created in Step 2. The 3rd line from the top should include scale="XXX-wfo", for example. If you created a map from scratch, you'll need to add this to the definition. If you did a zoom/pan, you'll need to edit the setting.
    Note: To use this localization on another workstation, the files just created in .../etc/bundles/ must be copied to the equivalent directory on that workstation.

Server setup

Except for Step 4, do these tasks on the server.

  1. Create and save a new procedure.
    1. Load each new bundle into CAVE. Swap the bundles between the panes to configure how the site will localize upon starting CAVE.
    2. Save the Procedure as default-procedure.xml.xxx in the /cave/etc directory by selecting CAVE->Procedures->Save Procedure.
  2. Edit .../edex/data/utility/cave_config/site/.
    1. Create a new site localization directory, e.g. BOU.
    2. Copy the com.raytheon.viz.core and com.raytheon.viz.warngen directories from another site directory to the newly created site directory.
    3. Within each directory, edit the config.xml file with the new site's WFO information.
  3. Edit .../edex/data/utility/cave_static/site/.
    1. Create a new site localization directory, e.g. BOU.
    2. Copy the contents from another site to the new site directory.
    3. Copy your scales bundles (Step 2) into .../bundles/scales/.
    4. Edit ...cave_static/site/XXX/menus/scan/scan.xml to include your local radars.
    5. Edit ...cave_static/site/XXX/menus/radar/index.xml and dialRadars.xml to set up the local and area radars.
    6. ...cave_static/site/XXX/menus/sat/index.xml should be OK.
  4. Edit .../edex/data/utility/cave_plugin/site/.
    1. Create a new site localization directory, e.g. BOU.
    2. Copy the com.raytheon.viz.site_1.0.0 directory from another site directory to the newly created site directory.
    3. Edit the plugin.xml file:

      Change the Regional, State(s), and WFO scale parameters to point to the .xml bundles created previously in the /cave/etc/bundles directory. Set the value to the name, leaving off the .xml extension. For example, for the Regional scale, change

                 <command
                 commandId="com.raytheon.viz.ui.glMap.setScale"
                 id="Regional"
                 label="Regional">
              <parameter
                    name="scale"
                    value="Regional">
              </parameter>
           </command>
      to 
                 <command
                 commandId="com.raytheon.viz.ui.glMap.setScale"
                 id="Regional"
                 label="Regional">
              <parameter
                    name="scale"
                    value="XXX-regional">
              </parameter>
           </command>

      For the State and WFO scales, the corresponding parameter values are XXX-state and XXX-wfo, respectively. The XXX here will match that used in Step 2, above.

Re-localize

  1. Start CAVE from the /cave directory.
    1. Select the CAVE->Preferences... menu.
    2. Select Localization
    3. Change Site: to the desired site localization, which must match the new site localization directories created in the /edex/data/utility directory.
    4. Ensure that the Localization Server is set correctly.
    5. Select Apply, then select OK.
    6. Exit CAVE.
  2. Restart CAVE.
    You should see your localization's maps in the various panes and the appropriate names in the Scales menu. If you wish, verify that you're using the new localization...
    1. Select the CAVE->Preferences... menu.
    2. Select Localization, and verify that Site: shows the new site localization.
    3. Select -> on the left side of Localization, select Site Preferences, and verify that the settings are correct for the desired site localization.
    4. Select Cancel.
  3. Verify that the local radar menu button for the new site localization is visible to the right of the Satellite menu button on the CAVE menu bar. Also, if any site localization changes were made to the Satellite menu, etc. within the plugin.xml file, see if these changes are visible.
  4. Verify that data for the local radar(s) are accessible and display. If not, you may need to make changes to the radar ingest to include the new sites.