Release Name:  ob7.2 (ver. a) [OB7.2]

Release Date:  06 June 2006

Integrated Systems Branch
Information Generation Section

This software and its documentation are in the public domain and are furnished "as-is."  The United States government, its instrumentalities, officers, employees, and agents make no warranty, express or implied, as to the usefulness of the software and documentation for any purpose. They assume no responsibility (1) for the use of the software and documentation; or (2) to provide technical support to users.

Permission to use, copy, modify, and distribute this software is hereby granted, provided that this disclaimer notice appears in all copies.  All modifications to this software must be clearly documented, and are solely the responsibility of the agent making the modifications.  GSD will bear no responsibility for code modified by a non-GSD agent.  If significant modifications or enhancements are made to this software, the GSD Software Policy Manager (softwaremgr@gsd.esrl.noaa.gov) should be notified.

Table of Contents

• AWIPS Installation Instructions
  • Before You Begin (Pre-install steps)
    • Ensure you have the software distribution
    • Read the release notes
    • AWIPS Version Installed
    • Make Any Desired Backups
    • Available Disk Space
    • Installation Machines
    • SSH Keys
    • Parition Permissions
    • afos2awips.txt Pils
    • localMapFiles.py (Map File Configuration)
  • Installation Procedure
    • 1) Notify the NCF
    • 2) Ensure site not in failover mode
    • 3) Ensure site is not in IFPS service backup mode
    • 4) Verify that GFE (and IFPS) are NOT running on any workstation in the office.
    • 5) Install GFE Software
      • a) Initial Steps
      • b) Installing the Climo Data package
      • c) Installing the Topo Data package
      • d) Installing the Map Data package
      • e) Installing the GFE CORE package
    • 6) Review your Installation Log(s)
    • 7) Close your Trouble Ticket
    • 8) Unmount and remove the CD/DVD
  • Verification Instructions
    • 1) Verify ifpServer is running
    • 2) Ensure that NotifyTextProd and the VTEC Decoder are running
    • 3) Check your Map Background Overrides
    • 4) Check your Hazard Formatter Overrides
    • 5) Check and verify your SITE-level Area Dictionary, Check your Hazard Formatters
    • 6) Check and verify the remainder of your Text Formatters
• Sample AWIPS GFE Installation Log File
  • Full Release
    • Climo Data Install
    • Topo Data Install
    • Maps Data Install
    • GFE CORE Install
• Manual Installation of GFESuite on AWIPS
  • Full Release
    • I.  Before you begin
    • II.  Installing the new release
      • a) Climo Data Package Install
      • b) Topo Data Package Install
      • c) Maps Data Package Install
      • d) GFE CORE Package Install
• Installation on non-AWIPS Hardware
  • Downloading Release from Web Site
  • Installing Steps
    • Full Install
      • a) Climo Data Package
      • b) Topo Data Package
      • c) Maps Data Package
      • d) GFE CORE Package

AWIPS Installation Instructions

NOTE: If you have previously installed a version of GFESuite, then you normally do not need to install all four components. For AWIPS OB7.2, only the CORE component needs to be installed. The Topo and Climo components did not change from OB7.1. The sites are responsible for the Map configuration and thus the Map component is normally not provided.

Before You Begin (Pre-install steps)

This part of the install should be done prior to performing the install.  Please read over this section and do not proceed until all items have been satisfactorily completed.

Ensure you have the software distribution

Read the release notes

• CDDVD - containing the masterGFEInstall* script as well as the *.tgz GFESuite software
• Directory on Disk - containing the masterGFEInstall* script as well as the *.tgz GFESuite software

1. Insert the CD/DVD into the CD/DVD drive on dx1.
   
2. Log into the "dx1" as user "root".
   
3. Mount the CD/DVD drive on dx1 as user "root".  The command is usually:
             mount /mnt/cdrom1
4. Examine the CD/DVD, on it you will find the release notes and GFESuite distribution, which are in the "gfe", "gfeTopo", "gfeMaps", or "gfeClimo" subdirectory, whose top-level file is the README.html file.  Point your favorite web browser to this document to read the notes, or copy the *.html files to a local disk to examine the files later.
5. Umount the cd.  The command is usually:
             cd
        umount /mnt/cdrom1
   
   Remove the CD/DVD out of the drive by pressing the eject button on the CD-ROM drive.
   
   

