TSTool – Time Series Tool – Command Reference Version 10.21.00, 2013-04-21 1 This page is intentionally blank. This document is formatted for double-sided printing. 2 Table of Contents TSTool 1 – Time Series Tool – 1 Blank Page 16 TSTool Syntax Guide 17 Commands – Basic Syntax 17 Commands – Referring to Parameters 17 Commands – Comments 18 Commands – Time Series Identifiers 18 Processor – Properties 18 Time Series – Properties 19 Time Series – Data Flags 19 Date/Time 20 Regular Expression – Notation 21 Template – Syntax 21 Configuration File – TSTool Configuration File 21 Configuration File – Datastore Properties 21 Configuration File – Time Series Product Files 22 3 Table of Contents Command Glossary 23 Command Reference: # 33 Command Reference: /* 35 Command Reference: */ 37 Command Reference: Time Series Identifier (TSID) 39 Command Reference: Add() 41 Command Reference: AddConstant() 43 Command Reference: AdjustExtremes() 45 Command Reference: AnalyzePattern() 47 Command Reference: AnalyzeNetworkPointFlow() 51 Command Reference: AppendFile() 63 Command Reference: AppendTable() 65 Command Reference: ARMA() 67 Command Reference: Blend() 73 Command Reference: CalculateTimeSeriesStatistic() 75 Command Reference: ChangeInterval() 81 Irregular Time Series to Regular Time Series 81 4 Table of Contents Regular Time Series to Regular Time Series 83 ACCM (Accumulation) to ACCM (Accumulation) 83 ACCM (Accumulation) to INST (Instantaneous) 84 ACCM (Accumulation) to MEAN 84 INST (Instantaneous) to INST (Instantaneous) 85 INST (Instantaneous) to ACCM (Accumulation) 86 INST (Instantaneous) to MEAN 86 MEAN to MEAN 88 MEAN to ACCM (Accumulation) 88 MEAN to INST (Instantaneous) 88 Command Reference: ChangePeriod() 97 60_Command_CheckTimeSeries.pdf 99 Command Reference: CheckTimeSeriesStatistic() 103 60_Command_CompareFiles.pdf 107 60_Command_CompareTables.pdf 109 Command Reference: CompareTimeSeries() 111 Command Reference: ComputeErrorTimeSeries() 115 5 Table of Contents Command Reference: ConvertDataUnits() 117 Command Reference: Copy() 119 Command Reference: CopyEnsemble() 121 Command Reference: CopyTable() 123 Command Reference: CreateEnsembleFromOneTimeSeries() 125 Command Reference: CreateFromList() 129 Command Reference: CreateRegressionTestCommandFile() 133 Command Reference: Cumulate() 137 Command Reference: Delta() 141 Command Reference: DeselectTimeSeries() 145 Command Reference: Disaggregate() 147 Command Reference: Divide() 151 Command Reference: Exit() 153 Command Reference: ExpandTemplateFile() 155 Example Using Simple Variable Assignment 157 Example of Passing Time Series Processor Properties to Templates 157 Example of Protecting TSTool Properties in Template with a Literal FreeMarker String 157 6 Table of Contents Example of Using a Comment in the Template, which is Omitted from Expanded Output 158 Example Using Variable Assignment and Loop Using List 158 Example Using a One-Column Table for a List for Looping 159 Example Using a Multiple-Column Table to Loop Through Two Lists 160 Example of Expanding a Template to a Processor Property 161 Example of Using ExpandTemplateFile() in a Loop to Expand Multiple Files 161 Command Reference: FillConstant() 167 Command Reference: FillDayTSFrom2MonthTSAnd1DayTS() 169 60_Command_FillFromTS.pdf 173 Command Reference: FillHistMonthAverage() 175 Command Reference: FillHistYearAverage() 177 Command Reference: FillInterpolate() 179 Command Reference: FillMixedStation() 181 Implementation in Colorado’s Decision Support Systems 182 Command Reference: fillMOVE1() 187 Command Reference: FillMOVE2() 189 Command Reference: FillPattern() 193 7 Table of Contents 60_Command_FillPrincipalComponentAnalysis.pdf 195 Command Reference: FillProrate() 197 Command Reference: FillRegression() 201 Command Reference: FillRepeat() 211 Command Reference: FillUsingDiversionComments() 213 Diversion Comment Not Used Flag 213 Structure Currently in Use Flag 213 Command Reference: FormatDateTimeProperty() 219 Command Reference: FormatTableString() 221 Command Reference: Free() 223 Command Reference: FreeTable() 225 60_Command_FTPGet.pdf 227 Command Reference: InsertTimeSeriesIntoEnsemble () 229 Command Reference: LagK() 231 60_Command_LookupTimeSeriesFromTable.pdf 235 Command Reference: ManipulateTableString() 239 Command Reference: Multiply() 241 8 Table of Contents Command Reference: NewDayTSFromMonthAndDayTS() 243 Command Reference: NewEndOfMonthTSFromDayTS() 247 Command Reference: NewEnsemble () 251 Examples 254 Command Reference: NewStatisticTimeSeries() 255 Examples 257 Command Reference: NewStatisticTimeSeriesFromEnsemble() 259 Examples 262 Command Reference: NewStatisticYearTS() 265 Example 270 Command Reference: NewTable () 271 Command Reference: NewTimeSeries() 273 Command Reference: NewTreeView() 275 Command Reference: Normalize() 277 Command Reference: OpenHydroBase() 279 Command Reference: PrintTextFile() 281 Command Reference: ProcessTSProduct() 285 9 Table of Contents Command Reference: ProfileCommands() 289 Command Reference: ReadDateValue() 293 Command Reference: ReadDelimitedFile() 295 Command Reference: ReadHecDss() 301 Command Reference: ReadHydroBase() 303 Command Reference: ReadMODSIM() 309 Command Reference: ReadNrcsAwdb() 311 Command Reference: ReadPatternFile() 313 Command Reference: ReadPropertiesFromFile() 315 Command Reference: ReadRccAcis() 317 Command Reference: ReadReclamationHDB() 321 60_Command_ReadRiversideDB.pdf 329 Command Reference: ReadRiverWare() 331 Command Reference: ReadStateCU() 333 Command Reference: ReadStateCUB() 335 Command Reference: ReadStateMod() 337 Command Reference: ReadStateModB() 339 10 Table of Contents Command Reference: ReadTableFromDataStore() 341 Command Reference: ReadTableFromDBF() 345 60_Command_ReadTableFromDelimitedFile.pdf 347 Command Reference: ReadTableFromExcel() 351 Command Reference: ReadTimeSeries() 355 Command Reference: ReadTimeSeriesList() 357 Command Reference: ReadUsgsNwisDaily() 361 Command Reference: ReadUsgsNwisGroundwater() 365 Command Reference: ReadUsgsNwisInstantaneous() 369 60_Command_ReadUsgsNwisRdb.pdf 373 Command Reference: ReadWaterML() 375 60_Command_ReadWaterOneFlow.pdf 377 Command Reference: RelativeDiff() 379 Command Reference: RemoveFile() 383 Command Reference: RemoveTableRowsFromDataStore() 385 60_Command_ReplaceValue.pdf 387 Command Reference: ResequenceTimeSeriesData() 391 11 Table of Contents Command Reference: RunCommands() 395 Command Reference: RunDSSUTL() 397 Command Reference: RunningAverage() 401 Command Reference: RunningStatisticTimeSeries() 405 Command Reference: RunProgram() 411 60_Command_RunPython.pdf 415 Command Reference: Scale() 419 Command Reference: SelectTimeSeries() 421 Command Reference: SetAutoExtendPeriod() 423 Command Reference: SetAveragePeriod() 425 Command Reference: SetConstant() 427 Command Reference: SetDataValue() 429 Command Reference: SetDebugLevel() 431 Command Reference: SetFromTS() 433 Command Reference: SetIgnoreLEZero() 437 Command Reference: SetIncludeMissingTS() 439 Command Reference: SetInputPeriod() 441 12 Table of Contents Command Reference: SetOutputPeriod() 443 Command Reference: SetOutputYearType() 445 Command Reference: SetPatternFile() 447 60_Command_SetProperty.pdf 449 Command Reference: SetTimeSeriesPropertiesFromTable() 451 Command Reference: SetTimeSeriesProperty() 453 Command Reference: SetToMax() 455 Command Reference: SetToMin() 457 Command Reference: SetWarningLevel() 459 Command Reference: SetWorkingDir() 461 Command Reference: ShiftTimeByInterval() 463 Command Reference: SortTimeSeries() 465 Command Reference: StartLog() 467 Command Reference: StartRegressionTestResultsReport() 469 Command Reference: StateModMax() 471 Command Reference: Subtract() 473 Command Reference: TableMath() 475 13 Table of Contents 60_Command_TableTimeSeriesMath.pdf 477 Command Reference: TableToTimeSeries() 479 Command Reference: TimeSeriesToTable() 487 Command Reference: VariableLagK() 493 60_Command_WebGet.pdf 499 Command Reference: WeightTraces() 501 Command Reference: WriteCheckFile() 505 60_Command_WriteDateValue.pdf 507 Command Reference: WriteHecDss() 509 Command Reference: WritePropertiesToFile() 513 Command Reference: WriteProperty() 515 Command Reference: WriteReclamationHDB() 517 Command Reference: WriteRiversideDB() 525 Command Reference: WriteRiverWare() 531 Command Reference: WriteStateCU() 533 Command Reference: WriteStateMod() 535 Command Reference: WriteSummary() 537 14 Table of Contents Command Reference: WriteTableToDataStore() 539 60_Command_WriteTableToDelimitedFile.pdf 543 Command Reference: WriteTableToHTML() 545 Command Reference: WriteTimeSeriesProperty() 547 Command Reference: WriteTimeSeriesToDataStore() 549 Command Reference: WriteTimeSeriesToJson() 553 Command Reference: WriteTimeSeriesToKml() 557 60_Command_WriteWaterML.pdf 559 99_TSTool_Spine_CDSS_CommandReference.pdf 561 15 Blank Page This page is intentionally blank. 16 TSTool Syntax Guide Version 10.13.00, 2012-10-23 TSTool commands use a number of syntax (notation) conventions that have been implemented over time in response to functionality requirements. This appendix provides a summary of the syntax as a guide for users and future software development. Syntax standards listed here should be used where possible to ensure consistency in software features. Where appropriate, notation has been selected based on other efforts. For example, date/time formatting is patterned after the C language strftime() function, which has been available for over 30 years. In cases where notation is specific to