TSTool / Command / ReadStateCU
Overview
The ReadStateCU
command reads all the time series in a StateCU time series file
(e.g., frost dates) or report file (e.g., IWR, WSL).
See the StateCU Input Type Appendix.
Command Editor
The following dialog is used to edit the command and illustrates the syntax of the command.
ReadStateCU
Command Editor (see also the full-size image)
Command Syntax
The command syntax is as follows:
ReadStateCU(Parameter="Value",...)
Command Parameters
Parameter | Description | Default |
---|---|---|
InputFile required |
The name of the StateCU time series or report file to read, surrounded by double quotes. | None – must be specified. |
InputStart |
The starting date/time to read, specified to a precision (month or year) that matches the data file. | Read all the data. |
InputEnd |
The ending date/time to read, specified to a precision (month or year) that matches the data file. | Read all the data. |
TSID |
A time series identifier pattern that will be used to filter the list of time series that are read. See the figure above for examples. | Read all time series. |
NewScenario |
A new scenario to use for the TSID. This is useful when reading data from multiple model runs that otherwise would have the same TSIDs. | No scenario. |
AutoAdjust |
Indicate whether to automatically adjust time series identifiers to use a dash - instead of period . in the data type, necessary because StateCU data types (e.g., crop types that include CU method) have a period that interferes with the normal TSID convention. |
True |
CheckData |
Indicate whether to check the data for integrity after reading. Currently only the irrigation practice time series can be checked, to verify that the acreage totals are the sum of the parts. | True |
Examples
See the automated tests.
Troubleshooting
See Also
ReadStateCUB
commandWriteStateCU
command