DSET
CHSUB
DTYPE
INDEX
STNMAP
TITLE
UNDEF
UNPACK
FILEHEADER
THEADER
XYHEADER
XVAR
YVAR
ZVAR
STID
TVAR
TOFFVAR
OPTIONS
PDEF
XDEF
YDEF
ZDEF
TDEF
VECTORPAIRS
VARS
ENDVARS
ATTRIBUTE METADATA
COMMENTS
DSET data_filename | back to top | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
This entry specifies the filename of the data file being described. If the data and the descriptor file are not in the same directory, then data_filename must include a full path. If a ^ character is placed in front of data_filename, then data_filename is assumed to be relative to the path of the descriptor file. If you are using the ^ character in the DSET entry, then the descriptor file and the data file may be moved to a new directory without changing any entries in the data descriptor file, provided their relative paths remain the same. For example: If the data descriptor file is: If data_filename does not include a full path or a ^, then GrADS will only look for data files in the directory where you are running GrADS. GrADS allows you use a single DSET entry to aggregate multiple data files
and handle them as if they were one individual file. The individual data
files must be identical in all dimensions except time, and the time range
of each individual file must be indicated it its filename. To accomplish
this, the DSET entry has a substitution template instead of a filename.
See the section on Using Templates
for a description of all the possible components of the template. Second,
the OPTIONS entry must contain the template keyword. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
CHSUB t1 t2 string | back to top | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
(GrADS version 1.9b4) This
entry is used with a new option for templating data files that allows
for any user-specified string substitution, instead of only date string
substitution. This is useful when none of the standard template options
match the time ranges in the files you wish to aggregate, or if the files
are located on different disks. When you put the |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
DTYPE keyword | back to top | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
The DTYPE entry specifies the type of data being described.
There are four options: grib, hdfsds, netcdf, or station. If the data type
is none of these, then the DTYPE entry is omitted completely from the descriptor
file and GrADS will assume the data type is gridded binary.
|
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
back to top | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
This entry specifies the name of the grib map file. It is required when using the DTYPE grib entry to read grib formatted data. The file is generated by running the external utility gribmap. Filenaming conventions are the same as those described for the DSET entry. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
STNMAP filename | back to top | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
This entry specifies the name of the station map file. It is required when using the DTYPE station entry to read GrADS-formatted station data. The file is generated by running the external utility stnmap. Filenaming conventions are the same as those described for the DSET entry. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
back to top | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
This entry gives brief description of the contents of the data set. String will be included in the output from a query command and it will appear in the directory listing if you are serving this data file with the GrADS-DODS Server (GDS), so it is helpful to put meaningful information in the title field. For GDS use, do not use double quotation marks (") in the title. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
UNDEF value <undef_attribute_name> | back to top | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
This entry specifies the undefined or
missing data value. UNDEF is a required entry even if there are
no undefined data. GrADS operations and graphics routines will ignore
data with this value from this data set. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
UNPACK scale_factor_attribute_name <add_offset_attribute_name> | back to top | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
(GrADS version 1.9)
This entry is used with DTYPE netcdf or hdfsds for
data variables that are 'packed' -- i.e. non-float data that need to be
converted to float by applying the following formula: y = x * scale_factor + add_offset Only the attribute name for the scale factor is required. If your netcdf or hdfsds file does not have an offset attribute, the 2nd argument may be omitted, and the offset will be assigned the default value of 0.0. Attribute names are case sensitive, and it is assumed that the names are identical for all variables in the netcdf or hdfsds data file. If the names given do not match any attributes, the scale factor will be assigned a value of 1.0 and the offset will be assigned a value of 0.0. The transformation of packed data is done after the undef test has been applied. Examples: UNPACK scale_factor add_offset UNPACK Slope Intercept |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
back to top | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
This optional entry tells GrADS that your data file has a header record of length bytes that precedes the data. GrADS will skip past this header, then treat the remaineder of the file as though it were a normal GrADS binary file after that point. This optional descriptor file entry is only valid for GrADS gridded data sets. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
back to top | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
This optional entry tells GrADS that the data file has a header record of length bytes preceding each time block of binary data. This optional descriptor file entry is only valid for GrADS gridded data sets. See the section on structure of a gridded binary data file for more information. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
XYHEADER length | back to top | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
This optional entry tells GrADS that the data file has a header record of length bytes preceding each horizontal grid (XY block) of binary data. This optional descriptor file entry is only valid for GrADS gridded data sets. See the section on structure of a gridded binary data file for more information. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
XVAR x,y | back to top | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
(GrADS version 1.9) This entry provides the x,y pair for the station's longitude. This entry is required for DTYPE bufr. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
YVAR x,y | back to top | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
(GrADS version 1.9) This entry provides the x,y pair for the station's latitude. This entry is required for DTYPE bufr. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
ZVAR x,y | back to top | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
(GrADS version 1.9) This entry provides the x,y pair for the station data's vertical coordinate (e.g., pressure). This is an optional entry for DTYPE bufr. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
STID x,y | back to top | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
(GrADS version 1.9) This entry provides the x,y pair for the station ID. This entry is required for DTYPE bufr. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
TVAR yr x,y mo x,y dy x,y hr x,y mn x,y sc x,y | back to top | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
(GrADS version 1.9) This entry provides the x,y pairs for all the base time coordinate variables. Each time unit (year=yr, month=mo, day=dy, hour=hr, minute=mn, second=sc) is presented as a 2-letter abbreviation followed by the x,y pair that goes with that time unit. The time for any individual station report is the base time plus the offset time (see TOFFVAR). All six base time units are not required to appear in the TVAR record, only those that are in the data file. This entry is required for DTYPE bufr. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
TOFFVAR yr x,y mo x,y dy x,y hr x,y mn x,y sc x,y | back to top | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
(GrADS version 1.9) This entry provides the x,y pairs for all the offset time coordinate variables. The syntax is the same as TVAR. The time for any individual station report is the base time plus the offset time. All six offset time units are not required to appear in the TOFFVAR record, only those that are in the data file. This is an optional entry for DTYPE bufr. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
back to top | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
This entry controls various aspects of the way GrADS interprets the raw data file. It replaces the old FORMAT record. The keyword argument may be one or more of the following:
|
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
PDEF | back to top | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
PDEF is so powerful it has its own documentation page. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
back to top | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
This entry defines the grid point values for the X dimension, or longitude. The first argument, xnum, specifies the number of grid points in the X direction. xnum must be an integer >= 1. mapping defines the method by which longitudes are assigned to X grid points. There are two options for mapping:
LEVELS Longitudes specified individually The LINEAR mapping method requires two additional arguments: start and increment. start is a floating point value that indicates the longitude at grid point X=1. Negative values indicate western longitudes. increment is the spacing between grid point values, given as a positive floating point value. The LEVELS mapping method requires one additional argument, value-list, which explicitly specifies the longitude value for each grid point. value-list should contain xnum floating point values. It may continue into the next record in the descriptor file, but note that records may not have more than 255 characters. There must be at least 2 levels in value-list; otherwise use the LINEAR method. Here are some examples:
|
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
YDEF ynum mapping <additional arguments> | back to top | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
This entry defines the grid point values for the Y dimension,
or latitude. The first argument, ynum, specifies the number of grid
points in the Y direction. ynum must be an integer >= 1. mapping
defines the method by which latitudes are assigned to Y grid points. There
are several options for mapping:
LEVELS Latitudes specified individually GAUST62 Gaussian T62 latitudes GAUSR15 Gaussian R15 latitudes GAUSR20 Gaussian R20 latitudes GAUSR30 Gaussian R30 latitudes GAUSR40 Gaussian R40 latitudes The LINEAR mapping method requires two additional arguments: start and increment. start is a floating point value that indicates the latitude at grid point Y=1. Negative values indicate southern latitides. increment is the spacing between grid point values in the Y direction. It is assumed that the Y dimension values go from south to north, so increment is always positive. The LEVELS mapping method requires one additional argument, value-list, which explicitly specifies the latitude for each grid point, from south to north. value-list should contain ynum floating point values. It may continue into the next record in the descriptor file, but note that records may not have more than 255 characters. There must be at least 2 levels in value-list; otherwise use the LINEAR method. The Gaussian mapping methods require one additional argument: start. This argument indicates the first gaussian grid number. If the data span all latitudes, start would be 1, indicating the southernmost gaussian grid latitude. Here are some examples:
The NCEP/NCAR Reanalysis surface variables are on the GAUST62 grid. The final example shows that there are 20 Y dimension values which start at Gaussian Latitude 15 (64.10 south) on the Gaussian R40 grid |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
ZDEF znum mapping <additional arguments> | back to top | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
This entry defines the grid point values for the Z dimension. The first argument, znum, specifies the number of pressure levels. znum must be an integer >= 1. mapping defines the method by which longitudes are assigned to Z grid points. There are two options for mapping: LINEAR Linear mapping The LINEAR mapping method requires two additional arguments: start and increment. start is a floating point value that indicates the longitude at grid point Z=1. increment is the spacing between grid point values in the Z direction, or from lower to higher. increment may be a negative value. The LEVELS mapping method requires one additional argument, value-list, which explicitly specifies the pressure level for each grid point in ascending order. value-list should contain znum floating point values. It may continue into the next record in the descriptor file, but note that records may not have more than 255 characters. There must be at least 2 levels in value-list; otherwise use the LINEAR method. Here are some examples:
|
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
TDEF tnum LINEAR start increment | back to top | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
This entry defines the grid point values for the T dimension. The first argument, tnum, specifies the number of time steps. tnum must be an integer >= 1. The method by which times are assigned to T grid points is always LINEAR. start indicates the initial time value at grid point T=1. start must be specified in the GrADS absolute date/time format:
where:
If not specified, hh defaults to 00, mm defaults to 00, and dd defaults to 1. The month and year must be specified. No intervening blanks are allowed in the GrADS absolute date/time format. increment is the spacing between grid point values in the T direction. increment must be specified in the GrADS absolute time increment format:
where:
Here are some examples:
|
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
VECTORPAIRS U-component,V-component | back to top | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
(GrADS version 1.9b4) This entry is for explicity identifying vector component pairs. This is only necessary if the data are on a native projection other than lat/lon (i.e. you are using PDEF) and if the winds have to be rotated from a grid-relative sense to an Earth-relative sense. (GrADS has to retrieve both the u and v component in order to do the rotation calculation.) Using this entry replaces the old technique of putting 33 (for U) or 34 (for V) in the first element of the units field in the variable declaration. The U-component and V-component arguments should be variable names that appear in the VARS list. They are separated by a comma, with no spaces. More than one pair of components may be listed; in this case, the pairs should be separated by a space. For example:
|
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
VARS varnum variable_record_1 variable_record_2 ... variable_record_varnum ENDVARS |
back to top | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
This ensemble of entries describes all the variables contained in the data set. varnum indicates the number of variables in the data set and is therefore also equal to the number of variable records that are listed between the VARS and ENDVARS entries. ENDVARS must be the final line of the Grads data descriptor file. Any blank lines after the ENDVARS statement may cause open to fail! The format of the variable records is as follows: varname levs units description The syntax of varname and units is different depending on what kind of data format (DTYPE) you are describing. Details provided below:
|
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
@ varname attribute_type attribute_name attribute_value | back to top | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
(GrADS version 1.9b4) To supplement the metadata in your descriptor file, use attribute comments. The first two characters of the attribute comment must be "@" followed by a space -- this distinguishes it from an ordinary comment (see below). Attribute comments may appear anywhere in the descriptor file, and they will be ignored if used with older versions of GrADS. All file attributes may be retrieved with the 'query attr' command. varname may be set to "global" to describe general attributes that are valid for the entire data set. Set varname to "lon", "lat", "lev", or "time" to describe attributes of the four coordinate axes; otherwise, use one of the variable names listed in the variable declarations. If a variable name is aliased, use the grads_varname instead of the native SDF_varname. attribute_type should be one of the following case-sensitive types: String, Byte, Int16, UInt16, Int32, UInt32, Float32, Float64. attribute_name may be any single word or string with no spaces (e.g.: "units", "minimum_value") attribute_value can be any string as long as the length of the entire entry does not exceed 512 characters. For example: |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
* comment | back to top | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
You may put comments in your descriptor file by beginning the entry with * . Use @ for formatted attribute comments (see above). | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||