Skip to content

StateDMI / Command / ReadInstreamFlowStationsFromList

Overview

The ReadInstreamFlowStationsFromList command (for StateMod) reads a list of instream flow stations from a delimited list file and defines instream flow stations in memory. The instream flow 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.

ReadInstreamFlowStationsFromList command editor

ReadInstreamFlowStationsFromList Command Editor (see also the full-size image)

Command Syntax

The command syntax is as follows:

ReadInstreamFlowStationsFromList(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. None – optional (name will be initialized to blank).

Examples

See the automated tests.

At a minimum, the list file must contain a column with instream flow 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"
IFS1,”INSTREAM FLOW REACH 1”
IFS2,”INSTREAM FLOW REACH 2”

Troubleshooting

See the main troubleshooting documentation

See Also