1. Change directory to the location of the GFE release.
           cd <directory>        where <directory> is the location of the GFE release distribution
   
2. Examine the directory, in it you will find the release notes, whose top-level file is the README.html file.  Point your favorite web browser to this document to read the notes.

AWIPS Version Installed

• cat /awips/Release_ID
  

The installation script will check the version installed and will abort if you try to run it on a non-supported AWIPS version.

Make Any Desired Backups

Available Disk Space

You will need at least adequate space in order for the installation to succeed.  You may check the disk space by logging on each machine (listed in the table below) as any user (e.g., awipsusr, ifps, etc.) and executing df -P and searching for the /awips/GFESuite partition sizes. The table below defines the required space:

The installation script checks the available disk space and will abort if insufficient disk space is available.

Installation Machines

SSH Keys

The GFESuite software install makes liberal use of SSH Keys.  It is important that the following ssh links are properly set
up.

The GFESuite software install will double-check the SSH configuration and will abort if it is not sufficient for installations.  To double-check it yourself, log onto the "dx1" as "root", and issue commands similar to the "Sample Test Commands to 'dx1'" as shown in the above table.  At no time should it ask you for a password, nor ask prompt you "The authenticity of host can't be established. Are you sure you want to continue connecting?".  If it prompts you for this, then you need to correct your SSH keys and retest.  Ask for NCF assistance if required.

Parition Permissions

afos2awips.txt Pils

Ensure that your afos2awips.txt pils are correct.  Download the checkPIL.tar script from the GSD web page: http://www-md.fsl.noaa.gov/eft/AWIPS/ob7.2a. You need need to do this on a "public" web client, and not from inside the AWIPS firewall.  Copy the downloaded checkPIL.tar file, across the AWIPS firewall,  to one of the host machines on AWIPS, such as dx4. Expand the tar file using:
 tar xvf checkPIL.tar

localMapFiles.py (Map File Configuration)

• remove any "filename" definition for any entries in .../etc/SITE/localMaps.py that MODIFY an existing map.  "Filename" definitions that defined a NEW map should not specify an explicit shapefile, but should an existing mnemonic as defined already in MapFiles.py or use a new mnemonic.    Explicit "Filename" definitions, i.e., ones that explicitly mention a shapefile name,  should be replaced with a mnemonic that is either already existing in Maps.py or defined in localMapFiles.py.   Examples of "filename" definitions are shown below, as it would "incorrectly" appear in localMaps.py:
  

  # Add new map WYcounties = ShapeFile(MAPDIR) WYcounties.filename(CountyMapName)       #This is okay, since it is a new map, and uses a mnemonic WYcounties.filter(lambda x : x['STATE'] == "WY") WYcounties.name = 'WYCounties' WYcounties.editAreaName = ['STATE','COUNTYNAME'] WYcounties.groupName = 'WYCounties' WYcounties.expandDomain = (2, 2, 0, 0) maps.append(WYcounties) # Add new map COcounties = ShapeFile(MAPDIR) COcounties.filename("c_24se05")       #This is NOT okay even though it is a new map, since an explicit                                                                #shapefile name is specified. An existing mnemonic or a new                                                               # mnemonic should be used. COcounties.filter(lambda x : x['STATE'] == "CO") COcounties.name = 'COCounties' maps.append(COcounties) Counties.filename("c_24se05")    #This is not okay, since it modifies an existing map defined in Maps.py                                                        # with an explicit shapefile name, rather than a mnemonic.                                                        # Shapefile names should only exist in localMapFiles.py.

  and how they should be changed in localMaps.py and entered in localMapFiles.py:

  localMaps.py

  # Add new map WYcounties = ShapeFile(MAPDIR) WYcounties.filename(CountyMapName)       WYcounties.filter(lambda x : x['STATE'] == "WY") WYcounties.name = 'WYCounties' WYcounties.editAreaName = ['STATE','COUNTYNAME'] WYcounties.groupName = 'WYCounties' WYcounties.expandDomain = (2, 2, 0, 0) maps.append(WYcounties) # Add new map COcounties = ShapeFile(MAPDIR) COcounties.filename(CountyMapName)       COcounties.filter(lambda x : x['STATE'] == "CO") COcounties.name = 'COCounties' maps.append(COcounties) Counties.filename("c_24se05")

  localMapFIles.py

  CountyMapName = "c_24se05"     #defination for CountyMapName mnemonic.

  
  
