TSTool / Command / ReadStateModB
ReadStateModB command reads time series from a StateMod binary output time series file.
See the StateModB Input Type Appendix.
The identifiers (or aliases) from the time series will be available as choices when editing other commands.
If this causes performance issues due to the large number of time series that may be read,
limit the time series that are read using the
The following dialog is used to edit the command and illustrates the syntax of the command.
ReadStateModB Command Editor (see also the full-size image)
The command syntax is as follows:
|The name of the StateMod binary time series file to read, surrounded by double quotes. The path to the file can be absolute or relative to the working directory. Global property values can be inserted using the syntax
||None – must be specified.|
||Time series identifier pattern to filter the read. Use periods to indicate separate TSID parts and use * to match patterns within the parts.||Read all time series.|
||The starting date/time to read data, specified to Day or Month precision based on whether a daily or monthly model run.||Read all data.|
||The ending date/time to read data, specified to Day or Month precision based on whether a daily or monthly model run.||Read all data.|
||StateMod version number using the form
||Detect from the file if possible.|
||The alias to assign to the time series that are read. Use the format choices and other characters to define a unique alias.||No alias is assigned.|
See the automated tests.
The following example command file illustrates how to read all
time series for identifiers starting with
44 (e.g., to extract all such time series for a water district):
The following example illustrates how to read all time series from a binary file that was created with StateMod version 9.53. As shown in the example, debug can be turned on for the log file to evaluate issues with the file format.
StartLog(LogFile="commands.TSTool.log") SetDebugLevel(0,1) ReadStateModB(InputFile="COLOFB.B43",Version="09.53")