Server Configuration Information

September 25, 2012

Table of Contents
Overview
Server Database Configuration Modification Options
Server Map Configuration Modification Options
Location of Files

Overview

GFE uses several configuration files:

siteConfig.py - Defines directory and site variables
serverConfig.py - Contains main database definitions
localConfig.py - Overrides for the serverConfig.py (Site-level file)
localWxConfig.py - Overrides for the weather definition in serverConfig.py (Site-level file)
Maps.py - Defines the automatically generated edit areas that are available.
localMaps.py - Overrides for the Maps.py file (Site-level file).
Map Files - overview - Explains how database tables are populated for use in the map and edit area generation.
VTECPartners.py - Defines the VTEC coordination and filtering by site.
localVTECPartners.py - Overrides for the VTECPartners.py entries (Site-level file).

The localConfig.py and localWxConfig.py files are optional and are only used to override the standard database definition defaults shipped with the system.

There are several different options a site has for making modifications to these files. At no time should the files that are sent with the software release or install be modified since these will be overwritten with the next upgrade. See the section on file locations for information on where the configuration files should be located.

The serverConfig.py is used to define the following items:

the set of weather elements,
the weather configuration (e.g., possible coverages, weather types, intensities),
the set of map projections,
office grid domains and resolution,
grid time constraint information; and
database model configuration.

The localConfig.py file is used:

to add or redefine items in the serverConfig.py file for site use.

The localWxConfig.py file is used:

to add or modify the weather definition in serverConfig.py

The siteConfig.py file is used:

to identify the main directories
to identify the server network information
to identify the site identifier

The VTECPartners.py file is used:

to configure the site filtering for the Merge VTEC and VTEC Decoder processes
to configure the interval of active table synchronization with adjacent sites
to specify the adjacent sites used for active table synchronization

The localVTECPartners.py file is used:

to override the entries in VTECPartners.py.

The localMaps.py file is optional and is only used to override the standard edit area definitions shipped with the system. There are several different options a site has for making modifications to this file. At no time should the files that are sent with the software release or install be modified since these will be overwritten with the next upgrade. See the section on file locations for information on where the configuration files should be located.

The Maps.py file is used to define:

the set of edit areas that are automatically generated from the map backgrounds.

The localMaps.py file is used:

to add, remove, or redefine items in the Maps.py file for site use.

Server Database Configuration Modification Options

There are three scenarios for modifying the server database configuration: no changes from installed files, complete override of map backgrounds and partial orerride of map backgrounds.

No Changes From Installed Files

This is the default case. There is nothing you need to do.

Complete Override of Server Configuration (not recommended)

Copy the serverConfig.py from the original location (leave the original one there) to the customized location. Modify it in accordance with the serverConfig.py manual. The disadvantage of this situation is that you will need to do a careful comparison between newly upgraded files and your modified files after each upgrade. There are certain features that cannot be overridden using the localConfig.py file. For those cases, you will be forced to completely override the serverConfig.py file. See the localConfig.py file for href="VTECPartners.html">VTECPartners.py from the original location (leaving the original one there) to the customized location.

Partial Override of Server Configuration

This option works best for most sites who require just a few changes and/or additions to the server configuration. It involves creating a local configuration file (localConfig.py) and overriding certain features. Not all features in serverConfig.py may be redefined or overridden in this manner. See the localConfig.py documentation for details. Weather definitions are overridden using the localWxConfig.py file. VTEC coordination information is overridden using the localVTECPartners.py file.

Server Map Configuration Modification Options

Edit area generation is handled somewhat differently from the server database configuration and is defined in a different file.

No Changes From Installed Files

This option should be chosen if the Maps.py file is satisfactory and no changes are required.

Partial Override of Map Backgrounds

This option provides the site control over the set of generated edit areas. If you want to change any item in the Maps.py file, you use the localMaps.py file to add, modify, and/or remove edit areas.

Complete Override of Map Backgrounds (not recommended)

There should be no reason to completely override the Maps.py file since localMaps.py provides all of the override capability. But if you insist, you can copy the Maps.py file from the original location (leave the original one there) to the customized location. Modify it in accordance with the map configuration manual. Since Maps.py doesn't change frequently, all you should need to do is a comparison between the newly upgraded files and your modified files after each upgrade.

Location of Files

The location of the server configuration files are shown in the table below:

File Purpose	Part of Standard Release	File Location (relative to installation directory)
Original serverConfig.py	yes	/awips2/edex/data/utility/edex_static/base/config/gfe
Customized serverConfig.py	no	/awips2/edex/data/utility/edex_static/site/SITE_ID/config/gfe
localConfig.py	no	/awips2/edex/data/utility/edex_static/site/SITE_ID/config/gfe
localWxConfig.py	no	/awips2/edex/data/utility/edex_static/site/SITE_ID/config/gfe
Original Maps.py	yes	/awips2/edex/data/utility/edex_static/base/config/gfe/Maps.py
Customized Maps.py	no	/awips2/edex/data/utility/edex_static/site/SITE_ID/config/gfe/Maps.py
localMaps.py	no	/awips2/edex/data/utility/edex_static/site/SITE_ID/config/gfe/localMaps.py
Original VTECPartners.py	yes	/awips2/edex/data/utility/common_static/base/vtec
Customized localVTECPartners.py	no	/awips2/edex/data/utility/common_static/site/SITE_ID/vtec