TSTool / Command Reference / Overview
This reference section of the documentation provides information about TSTool commands,
listed in groups consistent with the TSTool software menus.
If necessary, use the documentation Search tool or the Find tool for the
web browser to find a specific command or topic.
The commands in the Reference - Commands section in the table of comments
are listed alphabetically with several general commands including
TSID
listed at the top.
- Command Syntax Overview
- Command List - alphabetical list of commands (is at the end of this section)
- Time Series Processing
- Select, Free, Sort Time Series - basic handling of time series objects
- Create Time Series - create new time series
- Read Time Series - read time series from files, databases, and web services
- Fill Time Series Missing Data - fill time series missing data values
- Set Time Series Contents - set time series data values and properties
- Manipulate Time Series - manipulate time series data values
- Analyze Time Series - analyze time series
- Models - Routing - route time series through time
- Output Time Series - output (write) time series to files and databases
- Check Time Series - check time series against criteria
- Topic Area Commands
- Datastore Processing - read/write database data
- Ensemble Processing - process ensembles of time series
- Network Processing - process node/link networks
- Spatial Processing - read/write spatial data
- Spreadsheet Processing - read/write spreadsheet files
- Template Processing - expand template files
- visualization Processing - visualize data
- General Commands
- General - Comments - insert comments
- General - File Handling - manipulate files
- General - Logging and Messaging - handle log files and other messages
- General - Running and Properties - run programs and control logic
- General - Test Processings - automated tests for quality control
- Deprecated Commands - old commands
- Table Commands
- Create, Copy, Free Table - basic table object management
- Read Table - read tables from files, databases, and web services
- Append, Join Tables - append and join tables
- Table, Time Series Processing - translate tables to/from time series
- Manipulate Tables - manipulate table data
- Analyze Table - analyze table data
- Output Table - output (write) tables to files and databases
- Running and Properties - use table data to control logic
- Plugin Commands - commands developed by third parties
Command Syntax Overview
TSTool command files contain a list of commands, one command per line.
These commands are processed in sequence from top to bottom.
For
and If
control commands, if present, will cause execution order to jump over commands.
Each command adheres to the syntax:
CommandName(ParameterName1="ParameterValue1",ParameterName2="ParameterValue2",...)
The following are guidelines for commands:
- Commands always follow the convention of command name at start with a list of named parameters in parentheses. The only exceptions are:
- Commands are generally not case-specific although the TSTool software enforces standards.
- Command and parameter names use mixed case where the first letter of each word is capitalized.
- Parameter values may optionally be surrounded by double quotes, regardless of type. Double quotes are required in some cases to protect spaces and other characters within quotes.
- Each command must exist on a single line.
- Spaces at the front of a command for indentation are currently not allowed. This limitation is planned to be removed in the future. Tabs used for indentation are discouraged and will likely be prohibited because tab width is ambiguous between different users and tools. Spaces will be the preferred method of indentation.
- Empty (blank) lines are allowed and will be handled as
Empty
commands. - Unknown commands are handled as
UnknownCommand
commands.
Time Series Processing
Time series processing commands focus on time series,
although other outputs such as tables and files may result from processing.
Older commands assumed that only time series would be processed and have general names (e.g.,
Copy
),
whereas newer commands recognize that other objects may be processed and have more specific names
(e.g., SelectTimeSeries
).
Select, Free, Sort Time Series
These commands select, free, and sort time series.
SelectTimeSeries
- select output time series for processingDeselectTimeSeries
- deselect output time series for processingFree
- free memory used by time seriesSortTimeSeries
- sort the output time series
Create Time Series
These commands create new time series from other time series or data values.
NewPatternTimeSeries
- create a new time series with repeating pattern for data valuesNewTimeSeries
- create a new time seriesChangeInterval
Copy
- copy a time seriesDelta
- create a new time series from delta between time series valuesDisaggregate
- create a new time series by disaggregating a time seriesLookupTimeSeriesFromTable
- create a time series by looking up data values from a tableNewDayTSFromMonthAndDayTS
- create a new daily time series by distributing a monthly time series using a daily patternNewEndOfMonthTSFromDayTS
- create a new end of month time series from daily time seriesNormalize
- create a new time series by normalizing a time seriesRelativeDiff
- create a new time series as relative difference of two time seriesResequenceTimeSeriesData
- resequence time series data values by yearNewStatisticTimeSeries
- create a new time series having statistic repeated each yearNewStatisticMonthTimeSeries
- create a new time series with monthly statisticsNewStatisticYearTS
- create a new time series of annual statisticsRunningStatisticTimeSeries
- create time series containing statistic from moving "running" sample
Read Time Series
These commands read time series from various sources.
SetIncludeMissingTS
- set the global property to include missing time series in outputSetInputPeriod
- set the global processor input periodCreateFromList
- create time series from a list in a fileReadColoradoHydroBaseRest
- read time series from Colorado HydroBase REST web servicesReadDateValue
- read time series from a DateValue fileReadDelftFewsPiXml
- read time series from Delft FEWS PI XML fileReadDelimitedFile
- read time series from delimited fileReadHecDss
- read time series from HEC-DSS fileReadHydroBase
- read time series from State of Colorado HydroBase databaseReadMODSIM
- read time series from MODSIM model fileReadNrcsAwdb
- read time series from NRCS AWDB web servicesReadNwsCard
ReadNwsrfsEspTraceEnsemble
ReadNwsrfsFS5Files
ReadRccAcis
- read time series from RCC ACIS web serviceReadReclamationHDB
- read time series from Reclamation HDB databaseReadReclamationPisces
- read time series from Reclamation Pisces databaseReadRiverWare
- read time series from RiverWare fileReadStateCU
- read time series from a StateCU fileReadStateCUB
- read time series from a StateCU binary fileReadStateMod
- read time series from a StateMod fileReadStateModB
- read time series from a StateMod binary fileReadTimeSeries
- read a single time series using TSID to determine data sourceReadTimeSeriesFromDataStore
- read time series from a datastoreReadTimeSeriesList
- read time series from a list in a tableReadUsgsNwisDaily
- read daily value time series from USGS NWIS Daily web servicesReadUsgsNwisInstantaneous
- read instantaneous value time series from USGS NWIS Instantaneous web servicesReadUsgsNwisGroundwater
- read groundwater time series from USGS NWIS Daily web servicesReadUsgsNwisRdb
- read time series from a USGS NWS RDB fileReadWaterML
ReadWaterML2
StateModMax
- create time series that are maximum of two StateMod files
Fill Time Series Missing Data
These commands fill missing time series values.
FillConstant
- fill missing time series values with a constantFillDayTSFrom2MonthTSAnd1DayTS
- fill a daily time series by prorating monthly volumes using a daily patternFillFromTS
- fill missing time series values from another time seriesFillHistMonthAverage
- fill missing time series values with historical monthly averageFillHistYearAverage
- fill missing time series values with historical yearly averageFillInterpolate
- fill missing time series values using interpolationFillMixedStation
FillMOVE2
FillPattern
- fill missing time series values using historical pattern averageReadPatternFile
- read pattern time series used byFillPattern
FillProrate
- fill missing time series values by prorating another time seriesFillRegression
FillRepeat
- fill missing time series values by repeating valuesFillUsingDiversionComments
- fill missing time series values using HydroBase diversion commentsSetAutoExtendPeriod
- set global property to auto-extend time series to output periodSetAveragePeriod
- set the global period used to compute historical averagesSetIgnoreLEZero
- set global property to ignore time series values <= 0 in averages
Set Time Series Contents
These commands set time series contents, including properties and data values.
ReplaceValue
- replace values in time series dataSetConstant
- set time series data values to a constantSetDataValue
- set data values in time seriesSetFromTS
- set time series data values from another time seriesSetTimeSeriesValuesFromLookupTable
- set time series values from a lookup tableSetTimeSeriesValuesFromTable
- set time series values from a tableSetToMax
- set time series values to maximum of 1+ time seriesSetToMin
- set time series values to minimum of 1+ time seriesSetTimeSeriesProperty
- set a time series property
Manipulate Time Series
These commands perform basic time series manipulation.
Add
- add time series to time seriesAddConstant
- add a constant to time series valuesAdjustExtremes
- adjust extreme values in time seriesARMA
Blend
- blend one time series into anotherChangePeriod
- change time series data periodChangeTimeZone
- change the time zone for time seriesConvertDataUnits
- convert time series data unitsCumulate
- set time series values to cumulative valuesDivide
- divide one time series by anotherMultiply
- multiply one time series by anotherScale
- scale time series valuesShiftTimeByInterval
- shift time series data values by a time intervalSubtract
- subtract time series from time series
Analyze Time Series
These commands analyze time series.
AnalyzePattern
- analyze pattern of time series dataCalculateTimeSeriesStatistic
CompareTimeSeries
- compare time series to detect whether they are the same or differentComputeErrorTimeSeries
- compute the error between two time series
Models - Routing
These commands route flow time series from one location to another.
LagK
- lag and attenuate flowsVariableLagK
- lag and attenuate flows
Output Time Series
These commands output time series to different formats.
SetOutputPeriod
- set the global processor output periodSetOutputYearType
- set the global processor output year typeWriteDateValue
- write time series to DateValue format fileWriteDelftFewsPiXml
- write time series to Delft FEWS PI XML format fileWriteDelimitedFile
- write time series to a delimited fileWriteHecDss
- write time series to a HEC-DSS fileWriteReclamationHDB
- write time series to Reclamation HDB databaseWriteRiverWare
write time series to a RiverWare fileWriteStateCU
- write time series to a StateCU fileWriteStateMod
- write time series to a StateMod fileWriteSummary
- write time series to a summary report fileWriteTimeSeriesToDataStore
- write time series to a datastoreWriteTimeSeriesToDataStream
- write time series to a stream of data linesWriteTimeSeriesToHydroJSON
- write time series to a HydroJSON file.WriteTimeSeriesToJson
- write time series to a JSON fileWriteWaterML
WriteWaterML2
WriteTimeSeriesPropertiesToFile
- write time series properties to a file
Check Time Series
These commands are used to check time series, for example for quality control.
CheckTimeSeries
- check time series values against criteriaCheckTimeSeriesStatistic
- check time series statistic against criteriaWriteCheckFile
- write command log to file
Topic Area Commands
The following commands are grouped into specific topic areas.
Datastore Processing
These commands handle reading and writing time series and other data from datastores, in particular databases. Utility commands for executing SQL and creating a data dictionary are also provided.
NewDerbyDatabase
- this command is under developmentNewSQLiteDatabase
- create a new SQLite databaseOpenDataStore
- open a datastoreReadTableFromDataStore
- read a table from a datastoreWriteTableToDataStore
- write a table to a datastoreRunSql
- run an SQL statement on a datastoreDeleteDataStoreTableRows
- delete datastore table rowsReadTimeSeriesFromDataStore
- read time series from a datastoreWriteTimeSeriesToDataStore
- write time series to a datastoreCloseDataStore
- close an open datastoreCreateDataStoreDataDictionary
- create a database data dictionary
Ensemble Processing
CreateEnsembleFromOneTimeSeries
- create an ensemble from a time seriesCopyEnsemble
- copy an ensemble to a new ensembleNewEnsemble
- create a new time series ensembleInsertTimeSeriesIntoEnsemble
- insert a time series into an ensembleSetEnsembleProperty
- set an ensemble propertyNewStatisticEnsemble
- create an ensemble of statistic time seriesNewStatisticTimeSeriesFromEnsemble
WeightTraces
- create time series as weighted sum of ensemble traces
Network Processing
AnalyzeNetworkPointFlow
- perform point flow analysis for a networkCreateNetworkFromTable
- create a network from a table
Spatial Processing
WriteTableToGeoJSON
- write a table to a GeoJSON fileWriteTableToShapefile
- write a table to a shapefileWriteTableToKml
- write a table to a KML fileWriteTimeSeriesToGeoJSON
- write time series to a GeoJSON fileWriteTimeSeriesToKml
- write time series to a KML file
Spreadsheet Processing
NewExcelWorkbook
- create a new Excel workbook fileReadExcelWorkbook
- read Excel workbook fileReadTableFromExcel
- read a table from an Excel workbook fileReadTableCellsFromExcel
- read table cells from Excel worksheetReadPropertiesFromExcel
- read processor properties from ExcelSetExcelCell
- set data in an Excel cellSetExcelWorksheetViewProperties
- set Excel worksheet view propertiesWriteTableToExcel
- write a table to an Excel workbook fileWriteTableCellsToExcel
- write table row cells to an Excel worksheetWriteTimeSeriesToExcel
- write time series to an Excel workbookWriteTimeSeriesToExcelBlock
- write time series to an Excel workbook using block formatCloseExcelWorkbook
- close Excel workbook that is open
Template Processing
ExpandTemplateFile
- expand template file into full file
Visualization Processing
ProcessTSProduct
- process (create) time series data productProcessRasterGraph
- process (create) time series raster graphNewTreeView
- create a tree view in the user interface
General Commands
General commands perform tasks that are general in nature, meaning they are not specific to processing time series, tables, or other specific data types.
General - Comments
These commands are used to insert comments into command files.
#
comment - single line comment\*
comment block start - start of multi-line comment block\*
comment block end - end of multi-line comment block
General - File Handling
These commands provide general file handling capabilities.
AppendFile
- append a file to another fileCopyFile
- copy a file to another nameListFiles
- list files in a folderFTPGet
- download a file from an FTP siteWebGet
- download a file from a URLRemoveFile
- remove a fileUnzipFile
- unzip the contents of a zip filePrintTextFile
- print a text file to printer
General - Logging and Messaging
These commands handle run-time configuration of logging and sending messages.
ConfigureLogging
- configure loggingMessage
- output a message to the log fileSetDebugLevel
- set the debug level for loggingSetWarningLevel
- set the warning level for loggingStartLog
- (re)start the log fileSendEmailMessage
- send an email message
General - Running and Properties
These commands provide general capabilities to control running commands, including running programs external to TSTool,
handling processor properties (used with ${Property}
), and control commands such as For
and If
.
ReadPropertiesFromFile
- read processor properties from a fileSetProperty
- set a processor property valueSetPropertyFromEnsemble
- set a processor property from an ensembleSetPropertyFromNwsrfsAppDefault
SetPropertyFromTimeSeries
- set time series property from time series propertyFormatDateTimeProperty
- format a date/time processor propertyFormatStringProperty
- format a string processor propertyWritePropertiesToFile
- write processor properties to a fileRunCommands
- run a TSTool command fileRunProgram
- run a programRunPython
- run a Python a programRunR
- run an R scriptRunDSSUTL
- run HEC-DSS DSSUTL programIf
- test a condition to control logic flowEndIf
- end of anIf
block of commandsFor
- iterate over items in a loopEndFor
- end of aFor
loop block of commandsBreak
- break out of aFor
loop block of commandsContinue
- continue to end of aFor
loop block of commandsExit
- stop processing commandsWait
- wait for a time before continuingSetWorkingDir
- set the working directory (folder) for following commandsProfileCommands
- create summary table with containing performance dataEmpty
- empty (blank) lineUnknownCommand
- unknown command
General - Test Processing
These commands are used to run automated tests, in particular when running the full suite of tests.
WriteTimeSeriesPropertiesToFile
- write time series properties to a fileCompareFiles
- compare files to detect whether they are the same or differentCreateRegressionTestCommandFile
- create a regression test suite command fileStartRegressionTestResultsReport
- start the regression test results report file to record output of testsWriteCommandSummaryToFile
- write summary of command log to a file
Deprecated Commands
"Deprecated" commands are obsolete and have typically been replaced by other commands. These commands are generally quite old and may be removed at some point.
Table Commands
Table commands are used to process tabular data, for example:
- database tables
- Excel worksheets
- delimited and other data files
Tables are converted to an in-memory representation where each column stores a single data type. Tables and time series can be converted back and forth, as needed.
Create, Copy, Free Table
These commands create, copy, and free tables.
NewTable
- create a new tableCopyTable
- copy a table to a new tableFreeTable
- free memory resources for a table
Read Table
These commands read tables from various sources.
ReadTableFromDataStore
- read a table from a datastoreReadTableFromDBF
- read a table from a DBF fileReadTableFromDelimitedFile
- read a table from a delimited fileReadTableFromExcel
- read a table from an Excel workbook fileReadTableFromFixedFormatFile
- read a table from a fixed-format fileReadTableFromJSON
- read a table from a JSON fileReadTableFromXml
- read a table from an XML file
Append, Join Tables
These commands append and join tables.
AppendTable
- append a table to another tableJoinTables
- join two tables
Table, Time Series Processing
These commands convert between tables and time series.
TimeSeriesToTable
- copy a time series to a tableTableToTimeSeries
- create time series from a tableCreateTimeSeriesEventTable
- create an event table associated with time seriesSetTimeSeriesPropertiesFromTable
- set time series properties from table valuesCopyTimeSeriesPropertiesToTable
- copy time series properties to table
Manipulate Tables
These commands manipulate tables.
InsertTableColumn
- insert a column in a tableDeleteTableColumns
- delete columns from a tableDeleteTableRows
- delete rows from a tableFormatTableDateTime
- format a date/time in a tableFormatTableString
- format a string in a tableManipulateTableString
- manipulate a string in a tableSetTableValues
- set values in a tableSplitTableColumn
- split table column into multiple columnsTableMath
- perform simple math on table columnsTableTimeSeriesMath
- perform simple math on a table and time seriesInsertTableRow
- insert a row in a tableSortTable
- sort table contentsSplitTableRow
- split a table row into multiple rows
Analyze Table
These commands analyze tables.
CompareTables
- compare tables to detect whether they are the same or different
Output Table
These commands write tables to various formats.
WriteTableToDataStore
- write a table to a datastoreWriteTableToDelimitedFile
- write a table to a delimited fileWriteTableToExcel
- write a table to an Excel workbook fileWriteTableToHTML
- write a table to an HTML file
Running and Properties
These commands handle table properties, which are used to control run logic.
SetPropertyFromTable
- set a processor property from a tableCopyPropertiesToTable
- command is under development
Plugin Commands
Plugin commands are an experimental TSTool feature, designed to allow commands to be added to TSTool independent of the main TSTool distribution. This will allow third parties to add custom commands to TSTool.
Command List
The following table contains every command and provides summary information that is useful to software users and developers. Columns are as follows:
- Command - command name as link to that command's documentation
- Description - brief description
- Doc - all documentation exists and has been migrated to the online version except for the indicated commands (blank indicates has been migrated)
- Def. to Rel. Path - does command editor default to relative path (this feature has been prototyped but not implemented for all commands)?
Command | Description | Doc | Def. to Rel. Path |
---|---|---|---|
# comment |
Single line comment. | ||
\* comment block start |
Start of multi-line comment block. | ||
\* comment block end |
End of multi-line comment block. | ||
Add |
Add time series to time series. | ||
AddConstant |
Add a constant to time series values. | ||
AdjustExtremes |
Adjust extreme values in time series. | ||
AnalyzeNetworkPointFlow |
Perform point flow analysis for a network. | ||
AnalyzePattern |
Analyze pattern of time series data. | ||
AppendFile |
Append a file to another file. | ||
AppendTable |
Append a table to another table. | ||
ARMA |
Autoregressive moving average. | ||
Blend |
Blend one time series into another. | ||
Break |
Break out of For command loop. |
||
CalculateTimeSeriesStatistic |
Calculate a single-value statistic for a time series. | ||
ChangeInterval |
Change time series interval. | ||
ChangePeriod |
Change time series data period. | ||
ChangeTimeZone |
Change the time zone for time series. | ||
CheckTimeSeries |
Check time series values against criteria. | ||
CheckTimeSeriesStatistic |
Check time series statistic against criteria. | ||
CloseDataStore |
Close an open datastore. | ||
CloseExcelWorkbook |
Close Excel workbook that is open. | ||
CompareFiles |
Compare files to detect whether they are the same or different. | ||
CompareTables |
Compare tables to detect whether they are the same or different. | ||
CompareTimeSeries |
Compare time series to detect whether they are the same or different. | ||
ComputeErrorTimeSeries |
Compute the error between two time series. | ||
ConfigureLogging |
Configure logging. | ||
Continue |
Jump to end of For command loop. |
||
ConvertDataUnits |
Convert time series data units. | ||
Copy |
Copy a time series. | ||
CopyEnsemble |
Copy an ensemble to a new ensemble. | ||
CopyFile |
Copy a file to another name. | ||
CopyPropertiesToTable - documentation does not exist |
Command is under development. | X | |
CopyTable |
Copy a table to a new table. | ||
CopyTimeSeriesPropertiesToTable |
Copy time series properties to a table. | ||
CreateDataStoreDataDictionary |
Create a database data dictionary. | ||
CreateEnsembleFromOneTimeSeries |
Create an ensemble from a time series. | ||
CreateFromList |
Create time series from a list in a file. | ||
CreateNetworkFromTable |
Create a network from a table. | ||
CreateRegressionTestCommandFile |
Create regression test suite command file. | ||
CreateTimeSeriesEventTable |
Create an event table associated with time series. | ||
Cumulate |
Set time series values to cumulative values. | ||
DeleteDataStoreTableRows |
Delete datastore table rows. | ||
DeleteTableColumns |
Delete columns from a table. | ||
DeleteTableRows |
Delete rows from a table. | ||
Delta |
Create a new time series from delta between time series values. | ||
DeselectTimeSeries |
Deselect output time series for processing. | ||
Disaggregate |
Create a new time series by disaggregating a time series. | ||
Divide |
Divide one time series by another. | ||
Empty |
Empty (blank) commands line. | ||
EndFor |
End of For loop. | ||
EndIf |
End of If loop. | ||
Exit |
Stop processing commands. | ||
ExpandTemplateFile |
Expand template file into full file. | ||
FillCarryForward |
Replaced by FillRepeat . |
||
FillConstant |
Fill missing time series values with a constant. | ||
FillDayTSFrom2MonthTSAnd1DayTS |
Fill a daily time series by prorating monthly volumes using a daily pattern. | ||
FillFromTS |
Fill missing time series values from another time series. | ||
FillHistMonthAverage |
Fill missing time series values with historical monthly average. | ||
FillHistYearAverage |
Fill missing time series values with historical yearly average. | ||
FillInterpolate |
Fill missing time series values using interpolation. | ||
FillMixedStation |
Fill missing time series values using mixed station approach. | ||
FillMOVE1 |
Fill missing time series values using MOVE.1. | ||
FillMOVE2 |
Fill missing time series values using MOVE.2. | ||
FillPattern |
Fill missing time series values using historical pattern average. | ||
FillPrincipalComponentAnalysis |
Fill missing time series using Principal Component Analysis. | ||
FillProrate |
Fill missing time series values by prorating another time series. | ||
FillRegression |
Fill missing time series values using regression. | ||
FillRepeat |
Fill missing time series values by repeating values. | ||
FillUsingDiversionComments |
Fill missing time series values using HydroBase diversion comments. | ||
For |
Iterate over items in a loop. | ||
FormatDateTimeProperty |
Format a date/time processor property. | ||
FormatStringProperty |
Format string processor property. | ||
FormatTableDateTime |
Format a date/time in a table. | ||
FormatTableString |
Format a string in a table. | ||
Free |
Free memory used by time series. | ||
FreeTable |
Free memory resources for a table. | ||
FTPGet |
Download a file from an FTP site. | ||
If |
Test a condition to control logic flow. | ||
InsertTableColumn |
Insert a column in a table. | ||
InsertTableRow |
Insert a row in a table. | ||
InsertTimeSeriesIntoEnsemble |
Insert a time series into an ensemble. | ||
JoinTables |
Join two tables. | ||
LagK |
Lag and attenuate flows. | ||
ListFiles |
List files in a folder. | ||
LookupTimeSeriesFromTable |
Create a time series by looking up data values from a table. | ||
ManipulateTableString |
Manipulate a string in a table. | ||
Message |
Output a message to the log file. | ||
Multiply |
Multiply one time series by another. | ||
NewDayTSFromMonthAndDayTS |
Create a new daily time series by distributing a monthly time series using a daily pattern. | ||
NewDerbyDatabase - command is being developed |
X | ||
NewSQLiteDatabase |
Create a new SQLite database. | ||
NewEndOfMonthTSFromDayTS |
Create a new end of month time series from daily time series. | ||
NewEnsemble |
Create a new time series ensemble. | ||
NewExcelWorkbook |
Create a new Excel workbook file. | ||
NewPatternTimeSeries |
Create a new time series with repeating pattern for data values. | ||
NewStatisticMonthTimeSeries |
Create a new time series with monthly statistics. | ||
NewStatisticEnsemble |
Create an ensemble of static time series. | ||
NewStatisticTimeSeries |
Create a new time series having statistic repeated each year. | ||
NewStatisticTimeSeriesFromEnsemble |
Create a new time series computed as statistic from an ensemble. | ||
NewStatisticYearTS |
Create a new time series of annual statistics. | ||
NewTable |
Create a new table. | ||
NewTimeSeries |
Create a new time series. | ||
NewTreeView |
Create a tree view in the user interface. | ||
Normalize |
Create new time series by normalizing a time series. | ||
OpenCheckFile - command is not enabled |
Open a check file for error handling. | X | |
OpenDataStore |
Open a datastore. | ||
OpenHydroBase |
Open a HydroBase database connection. | ||
PrintTextFile |
Print text file to a printer. | ||
ProcessRasterGraph |
Process (create) time series raster graph. | ||
ProcessTSProduct |
Process (create) time series data product. | ||
ProfileCommands |
Create summary table with containing performance data | ||
ReadColoradoHydroBaseRest |
Read time series from State of Colorado HydroBase REST web services | ||
ReadDateValue |
Read time series from a DateValue file. | ||
ReadDelftFewsPiXml |
Read time series from Delft FEWS PI XML file. | ||
ReadDelimitedFile |
Read time series from delimited file. | ||
ReadExcelWorkbook |
Read Excel workbook file. | ||
ReadHecDss |
Read time series from HEC-DSS file | ||
ReadHydroBase |
Read time series from State of Colorado HydroBase database | ||
ReadMODSIM |
Read time series from MODSIM model file. | ||
ReadNrcsAwdb |
Read time series from NRCS AWDB web services | ||
ReadNwsCard |
Read time series from NWS Card file | ||
ReadNwsrfsEspTraceEnsemble |
Read time series from NWSRFS ESP trace ensemble file | ||
ReadNwsrfsFS5Files |
Read time series from NWSRFS FS5 Files | ||
ReadPatternFile |
Read time series used by ReadPatternFile |
||
ReadPropertiesFromExcel |
Read processor properties from Excel. | ||
ReadPropertiesFromFile |
Read processor properties from a file. | ||
ReadRccAcis |
Read time series from RCC ACIS web service. | ||
ReadReclamationHDB |
Read time series from Reclamation HDB database | ||
ReadReclamationPisces |
Read time series from Reclamation Pisces database | ||
ReadRiverWare |
Read time series from RiverWare file | ||
ReadStateCU |
Read time series from a StateCU file. | ||
ReadStateCUB |
Read time series from a StateCU binary file. | ||
ReadStateMod |
Read time series from a StateMod file. | ||
ReadStateModB |
Read time series from a StateMod binary file. | ||
ReadTableCellsFromExcel |
Read table cells from Excel worksheet. | ||
ReadTableFromDataStore |
Read a table from a datastore. | ||
ReadTableFromDBF |
Read a table from a DBF file. | ||
ReadTableFromDelimitedFile |
Read a table from a delimited file. | ||
ReadTableFromExcel |
Read a table from an Excel workbook file. | ||
ReadTableFromFixedFormatFile |
Read a table from a fixed-format file. | ||
ReadTableFromJSON |
Read a table from a JSON file. | ||
ReadTableFromXml |
Read a table from an XML file. | ||
ReadTimeSeries |
Read a single time series using TSID to determine data source. | ||
ReadTimeSeriesFromDataStore |
Read time series from a datastore. | ||
ReadTimeSeriesList |
Read time series from a list in a table. | ||
ReadUsgsNwisDaily |
Read daily value time series from USGS NWIS Daily web services | ||
ReadUsgsNwisGroundwater |
Read groundwater time series from USGS NWIS Groundwater web services | ||
ReadUsgsNwisInstantaneous |
Read instantaneous value time series from USGS NWIS Instantaneous web services | ||
ReadWaterML |
Read time series from WaterML (1) file. | ||
ReadWaterML2 |
Read time series from WaterML 2 file. | ||
ReadWaterOneFlow |
Read time series from WaterOneFlow web service. | ||
ReadUsgsNwisRdb |
Read time series from a USGS NWS RDB file | ||
RelativeDiff |
Create a new time series as relative difference of two time series. | ||
RemoveFile |
Remove a file. | ||
ReplaceValue |
Replace values in time series data. | ||
ResequenceTimeSeriesData |
Resequence time series data values by year. | ||
RunCommands |
Run a TSTool command file. | ||
RunDSSUTL |
Run HEC-DSS DSSUTL program. | ||
RunningAverage |
Replaced by RunningStatisticTimeSeries |
||
RunningStatisticTimeSeries |
Create time series containing statistic from moving "running" sample. | ||
RunProgram |
Run a program. | ||
RunPython |
Run a Python program. | ||
RunR |
Run an R script. | ||
RunSql |
Run an SQL statement on a datastore. | ||
Scale |
Scale time series values. | ||
SelectTimeSeries |
Select output time series for processing. | ||
SendEmailMessage |
Send an email message. | ||
SetAutoExtendPeriod |
Set global property to auto-extend time series to output period. | ||
SetAveragePeriod |
Set the global period used to compute historical averages. | ||
SetConstant |
Set time series data values to a constant. | ||
SetConstantBefore |
Replaced by SetConstant |
||
SetDataValue |
Set data values in time series. | ||
SetDebugLevel |
Set the debug level for logging. | ||
SetEnsembleProperty |
Set an ensemble property. | ||
SetExcelCell |
Set data in an Excel cell. | ||
SetExcelWorksheetViewProperties |
Set Excel worksheet view properties. | ||
SetFromTS |
Set time series data values from another time series. | ||
SetIgnoreLEZero |
Set global property to ignore time series values <=0 in averages. | ||
SetIncludeMissingTS |
Set the global property to include missing time series in output. | ||
SetInputPeriod |
Set the global processor input period. | ||
SetOutputPeriod |
Set the global processor output period. | ||
SetOutputYearType |
Set the global processor output year type. | ||
SetPatternFile |
Replaced by ReadPatternFile command |
||
SetProperty |
Set processor property value. | ||
SetPropertyFromNwsrfsAppDefault - being phased out |
X | ||
SetPropertyFromEnsemble |
Set processor property from ensemble. | ||
SetPropertyFromTable |
Set processor property from a table. | ||
SetPropertyFromTimeSeries |
Set processor property from time series property. | ||
SetTableValues |
Set values in a table. | ||
SetTimeSeriesPropertiesFromTable |
Set time series properties from table values. | ||
SetTimeSeriesProperty |
Set a time series property. | ||
SetTimeSeriesValuesFromLookupTable |
Set time series values from a lookup table. | ||
SetTimeSeriesValuesFromTable |
Set time series values from a table. | ||
SetToMax |
Set time series values to maximum of 1+ time series. | ||
SetToMin |
Set time series values to minimum of 1+ time series. | ||
SetWarningLevel |
Set the warning level for logging. | ||
SetWorkingDir |
Set the working directory (folder) for following commands. | ||
ShiftTimeByInterval |
Shift time series data values by a time interval. | ||
SortTable |
Sort table contents. | ||
SortTimeSeries |
Sort the output time series. | ||
SplitTableColumn |
Split a table column into multiple columns. | ||
SplitTableRow |
Split a table row into multiple rows. | ||
StartLog |
(Re)start the log file. | ||
StartRegressionTestResultsReport |
Start the regression test results report file to record output of tests. | ||
StateModMax |
Create time series that are maximum of two StateMod files. | ||
Subtract |
Subtract time series from time series. | ||
TableMath |
Perform simple math on table columns. | ||
TableTimeSeriesMath |
Perform simple math on a table and time series. | ||
TableToTimeSeries |
Create time series from a table. | ||
TimeSeriesToTable |
Copy time series to a table. | ||
TSID |
Time series identifier (TSID), causes time series to be read. | ||
UnknownCommand |
Unknown command. | ||
UnzipFile |
Unzip the contents of a zip file. | ||
VariableLagK |
Lag and attenuate flows. | ||
Wait |
Wait for at time before continuing. | ||
WebGet |
Download a file from a URL. | ||
WeightTraces |
Create time series as weighted sum of ensemble traces. | ||
WriteCheckFile |
Write command log to file. | ||
WriteCommandSummaryToFile |
Write summary of command log to a file. | ||
WriteDateValue |
Write time series to DateValue format file. | ||
WriteDelftFewsPiXml |
Write time series to a Delft FEWS PI XML file. | ||
WriteDelimitedFile |
Write time series from delimited file. | ||
WriteHecDss |
Write time series to a HEC-DSS file. | ||
WriteNwsCard |
Write time series to a NWS Card file. | ||
WriteNwsrfsEspTraceEnsemble |
Write time series ensemble to NWSRFS ESP trace ensemble file. | ||
WritePropertiesToFile |
Write processor properties to a file. | ||
WriteReclamationHDB |
Write time series to Reclamation HDB database | ||
WriteRiverWare |
Write time series to a RiverWare file. | ||
WriteSHEF |
Write time series to SHEF file. | ||
WriteStateCU |
Write time series to a StateCU file. | ||
WriteStateMod |
Write time series to a StateMod file. | ||
WriteSummary |
Write time series to a summary report file. | ||
WriteTableCellsToExcel |
Write table row cells to an Excel worksheet. | ||
WriteTableToDataStore |
Write a table to a datastore. | ||
WriteTableToDelimitedFile |
Write a table to delimited file. | ||
WriteTableToExcel |
Write a table to an Excel workbook file. | ||
WriteTableToGeoJSON |
Write a table to a GeoJSON file. | ||
WriteTableToHTML |
Write a table to an HTML file. | ||
WriteTableToKml |
Write a table to a KML file. | ||
WriteTableToShapefile |
Write a table to a shapefile. | ||
WriteTimeSeriesPropertiesToFile |
Write time series properties to a file. | ||
WriteTimeSeriesToDataStore |
Write time series to a datastore. | ||
WriteTimeSeriesToDataStream |
Write time series to a stream of data lines. | ||
WriteTimeSeriesToExcel |
Write time series to an Excel workbook. | ||
WriteTimeSeriesToExcelBlock |
Write time series to an Excel workbook using block format. | ||
WriteTimeSeriesToGeoJSON |
Write time series to a GeoJSON file. | ||
WriteTimeSeriesToHydroJSON |
Write time series to a HydroJSON file. | ||
WriteTimeSeriesToJson |
Write time series to a JSON file. | ||
WriteTimeSeriesToKml |
Write time series to a KML file. | ||
WriteWaterML |
Write time series to WaterML 1 file. | ||
WriteWaterML2 |
Write time series to WaterML 2 file |