• copy all entries from etc/BASE/MapFiles.py to etc/SITE/localMapFiles.py.  Remove comments that were part of the MapFiles.py (first 7 lines). Remove the Alaska special configuration information.   You should end up with a file that looks similar to this (shapefile names may differ).  Be sure that there is only ONE definition for each variable and that you didn't repeat variables:
  

  CountyMapName = 'c_16mr06' ZoneMapName = 'z_14fe06' CWAMapName = 'w_14jl05' OffshoreMapName = 'oz15de04' MarineZonesMapName = 'mz01se05' StatesMapName = 's_14jl05' BasinsMapName = 'ba28mr06' FireWxZonesName = 'fz14ap06' RFCMapName = 'rf12ja05' LakeMapName = 'lk21se99' HighSeaMapName = 'hz28au04' CityMapName = 'web_city' InterstateMapName = 'ri11oc01' HighwayMapName = 'loreshwy' ISCMapName = 'cm06jn05' FireWxAORMapName = 'cf20se05' CanadaMapName = 'province' WorldMapName = 'world_adm0' RailroadMapName = 'railrdl020' AirportMapName = 'airprtx020'

• Edit your entries in etc/SITE/localMapFiles.py as necessary to ensure that they point to a map shapefile that exists in the GFESuite's data/maps directory.
  
• Be sure to test out your new map configuration using "runIFPServer -n" on the existing GFESuite build before attempting to install the new build.

Installation Procedure

1) Notify the NCF

• NCF, at (301) 713-9344
  

2) Ensure site not in failover mode

• As user root, to check whether or not DXs (and px3/px4 for Alaska Multi-Domain sites) are in failover mode, then use the "hb_stat" command.   Example output from the hb_stat command is  shown below, and shows the normal dx1apps and dx4apps on the dx4 and dx3 appropriately:

3) Ensure site is not in IFPS service backup mode

4) Verify that GFE (and IFPS) are NOT running on any workstation in the office.

5) Install GFE Software

• CD/DVD - containing the masterGFEInstall* script as well as the *.tgz GFESuite software in subdirectories on the CD/DVD
  
• Directory on Disk - containing the masterGFEInstall* script as well as the *.tgz GFESuite software in subdirectories
  

• Climo Data
• Topo Data
• Map Data
• CORE GFE

a) Initial Steps

1. Insert the CD/DVDinto the CD/DVD drive on dx1.
   
2. Log into the "dx1" as user "root".
   
3. Mount the CD drive on dx1 as user "root".  The command is usually:
             mount /mnt/cdrom1

1. Log into the "dx1" as user "root".
   

b) Installing the Climo Data package

1. Start the script to log install progress (VERY IMPORTANT):
        script -f /awips/GFESuite/gfeInstallClimo.log
2. Begin the installation. This command must be executed as root on dx1. This script needs to be run to completion, which can be identified by this final entry on the terminal:
   
   ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
   Software install completed successfully
   ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
   
   Any errors that occur during the install will normally be indicated by a python traceback and the installation will abort.
   
   

   Release Style	Commands	Notes
   CD/DVD Style	cd /mnt/cdrom1/gfeClimo	(use the correct device name for the CD/DVD)
   	./masterGFEInstall_Climo <site>	where <site> is the site identifier, such as ./masterGFEInstall_Climo BOU
   Directory Style	cd <directory>	where <directory> is the location of the install script and software (installClimo is a likely subdirectory name)
   	./masterGFEInstall_Climo <site>	where <site> is the site identifier, such as ./masterGFEInstall_Climo BOU

   
   
3. When the installation has finished, type the following to exit the "script" command:
             exit
   

c) Installing the Topo Data package

1. Start the script to log install progress (VERY IMPORTANT):
        script -f /awips/GFESuite/gfeInstallTopo.log
2. Begin the installation. This command must be executed as root on dx1. This script needs to be run to completion, which can be identified by this final entry on the terminal:
   
   ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
   Software install completed successfully
   ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
   
   Any errors that occur during the install will normally be indicated by a python traceback and the installation will abort.
   
   

   Release Style	Commands	Notes
   CD/DVD Style	cd /mnt/cdrom1/gfeTopo	(use the correct device name for the CD/DVD)
   	./masterGFEInstall_Topo <site>	where <site> is the site identifier, such as ./masterGFEInstall_Topo BOU
   Directory Style	cd <directory>	where <directory> is the location of the install script and software (installTopo is a likely subdirectory name)
   	./masterGFEInstall_Topo <site>	where <site> is the site identifier, such as ./masterGFEInstall_Topo BOU

   
   
