Version 2
Copyright © 2004-2012 Delaware Environmental Observing System
Published: September 13th 2004
| Revision History | ||
|---|---|---|
| Revision 1.1 | 2004/09/13 | GEQ |
| Initial version | ||
| Revision 1.2 | 2005/06/14 | GEQ |
| Revised command line arguments for loop processing and other options. | ||
| Revision 1.3 | 2006/03/30 | GEQ |
| Added field-type command line option. | ||
| Revision 1.4 | 2006/04/12 | GEQ |
| Added input command line option. Added related file format description. | ||
| Revision 2.1 | 2006/09/26 | GEQ |
| Incremented version number of this document to 2. | ||
| Revision 2.2 | 2006/12/15 | GEQ |
| Corrected the purpose of this program and clarified operational use within cron. | ||
| Revision 2.3 | 2007/03/01 | GEQ |
| Added the radar recalibration options. | ||
| Revision 2.1.4 | 2007/09/28 | GEQ |
| Added the field option to allow abbreviations to be used to specify the field. | ||
Table of Contents
The DEOS rrpm program provides the functionality to generate a gridded and mosaicked radar precipitation field on a defined geographic grid.
The program is executed by the command rrpm from the command line.
rrpm { -u user-name | --user user-name } { -p password | --password password } { -d database | --database database } [--begin date] [--end date] [ -o value | --offset value ] [--stride length] [--steps value] [--slack value] [ -g gridname | --grid gridname ] [--file-write filename] [--field-type value] [--field value] [ -v value | --verbose value ] [ -i input-coord-list | --input input-coord-list ] [ --exponent value | --exponent=value ] [ --multiplier value | --multiplier=value ] [ --parameters list | --parameters=list ] [ -h | --help ]
The rrpm program uses database data to determine which DPA files are available and will use the appropriate files to generate the requested product.
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 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 end option is:
[ --end time string | --end=time string ]
This option specifies a timestamp for data processing to end. The time string format can be YYYYMMDDHHMMSS or YYYY-MM-DD HH:MM:SS. If the latter is used, the string must be placed in quotes.
The default is the time the program is run. 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 end time must be later, i.e. more recent, than the start time.
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 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 steps option is:
[ --steps value | --steps=value ]
This option specifies the number of time steps for which data is to be processed from a defined start time. If this option, and the end time are both provided, the latter will prevail. The default is 1.
The specification for the slack option is:
[ --slack value | --slack=value ]
This option specifies the "slackness" allowed for retrieval of a file or set of files. A file is assumed to be valaid, if it within plus or minus the value for slack. The value is assumed to be in minutes. Default is 10.
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 field option is:
[ -f value | --field value | --field=value ]
This option specifies which field type is to be generated. For the rrpm program the default is FCP60 (calibrated radar mosaic). For the ifgen program the default is to generate all enabled fields as defined in the database; if more than one field is required, the list needs to be comma-separated. If spaces are embedded in the list, the entire list needs to be quoted.
The specification for the file write option is:
[ --file-write outfile | --file-write=outfile ]
This option specifies a file name for placing output data into. If this option is not present, no file is generated.
The specification for the input option is:
[ -i name | --input name | --input=name ]
This option specifies an input item, typically a file name.
The specification for the exponent option is:
[ --exponent value | --exponent=value ]
This option specifies a value for the Z/R relationship exponent value to be applied to all DPA data files. There is no default. Values must be between 1.0 and 2.0.
The specification for the multiplier option is:
[ --multiplier value | --multiplier=value ]
This option specifies a value for the Z/R relationship multiplier value to be applied to all DPA data files. There is no default. Values must be between 50 and 500.
The specification for the parameters option is:
[ --parameters list | --parameters=list ]
This option specifies a set of Z/R exponents and multipliers to be applied to the appropriate DPA radar data files to provide input to the calibrated product. The list shall contain one or more sets of three values, repeated as necessary, firstly the name of the radar in upper-case, secondly, the exponent and lastly the multiplier. The values shall be separated by one of the following characters '/', ',', ';' or ':'. The entire string must be placed in quotes, if either there are embedded spaces, or other characters with special meaning to the shell, in particular the semi-colon. For example, the list: "KHGX;2.0;100;KLCH;1.0;500". There is no default, radar files that do not have parameters will be left unchanged. This option may appear as often as necessary. If this option is provided, the exponent and multiplier options are ignored.
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 input coordinate file option must point to a file conforming to the description given in this section.
Records (lines) are assumed to be whitespace delimited fields of the following data.
Latitude (in decimal degrees)
Longitude (in decimal degrees)
The following database tables provide configuration options for the rrpm program.
This table contains settings for the program DEOS handles. See DTN #13 for details.
For operational use, it is expected that the rrpm program be run from inside the cron system. The most appropriate installation would be to run the rrpm program immediately after DPA file ingest. In this case, the default value of begin should be used and a value for offset appropriate for the latency of the DPA file feed. In this case the offset value and the minute of the hour the cron job is fired need to be coordinated.