GFESuite Directory Layout

March 27, 2012

Overview

This document describes the install and runtime directory structure for the AWIPS sites. In AWIPS2, directories are split up into EDEX side (server) and CAVE side (client). On both sides, the top-level directory is /awips2, however EDEX operations are mainly run on dx3/dx4, with data management (PyPies) on dx1. CAVE operations and directory structure reside on lx/xt workstations. This page describes *SOME* of the important directories accessed by GFE. The directory tree is described in the following parts:

EDEX top-level runtime directory, consisting of the descriptions of the executables and static data
CAVE top-level runtime directory, consisting of the descriptions of the executables and static data
the "database" directory structure, as controlled by PyPies
the "GRID" directory structure, which contains all of the model, Forecast, and Official databases
the model, Forecast, and Official database file structure
the data structure on AWIPS MHS to support intersite coordination of grids

EDEX Top - Level Runtime Directory

The top-level runtime directory consists of several other directories. The top-level directories are:

**Top-Level EDEX Directories**
Directory Name	Purpose
edex	top-level data and executables
GFESuite	top-level utilities, data and Service Backup

The following tables describe files and directory structures within each of the top-level directories:

EDEX Sub-Directories

Filename or Directory Name Purpose

edex/bin top-level configuration and startup scripts

edex/conf Top-level edex configuration for logs and services

edex/data Top-level data, utilities and edex configuration files including localizations and vcmodule for virtual ISC displays

edex/etc runtime parameters for different edex runtime levels and services like ingest/request

edex/lib location of libraries used by edex

edex/logs edex logfiles

edex/webapps scripts run by uengine

**Relevant Top-Level CAVE Directories**
Filename or Directory Name	Purpose
alertviz	AlertViz executables and settings
cave	cave configurations and executables including cave.sh
GFESuite	command line interface executables for GFE

Important CAVE Sub-Directories

Filename or Directory Name Purpose

cave/etc/gfe GFE base level tools, procedures, utilities and configurations

cave/etc/ghg GHG monitor executables and configurations

cave/configuration Eclipse runtime settings

GFESuite/bin location of command line interface executables

Executable and Script Directories (/awips2/GFESuite/bin)

Filename or Directory Name Purpose

bin/configureTextProducts Configure Text Products utility for querying the afos2awips.txt table for PILs, deleting, and recreating product templates.

bin/dumpAT VTEC active table dump utility for AWIPS map coordinates to lat/lon and vice versa

bin/getNotify.py notification debug utility to show database notifications from EDEX

bin/gfeclient.sh a wrapper script that allows to execute command line scripts in EDEX

bin/ghgMonitor
GHG Monitor Program

bin/ifpAG ifpAG executable

bin/ifpBreakAllLocks script to break all locks in the server

bin/ifpIMAGE script to run the GFE as the ifpIMAGE program

bin/ifpInit script to run the smart initialization program

bin/ifpnetCDF script to run the ifpnetCDF program.

bin/ifpServerText script to run the ifpServerText program

bin/iscMosaic script to run the iscMosaic program

bin/moveGFEData utility program to move gfe configuration data from one user to another

bin/purgeAllGrids
script to delete all grids from a specified database.

bin/runIFPText script to run text generation (GFE in background mode)

bin/runProcedure script to run a procedure (GFE in background mode)

bin/sendGfeMessage
script to send messages to all clients connected to EDEX, message appears in AlertViz

bin/VTECDecoder
script to run VTEC decoder

bin/src
contains sub-directories with executables called by the scripts listed in this table

etc/gfe (configuration) Important Directories

Filename or Directory Name Purpose

combinations default zone combo configuration

editAreaGroups default edit area groups

editAreas default edit areas

sampleSets default sample sets

userPython baseline smart tools, procedures, gfeConfig files, text products, text utilities, and other utilities used by tools and procedures

weGroups default weather element groups

etc/ghg Sub-Directory

Filename or Directory Name Purpose

config contains default GHG monitor configuration file

userPython contains the MakeHazard utility and TCMETNDecoder

In AWIPS2 the database is on dx1 under /awips2/edex/data/hdf5. The sub-directories used by GFE are grib and gfe. The grib sub-directory contains grib model data. The gfe/SITE_ID sub-directory contains GFE grid databases including Fcst, Official, ISC, Restore, and any model databases. Topography databases are also found here.

GRID Database Structure

The model, Forecast, and Official databases are stored in the /awips2/edex/data/hdf5/gfe/SITE_ID directory tree. The first level subdirectories are the model names, e.g., NAM and Fcst. Within each model directory will be a series of database files contained in a directory that represents the date and time of the data, i.e., 2012_03_27_0600/RNK_GRID__GFS40_20120327_0600.h5. A database contains all of the grid and metadata needed to represent the weather elements. Each database actually consists one HDF5 file.

The name of each database represents the:

Site identifier (e.g., BOU)
Format of the database (always GRID)
Model Name (e.g., NAM12)
Optional Database Type (e.g., V)
Date/Time of Model Run (e.g., 20001214_0000)

Model Data / Forecast Data File Structure

Each model (e.g., NAM), Forecast, and Official database is stored in HDF5 file format. The model name is in the following format: site_GRID_ot_date_time, where site is the WFO identifier, ot is the optional type, date and time are the date-time stamp for the model valid time. If the date/timestamp is all zeros (00000000_0000), then the model is "rolling" or not time-based. In this case the files are never purged from the system. Typically the Forecast and Official databases are set up to be permanent. Another word to describe this case is a singleton model. The *.h5 file contains the following information:

Grid data.
Grid Parm Info of each weather element, that fully describes how the data is represented in the system.
Grid Parm Storage Information for the database

Text Products Directory Structure

The /awips2/edex/data/utility/edex_static/base/textproducts directories are used for configuring the GFE formatters that are "templated". When AWIPS is installed, the formatters are created from templates. The templates, and the routines to expand them into products are contained in the text installation directory structure. See the Readme.txt file for detailed information.

MHS Directory Structure

The MHS Directory Structure to support GFESuite is quite small, but necessary. The directory structure is used to support Intersite Coordination of Grids. The MHS host on AWIPS is "ds1" prior to OB7, and "dx1" OB7 and after.

There os one spooling directory for incoming messages to the AWIPS Message Handling System, and two scripts to support the intersite coordination grids.

Filename or Location Purpose Part of Release

/awips2/GFESuite/products/ISC ISC spooling directory for incoming data. Installed as a part of AWIPS

/awips2/GFESuite/bin/iscDataRec Script that requests processing from EDEX for grids received from the AWIPS WAN. Installed as a part of AWIPS

/awips2/edex/data/utility/edex_static/base/gfe/isc/iscDataRec.py Receive script called by the IscDataRecRequestHandler when intersite data has been received from other sites. Installed as a part of AWIPS