StateDMI / Command / ReadStreamGageStationsFromList
Overview
The ReadStreamGageStationsFromList
command (for StateMod)
reads a list of stream gage stations from a delimited list file and defines stream gage stations in memory.
The stream gage stations can then be manipulated and output with other commands.
Command Editor
The following dialog is used to edit the command and illustrates the command syntax.
ReadStreamGageStationsFromList
Command Editor (see also the full-size image)
Command Syntax
The command syntax is as follows:
ReadStreamGageStationsFromList(Parameter="Value",...)
Command Parameters
Parameter | Description | Default |
---|---|---|
ListFile required |
The name of the list file to be read. | None – must be specified. |
IDCol required |
The column number (1+) containing the stream gage station identifiers. | None – must be specified. |
NameCol |
The column number (1+) containing the stream gage station names. | If not specified, set to blank. |
RiverNodeIDCol |
The column number (1+) containing the river node identifier. | If not specified, set to blank. |
DailyIDCol |
The column number (1+) containing the daily identifier (for estimating time series). | If not specified, set to blank. |
Examples
See the automated tests.
At a minimum, the list file must contain a column with stream gage station identifiers.
Lines starting with the #
character are treated as comments.
If the first line’s values are surrounded by double quotes, the line is assumed to indicate column headings.
A sample list file is shown below:
# Stream gage stations as a list file
#
"ID”,"Name"
08213500,”RIO GRANDE RIVER AT THIRTY MILE BRIDGE NEAR CREEDE”
08214500,”NORTH CLEAR CREEK BELOW CONTINENTAL RESERVOIR”
...
Troubleshooting
See Also
ReadStreamGageStationsFromNetwork
commandReadStreamGageStationsFromStateMod
commandWriteStreamGageStationsToStateMod
command