Surface Water Supply Index / TSTool Command Summary

The following TSTool commands are used in the Colorado SWSI Automation Tool. The latest documentation for each command can be accessed using the links below.

TSTool Commands Used in the SWSI Analysis Workflows (alphabetized)

TSTool Command	Description
Add	Add one or more time series to a time series.
AddConstant	Add a constant or monthly constants to one or more time series.
AdjustExtremes	Adjust the extreme values in a time series while conserving mass, for example to adjust for negative streamflow.
AnalyzePattern	Analyze time series for wet/average/dry conditions.
AppendTable	Append a table to another table.
CalculateTimeSeriesStatistic	Calculate a single statistic for time series.
ChangeInterval	Change the interval for time series to create new interval time series.
ChangePeriod	Change the period of time series, for example to extend and fill.
CheckTimeSeries	Check time series values for specific criteria and output to a table and warnings.
CheckTimeSeriesStatistic	Calculate a time series statistic and then check the statistic against criteria.
CloseExcelWorkbook	Close an Excel workbook that is being written to.
Comment	A single line #-comment to provide explanatory information.
CommentBlockEnd	Multi-line */ comment block end.
CommentBlockStart	Single line /* comment block start.
ConvertDataUnits	Convert time series data units.
Copy	Create new time series by copying a time series.
CopyFile	Create a new file by copying a file.
CopyPropertiesToTable	Copy processor properties to a table.
CopyTable	Create a new table by copying a table, with options to copy specific columns, rename columns, and filter rows.
CopyTimeSeriesPropertiesToTable	Copy time series properties to a table.
DeselectTimeSeries	Deselect time series, used to create lists of time series used with TSList=SelectedTS command parameter.
Disaggregate	Disaggregate time series from longer interval to shorter interval data.
Divide	Divide time series by another time series.
Empty	Blank command line.
EndFor	End of For command block.
EndIf	End of If command block.
Exit	Exit processing, useful when testing a partial command file.
ExpandTemplateFile	Expand a FreeMarker syntax template text file into an expanded file, useful for repeating common processing.
FillConstant	Fill missing data in time series with a constant value.
FillFromTS	Fill missing data using values in a time series from another time series' data values.
FillHistMonthAverage	Fill missing data in monthly time series using the monthly averages from the same time series.
FillHistYearAverage	Fill missing data in yearly time series using the yearly averages from the same time series.
FillInterpolate	Fill missing data in time series by interpolating between non-missing values.
FillPattern	Fill missing data in time series by using wet/average/dry values for the same time series.
FillRegression	Fill missing data in time series using ordinary least squares regression.
FillRepeat	Fill missing data in time series by repeating values forward or backward.
For	For-loop start.
FormatDateTimeProperty	Format date/time property into a new processor string property given a format specifier, useful when a specific string version of date/time is needed.
FormatStringProperty	Format a new string processor property given other properties as input.
FormatTableDateTime	Format a date/time column in a table, for example to output a specific date/time format for output.
FormatTableString	Format a table string column using other table columns as input.
Free	Free a time series - it will no longer be available for further processing, useful when using temporary time series for processing.
FreeTable	Free a table - it will no longer be available for further processing, useful when using temporary tables for processing.
If	If block start.
InsertTableColumn	Insert a column into a table.
InsertTableRow	Insert a row into a table.
JoinTables	Join tables horizontally using one or more common columns.
ListFiles	List files in a folder.
LookupTimeSeriesFromTable	Create a new time series by looking up time series values from a table.
ManipulateTableString	Manipulate a table string in a table - see also FormatTableString() command.
Message	Generate a message for logging and user.
Multiply	Multiply one time series by another.
NewEndOfMonthTSFromDayTS	Create a new end of month time series from a daily time series, useful for determining reservoir end or month time series.
NewExcelWorkbook	Create a new Excel workbook that can be written to by other commands.
NewPatternTimeSeries	Create a new time series filled with an initial pattern of values and flags, useful for automated testing.
NewStatisticTimeSeries	Create a new time series containing a statistic of all similar date/times, for example average of all January 1 daily values.
NewStatisticYearTS	Create a new Time series containing a statistic of all annual values, useful to create an annual time series to compare to other time series.
NewTable	Create a new empty table.
NewTimeSeries	Create a new time series to receive results from other commands.
ProcessTSProduct	Process a time series product into views and image files.
ReadDateValue	Read time series from a "DateValue" format file, one of the primary formats used by TSTool.
ReadDelimitedFile	Read time series from a delimited file, for example a comma-separated-value (CSV) file.
ReadHydroBase	Read time series from the State of Colorado's HydroBase database.
ReadNrcsAwdb	Read time series from Natural Resources Conservation Service (NRCS) Air and Water Database web services.
ReadPatternFile	Read time series from wet/average/dry pattern file produced by AnalyzePattern() command.
ReadPropertiesFromExcel	Read processor properties from an Excel worksheet.
ReadPropertiesFromFile	Read processor properties from a text file.
ReadStateMod	Read time series from the State of Colorado's StateMod water allocation model text input files.
ReadTableCellsFromExcel	Read table cells from specific cells in an Excel worksheet, useful for transferring form input into a flat data table.
ReadTableFromDataStore	Read a table from a database datastore.
ReadTableFromExcel	Read a table from an Excel worksheet.
ReadTimeSeriesFromDataStore	Read time series from a datastore.
ReadTimeSeriesList	Read time series using a table with list of identifiers.
RemoveFile	Remove a file.
ReplaceValue	Replace values in a time series with alternate values.
RunCommands	Run a command file, used to create master command files to run larger workflows.
RunningStatisticTimeSeries	Create a running statistic time series using various methods to determine the sample size.
Scale	Scale time series by a constant value.
SelectTimeSeries	Select time series for processing, used with the TSList=SelectedTS parameter.
SetConstant	Set time series data values to a constant.
SetFromTS	Set time series data values using values from another time series.
SetInputPeriod	Set the global input period default when reading time series, useful for datastores that have an inconvenient default input period.
SetOutputPeriod	Set the global output period default when writing time series, useful to standardize all output to a consistent period.
SetOutputYearType	Set the global output year type (e.g., calendar, water year).
SetProperty	Set a processor property.
SetPropertyFromTable	Set a processor property from a table.
SetTableValues	Set table values based on filters.
SetTimeSeriesPropertiesFromTable	Set time series properties from a table, useful to cross-reference data from different data sources.
SetTimeSeriesProperty	Set a single time series property.
SetTimeSeriesValuesFromLookupTable	Set time series values from a lookup table, for example to set values based on a distribution.
SetTimeSeriesValuesFromTable	Set time series values from a table, similar to other commands that set time series values.
SetWorkingDir	Set the working directory for processing - generally not used given newer features to access processor ${WorkingDir} property.
ShiftTimeByInterval	Shift time series values by an interval, useful to handle time zone changes, routing, and use of previous timestep(s) as input.
SortTable	Sort a table based on one or more columns.
SortTimeSeries	Sort a list of time series based on identifier or other time series properties.
StartLog	Start a new log file for logging.
Subtract	Subtract time series from another time series.
TableMath	Calculate table column values using input table column(s) and/or constant values.
TableTimeSeriesMath	Manipulate time series values using data from a table.
TableToTimeSeries	Create new time series using values from a table.
TimeSeriesToTable	Create a table using values from time series.
WriteDateValue	Write time series to a DateValue format file.
WriteDelimitedFile	Write time series to a delimited (e.g., CSV) file.
WritePropertiesToFile	Write processor properties to a text file.
WriteTableCellsToExcel	Write table cells to cells in an Excel worksheet, useful for transferring "flat" table data into Excel forms.
WriteTableToDataStore	Write a table to a database datastore.
WriteTableToDelimitedFile	Write a table to a delimited (e.g., CSV) file.
WriteTableToExcel	Write a table to an Excel worksheet.
WriteTableToHTML	Write a table to an HTML file.
WriteTimeSeriesPropertiesToFile	Write time series properties to a file, useful for automated tests.
WriteTimeSeriesProperty	Write time series property to a file, replaced by WriteTimeSeriesProperiesToFile.
WriteTimeSeriesToDataStore	Write time series to a database datastore, useful for generic database designs.
WriteTimeSeriesToExcel	Write time series to an Excel worksheet, with formatting based on data values.