TSTool-QuickStart

• Title: TSTool Quick Start Guide
• Description: This document will help you download, install, and run TSTool software using simple examples, and will point out other resources that are available for more in-depth learning.
• Decision Support - Doc Type: Software Documentation
• Date: 5/21/2014
• DSS Category: DMI Utilities
• Prepared By: Open Water Foundation

TSTool Documentation
Quick Start - 8
A note at the top of the dialog explains that the SetInputPeriod() command can be used to set the
period for reading. If the input period is not specified, the period will default to all available data, or in
some cases the recent period (depending on datastore conventions).

After pressing OK to save the edits to the command, press Run All Commands in the main TSTool
window to process the commands again. The time series listed in the results area will then show the alias
for the time series. This alias is displayed in choices when other commands are edited. The following
figures show the results prior to and after defining the alias. The time series description and TSID are
always shown and the alias will be prepended to the information if it is defined.

To enter comments in the command file, select a command (it will be highlighted) and then select the
Commands… General – Comments… # comment(s) menu item. Edit the comment and press OK.
The comment will be inserted before the command that was selected. It is good practice to insert
comments to document processing logic.

Use the File…Save… Commands As menu to save the command file. For example, save as example2-
UsingCommands.TSTool. The command file can then be reloaded in the future with File… Open…
Command File so that the commands can be re-run. Opening or saving a command file results in
TSTool’s working directory (folder) being set to that of the command file. The default working directory
is the TSTool software install location. However, in most cases, TSTool command files and related input
and output files should be saved where other project or analysis files are saved. It generally is desirable to
specify the file locations with respect to the working directory rather than absolute paths so that files can
be shared with other computer users.