3. When the installation has finished, type the following to exit the "script" command:
             exit

d) Installing the Map Data package

1. Start the script to log install progress (VERY IMPORTANT):
        script -f /awips/GFESuite/gfeInstallMaps.log
2. Begin the installation. This command must be executed as root on dx1. This script needs to be run to completion, which can be identified by this final entry on the terminal:
   
   ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
   Software install completed successfully
   ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
   
   Any errors that occur during the install will normally be indicated by a python traceback and the installation will abort.
   
   

   Release Style	Commands	Notes
   CD/DVD Style	cd /mnt/cdrom1/gfeMaps	(use the correct device name for the CD/DVD)
   	./masterGFEInstall_Maps <site>	where <site> is the site identifier, such as ./masterGFEInstall_Maps BOU
   Directory Style	cd <directory>	where <directory> is the location of the install script and software (installMaps is a likely subdirectory name)
   	./masterGFEInstall_Maps <site>	where <site> is the site identifier, such as ./masterGFEInstall_Maps BOU

   
   
3. When the installation has finished, type the following to exit the "script" command:
             exit

e) Installing the GFE CORE package

1. Start the script to log install progress (VERY IMPORTANT):
        script -f /awips/GFESuite/gfeInstall.log
2. Begin the installation. This command must be executed as root on dx1. This script needs to be run to completion, which can be identified by this final entry on the terminal:
   
   ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
   Software install completed successfully
   ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
   
   Any errors that occur during the install will normally be indicated by a python traceback and the installation will abort.
   
   

   Release Style	Commands	Notes
   CD/DVD Style	cd /mnt/cdrom1/gfe	(use the correct device name for the CD/DVD)
   	./masterGFEInstall <site>	where <site> is the site identifier, such as ./masterGFEInstall BOU
   Directory Style	cd <directory>	where <directory> is the location of the install script and software (install is a likely subdirectory name)
   	./masterGFEInstall <site>	where <site> is the site identifier, such as ./masterGFEInstall BOU

   
   
3. When the installation has finished, type the following to exit the "script" command:
             exit

6) Review your Installation Log(s)

7) Close your Trouble Ticket

8) Unmount and remove the CD/DVD

Verification Instructions

1) Verify ifpServer is running

2) Ensure that NotifyTextProd and the VTEC Decoder are running

3) Check your Map Background Overrides

4) Check your Hazard Formatter Overrides

5) Check and verify your SITE-level Area Dictionary, Check your Hazard Formatters

• WSW, NPW, CWF, NSH, RFW, MWS, CFW.  For each of these products, create a hazard grid appropriate to the product that covers your entire grid.  The appropriate values are: WSW (WS.W), NPW (HW.W), CWF (GL.W), NSH (GL.W), RFW (FW.A), MWS (MA.S), CFW (LS.W). Carefully examine the UGC coding, the UGC names, and the city names.  Is every UGC code in your area of responsibility present?  Are the UGC names and city names correct?  Do you have two zones/counties with the same name, meaning that you probably need to modify the “ugcName” to indicate the state?  

• WCN.  Put TO.A:123 in the Hazard grid and have it cover your entire grid. Review the body of the generated text, which will break out each area of the state.  Verify that the counties are in the correct section.  Look for sections that are identified by state abbreviations instead of full names (e.g., NC instead of NORTH CAROLINA), that indicates that the following counties do not have their 'stateName' or “partOfState” properly set up in the AreaDictionary.  Look for sections that say “IN xx <stateName>” where xx is nothing, rather than something like SOUTHEAST.  This indicates that the following counties don't have their “partOfState” identified. 

• FFA. Put FA.A in the Hazard grid and have it cover your entire grid.   Check all of the UGC coding, UGC names, and city names just as in step a) above.  There is an additional AreaDictionary entry that may be used.  If you find that the location names are too verbose, you may add a “locationName” entry to each of the zones, which will be used as the description rather than the “ugcName”.

6) Check and verify the remainder of your Text Formatters

Sample AWIPS GFE Installation Log File

Full Release

Climo Data Install

Topo Data Install

Maps Data Install