Skip to content

NovaStar Program Reference / Data Analysis / tstool

Overview

The third-party TSTool (time series tool) program, run with the tstool script, processes time series and other data into useful data products using a workflow command language. The benefits of using TSTool include:

  • it provides extensive time series and data table processing functionality, including ability to process data from various sources and formats
  • data processing can be prototyped outside of the server and then automated as a scheduled process if needed
  • data processing load can be offloaded from the data collection server, for example by implementing workflows on a data node or separate server

The program can be run as a scheduled process on a frequency needed for real-time data collection, and can be run less frequently to perform data analysis and create information products.. TSTool can also be run interactively on Linux or Windows computers and communicates with NovaStar data web services.

TSTool is developed and maintained as open source software by the Open Water Foundation, with the core product being a part of the State of Colorado's Decision Support Systems. TSTool is installed by TriLynx Systems in support of NovaStar systems. See the following for more information:

Configuration

TSTool accesses the NovaStar system via the TSTool NovaStar Data Web Services plugin developed by TriLynx Systems. A datastore is configured to access NovaStar data web services to read data. See the TriLynx Systems Dashboard for more information.

Command Line Usage

See the TriLynx Systems Dashboard for more information.

Examples

The TSTool documentation and automated tests (available from the documentation) contains many examples.

Workflows specific to NovaStar are available on the TriLynx Systems Dashboard, depending on the system implementation.

Administrator Interface

TSTool can be run as a scheduled process using the Administrator scheduler.

It can also be run as a data import and export program.

Troubleshooting

Problems are typically due to data or command workflow issues. Running TSTool interactively will display markers on commands that have issues and messages can be viewed interactively by right-clicking on a command and selecting Show Command Status. Also refer to the log file using the Tools / Diagnostics - View Log File menu.

Log File Location

TSTool creates a default log file in the .tstool/N/log folder (where N is the TSTool major version) under the user account that is running the program.

Other log files are typically created in the working folder for a process by using the TSTool StartLog command.

If TSTool is run as a scheduled process, the standard output and standard error can be redirected to a log file to provide additional information.

Performance Considerations

The following should be considered to optimize TSTool performance:

  • TSTool is a large Java application and can take several seconds to start up. TSTool's functionality can be used to process multiple products in one workflow. For example, use the TSTool For command to loop over a list of stations read with the WebGet and ReadTableFromDelimitedFile or similar commands.
  • Test performance on a desktop computer before automating server-side processes.
  • TSTool command line parameters are available to enable and disable datastores during a batch run so that only necessary data are read at startup.
  • Make sure that debug level has not been elevated in workflows by checking the log file(s).

See Also