Version 2
Copyright © 2005-2012 Delaware Environmental Observing System
Published: December 16th 2005
| Revision History | ||
|---|---|---|
| Revision 1.1 | 2005/12/16 | GEQ |
| Initial version | ||
| Revision 1.2 | 2006/04/13 | GEQ |
| Added grid command line option. | ||
| Revision 2.1 | 2006/09/26 | GEQ |
| Incremented version number of this document to 2. | ||
| Revision 2.2 | 2006/12/15 | GEQ |
| Corrected program description and use within cron. | ||
| Revision 2.3 | 2007/01/03 | GEQ |
| Added team option. | ||
| Revision 2.1.4 | 2007/09/28 | GEQ |
| Added the field types table. | ||
| Revision 2.1.7 | 2008/03/21 | GEQ |
| Added additional fields available in this version. Removed unit type options. Removed field type option. | ||
Table of Contents
The program is executed by the command dfe from the command line.
dfe { -u username | --user username } { -p password | --password password } { -d database | --database database } { -t name | --team name } [--begin date] [ -o value | --offset value ] [ -g name | --grid name ] [--stride length] [--filenamename] [--dump-typename] {--productslist} [ -v value | --verbose value ] [ -h | --help ]
The dfe program uses database configuration parameters to determine which field types are currently being processed. Other parameters are provided on the command line.
The specification for the user option is:
{ -u username | --user username | --user=username }
This option will allow the program to connect to the database using the username provided. The user must already exist, and have sufficient permissions to access the database specified. This item is required.
The specification for the password option is:
{ -p password | --password password | --password=password }
This option in combination with the username allows the program to connect to the database using the username provided. This item is required.
The specification for the database option is:
{ -d database | --database database | --database=database }
This option will specify which database the program should use as a source of data, configuration items and a destination for any event logging items. This item is required.
The specification for the team option is:
{ -t name | --team name | --team=name }
This option specifies a team and associated data for use during processing. The associated data for a team includes the Area of Interest (AOI). If the team name includes spaces, the string must be placed in quotes.
The specification for the begin option is:
[ --begin time string | --begin=time string ]
This option specifies a timestamp for data processing to begin. The time string format can be either YYYYMMDDHHMMSS or YYYY-MM-DD HH:MM:SS. If the latter is used, the string must be placed in quotes.
The default is the current time. The time string, if provided, must contain at least the year, month and day of month. If the hours, minutes and seconds entries are missing, the default is midnight.
The specification for the offset option is:
[ -o value | --offset value | --offset=value ]
This option specifies the time interval by which the entered date will be corrected. The value is assumed to be in minutes. Positive values are assumed to point the date to earlier times. This option is intended to be used for real-time use as in a cron.
The specification for the grid option is:
[ -g grid name | --grid grid name | --grid=grid name ]
This option specifies a grid name for output of gridded data. The default is 'DEOS' as in the DEOS grid.
The specification for the stride option is:
[ --stride value | --stride=value ]
This option specifies the time period increment that is used when generating timesteps for data generation. An error will be generated if a value of less than 5 minutes is given. The value is in minutes. The default is 60.
The specification for the filename option is:
[ -f filename | --filename filename | --filename=filename ]
This option specifies a file name for output.
The specification for the dump file type is:
[ --dump-type [gis] | --dump-type=[gis] ]
This option will specify which file type the data will be placed in. The default value is 'gis'.
The specification for the products option is:
{ --products items | --products=items }
This option (a numerical list of one or more values) specifies which time component files will be generated in stride units from the begin time going backwards in time. For example an item list of '1,2' and a stride of 60 will provide one hour and two hour summary files on output, based from the begin time. The filename will be that provided by the command line, with a '1' or '2', appended as appropriate. The largest product number allowed is 744.
The specification for the verbose option is:
[ -v value | --verbose value ]
The value provided for the verbose setting (a digit between 0 and 5) indicates how much output is generated, 0 being minimal and 5 being extremely verbose. Positive values of setting send data to the ELF, negative value also print the message to the screen. If no value is provided, the setting is assumed to be 1.
The following table outlines the available fields in the DEOS system.
Table 1. Field Types
| ID | Abbreviation | Description |
|---|---|---|
| 0 | FUP60 | Radar Mosaic (60 minute) |
| 2 | FCP60 | Calibrated Radar Mosaic (60 minute) |
| 4 | PAT00 | Potential Temperature |
| 5 | EAT00 | Equivalent Temperature |
| 6 | EPT00 | Equivalent Potential Temperature |
| 7 | ATF00 | Air Temperature |
| 8 | RHM00 | Relative Humidity |
| 9 | WIF00 | Wind Vector Field |
| 10 | SRF00 | Solar Radiation |
| 11 | WTF00 | Water Temperature |
| 13 | SLP00 | Sea Level Pressure |
| 14 | DEM99 | Digital Elevation Model |
| 15 | AAT00 | Apparent Temperature |
| 16 | PEM24 | Potential Evapotranspiration (Harmon (1963)) |
| 17 | PEG24 | Potential Evapotranspiration (Hargreaves (1985)) |
| 18 | RET24 | Reference Evapotranspiration |
The following database tables provide configuration options for the dfe program.