TSTool / Command / WriteSHEF
WriteSHEF command write time series to a Standard Hydrologic Exchange Format (SHEF) .A record format file.
See the SHEF Input Type appendix for more information about the file format.
The SHEF physical element (PE) codes are similar to time series data type codes.
The PE code is looked up based on data type information that is available for the execution environment.
Currently there is no default PE information.
The PE code can be supplied using the
Additional parameters are being added to use a lookup table.
This command has primarily been developed to handle hourly data and additional enhancements may be needed for other intervals and data types.
The following dialog is used to edit the command and illustrates the syntax of the command.
WriteSHEF Command Editor for Input Time Series Parameters (see also the full-size image)
WriteSHEF Command Editor for SHEF Data Parameters (see also the full-size image)
WriteSHEF Command Editor for Output Parameters (see also the full-size image)
The command syntax is as follows:
||Indicates the list of time series to be processed, one of:
||The time series identifier or alias for the time series to be processed, using the
||The ensemble to be processed, if processing an ensemble. Can be specified using
||The SHEF output file. The path to the file can be absolute or relative to the working directory (command file location).||None – must be specified.|
||Indicate whether the output should be appended to the file.||
||Pairs of data type and SHEF physical element (PE) codes. The pairs should be separated by semicolons and the data type/PE strings by commas. For example, the data values for instantaneous streamflow and air temperature might be:
||Use information determined for operational environment, if available.|
||The date/time for the start of the output.||Use the global output period.|
||The date/time for the end of the output.||Use the global output period.|
||The time zone to be used for all SHEF records.||
||Observation time to use for all SHEF records. Specify as a full string (e.g.,
||Time corresponding to time series data values.|
||The creation date to use for all SHEF records. Specify as a full string (e.g.,
||Not used in output.|
||The duration code to use for all SHEF records. Specify as a literal string (e.g.,
||Determined automatically from irregular time series, not used for regular interval time series.|
||Number of digits after the decimal to use for output.||Determine from the time series data units, or use 2 by default.|
See the automated tests.