TSTool / Release Notes
This appendix provides information about changes that have occurred in TSTool. A summary table is provided, with links to details for major versions.
- TSTool Version Numbering Convention
- TSTool Issue Icons
- TSTool Version History
- Known Limitations
- TSTool Version Details - the following are separate documentation pages
TSTool Version Numbering Convention
TSTool versioning generally adheres to the following pattern. The version may be incremented in source code but does not become official until a public software release is made.
Majoris a number indicating a major change to the software
Minoris a number indicating a minor change to the software
Maintenanceis a number indicating a maintenance release, for example to fix a bug with no new features
- The version may also be followed by another indicator such as "beta" to indicate a beta release
- Numbers have traditionally been two digits and zero-padded; however, the zero-padding convention may be abandoned moving forward given that the major version does not require it to sort the version.
This convention is not always strictly followed but more attention to this standard is now occurring.
The above version string is used in the software as follows, where
Version is the version as noted above:
- installation folder on Windows is
- Windows Start menu is Start / CDSS / TSTool-Version
- Windows install file is
TSTool Issue Icons
The following icons are used to indicate the type of issue in release notes.
- Known Limitation – A known limitation has been documented and may impact the user. The limitation will be addressed in a future release.
- Bug Fix – A bug has been fixed. Users should evaluate whether their work is impacted. Sometimes bug fixes impact internal code and changes may not be very visible to users.
- Remove – A feature has been removed, generally because functionality has been migrated to other code or the functionality is no longer needed (e.g., a database is no longer available).
- Update/Change – An existing feature has been changed or enhanced. Backward compatibility is usually retained. Modifications to an existing command are considered a change.
- New Feature – A new feature has been added, such as a new command. New features may or may not be obvious to users but will generally be visible in menus.
TSTool Version History
The following table summarizes the TSTool release history. See the TSTool Version Details links above for more detailed information about each version. Only recent versions are documented in detail. Comments for minor versions may be listed under a version that is publicly released. Release note items are categorized as follows, and release note items for a version are typically listed in the same order as shown to emphasize impacts on software users.
TSTool Version History Summary (most current at top)
TSTool Version History Summary (most current at top)
|TSTool Version(s)||Summary of Major Changes in Version||Release Date|
|13.02.00||Improve table processing commands, clarify HydroBase read commands, improve support for stored procedures with parameters.||2019-09-10|
|13.01.00||Improve troubleshooting feedback for HydroBase datastore configuration, streamline Linux installer.||2019-08-04|
|13.00.00||First major release with OpenCDSS open source license.||2019-07-12|
|12.07.00||Improve plugin datastore support.||2018-09-19|
|12.06.00||Update all editor dialogs to link to documentation and other editor improvements.||2018-09-14|
|12.05.00||Various enhancements and cleanup based on open source migration, preliminary HydroBase REST web services implementation.||2018-07-03|
|12.04.00||Enhance support for datastore plugins. Add network object. Add initial WaterML 2.0 support.||2017-07-13|
|12.00.00||Update to use Java 8 including using Java 8 language standards. Add new graphing features including y-axis zoom, and graph template feature. Many other minor enhancements.||2017-04-24|
|11.11.00 – 11.13.00||Improve Excel integration, enhance
|11.09.00 – 11.10.01||TSTool configuration files have been added to the user’s home folder in addition to the installation files. Windows are positioned on TSTool screen, handling multiple monitors. Begin prototyping HTML command documentation. Initial version of plugin datastore and plugin command features.||2016-05-02|
|11.08.00 – 11.08.01||Enhancements to write tables and time series to additional spatial formats. Add support for Delft FEWS Pi XML format, which is used by the National Weather Service. Update additional commands to recognize properties as input.||2016-02-14|
|11.07.00 – 11.07.06||Add support for Reclamation Pisces datastore. Add support for writing HydroJSON format. Add preliminary support for writing WaterML. Add support for reading JSON into table.||2015-12-09|
|11.06.00 – 11.06.01||Add
|11.05.00||Add date/time for appropriate statistics in
|11.04.00 – 11.04.03||Add support for
|11.03.00 – 11.03.10||Add support for
|11.02.00 – 11.02.03||Improved Excel integration and automation control for table and properties, add properties and data flag descriptions to DateValue files, add flags and descriptions to more fill/set commands.||2015-05-27|
|11.01.00||ReclamationHDB datastore support enhancements.||2015-03-23|
|11.00.00||Update from Java 6 to 7. Enhancements for Excel integration. Add PostgreSQL database support.||2015-03-16|
|10.30.00 – 10.30.02||Add
|10.29.00||Additional Excel integration and table processing features.||2014-05-19|
|10.28.02||Enable table view for irregular interval time series. Enhance ReclamationHDB query features.||2014-04-19|
|10.27.00||Significant Excel integration improvements, add some utility commands.||2014-03-21|
|10.26.00||Improve NRCS AWDB web service support. Add
|10.25.00||Additional enhancements for ReclamationHDB datastore.||2013-10-15|
|10.24.01||Change ensemble trace identifiers to string to allow more flexibility. Update ReclamationHDB commands to handle ensembles.||2013-09-30|
|10.23.00||Initial work to add features to create time series event table to annotate products. Fix
|10.22.00||Add raster graph and move data visualization commands to new menu, improve generic database datastore read/write functionality.||2013-08-30|
|10.21.00||Add initial network processing command, add additional functionality for processing tables, and a number of maintenance updates.||2013-07-14|
|10.20.00||Enhancements to ReclamationHDB read/write commands. Enable filtering HydroBase diversion coding structures by structure type and WDID.||2013-04-21|
|10.19.00||Enhancements to ReclamationHDB write features.||2013-03-16|
|10.18.00||Add commands to read a table from Excel and write to a datastore.||2013-03-03|
|10.16.00||Minor update to improve processing of well level data and templates.||2013-02-13|
|10.15.00||Minor update in response to feedback on previous release, split documentation into multiple volumes.||2013-01-14|
|10.14.00||Minor update in response to feedback on previous release.||2012-12-18|
|10.13.00||Many enhancements to improve USGS processing, add NRCS AWDB support, add
|10.12.00||Many enhancements to improve HydroBase, USGS, and general datastore processing.||2012-10-01|
|10.11.00||Update to support RCC ACIS version 2.||2012-07-03|
|10.10.00||Add exceedance probability and related statistics to
|10.00.00 – 10.09.00||Migrate all
|9.10.00 – 9.10.03||Add support for Reclamation HDB database, Regional Climate Center RCC ACIS (preliminary), and USGS NWIS (preliminary) as data stores. Add area graphs.||2011-02-18|
|9.09.00 – 9.09.01||Add additional commands for table processing. Improve template integration with processor properties and tables.||2010-10-18|
|9.08.00 – 9.08.01||Support connecting to more than one RiversideDB and introduce the concept of named data stores as an alternative to input type/name. Add
|9.07.00 – 9.07.02||Add HTML summary, improve data flag handling, improve Python integration, initial support for ColoradoWaterHBGuest web service, include training materials, other maintenance.||2010-08-20|
|9.06.00 – 9.06.04||Initial support for ColoradoWaterSMS web service, enhance RiversideDB support, various improvements.||2010-05-25|
|9.05.00 – 9.05.03||Enhancements to support additional time series and ensemble processing, in particular to compute statistics for drought studies.||2009-11-17|
|9.04.00 – 9.04.02||The following features are now at production level:
|9.01.00 – 9.03.06||Add
|9.00.00 – 9.00.05||Update from Java 1.4.2 to Java 1.6, various bug fixes.||2009-02-05|
|8.18.00 – 8.18.02||Initial HEC-DSS support. Improved RiversideDB support.||2008-11-24|
|8.17.01 – 8.17.02||Bug fixes for 8.17.00. See below. New features include File / New to open a new command file and add support for new StateMod 12.29 binary file format.||2008-10-29|
|8.17.00||All commands are updated to the new error handling and named parameter notation. Many other minor changes have been made for consistency. Many minor user-requested enhancements have been implemented. Several minor bugs reported by users have been fixed. The StateCUB (StateCU binary output file) has been enabled.||2008-10-06|
|8.16.00 – 8.16.02||Migrate additional commands to new error-handling and named parameter notation. Add
|8.15.01 – 8.15.03||Fix a number of problems where migration of commands from fixed parameter to named parameter syntax resulted in some old command files not being handled. The command file is also now marked as modified if any commands are automatically updated. Added more error checks, such as in DateValue file reading to help provide better feedback to users.||2008-06-11|
|8.13.00 – 8.14.02||Add commands to set properties, for use by other commands (e.g., to configure file names). Continue updating commands to utilize the new error handling.||2008-02-20|
|8.03.00 – 8.12.06||Update many commands to utilize new error handling and consistently handle the
|8.00.00 – 8.02.00||Update main interface to use new error-handling visualization features. Add several commands to allow TSTool to perform regression tests on itself.||2007-12-03|
|7.04.00||Various updates for HydroBase including adding support for administrative flow station. Allow reading StateMod rights files and handle new StateCU file formats.||2007-06-22|
|7.00.00||Begin distributing software using a new installer. Add CASS livestock data and human population data.||2006-10-31|
|6.19.00||Update to extend period when filling with diversion comments.||2006-05-19|
|6.16.02||Begin adding commands to test data, for alarms.||2006-04-17|
|6.16.01||Time series to map link is enabled. Improve UNC support. Improve startup performance in batch mode.||2006-02-16|
|6.16.00||Begin adding support for NDFD (National Digitial Forecast Database) input type, and maintenance.||2006-01-31|
|6.15.00||Begin adding time series to map link.||2006-01-16|
|6.14.00||Update some commands to named parameter notation, and maintenance.||2005-12-14|
|6.12.00||Improve error handling when running in batch mode with graphs.||2005-10-05|
|6.11.00||Enable the ColoradoSMS input type for hydrograph annotations and update batch mode features to better utilize the CDSS configuration file.||2005-10-05|
|6.10.09||Maintenance release – convert some commands to use named parameters.||2005-09-28|
|6.10.08||Maintenance release – convert some commands to use named parameters. Add the
|6.10.07||Maintenance release – convert some commands to use named parameters.||2005-08-24|
|6.10.06||Release corresponding to the CDSS CD release.||2005-08-04|
|6.10.05||Respond to CDSS testing feedback.||2005-08-01|
|6.10.04||Respond to CDSS testing feedback. Add additional query filters for HydroBase stations and structures.||2005-07-20|
|6.10.03 BETA||Begin phasing in saving time series products to HydroBase and
|6.10.02 BETA||Update the
|6.10.01 BETA||Begin enabling data flags for time series to support enhancements to fill commands.||2005-06-03|
|6.10.00 BETA||Initial release supporting HydroBase stored procedures with initial prototypes of Mixed Station Analysis and related features. Implement new message log viewer and commands to simplify comparison of time series.||2005-06-01|
|6.09.01||Add NWSRFS FS5Files input type.||2004-09-01|
|6.08.02||Documentation made current to include all version 6 changes.||2004-07-27|
|6.08.01||Allow HydroBase connection to be made at startup.||2004-07-20|
|6.08.00||Allow wildcards in commands that read from StateCU and StateModB input types.||2004-07-11|
|Initial Java version.||1997-10-23|
- TSTool uses a “discovery mode” to partially execute commands when editing the commands. This is used to determine lists of time series identifiers, table identifiers, and properties for editor choices. However, some workflow logic is so complex that commands cannot fully execute in discovery mode. Consequently, warnings may result when loading a command file or some editor choices may be incomplete. When this is known to be an issue, the command editors provide a text field rather than a choice. These complexities will be improved over time as additional resources are devoted to solving design limitations.
- When saving time series product (
*.tsp) files, the absolute path is saved with each file. This is not as portable as saving a path relative to the command file. It may be necessary to edit the product file manually to change file paths from absolute to relative – the relative path will then be converted to absolute when processed and time series files will be found, assuming that the locations are consistent.
ReadStateCUBcommand, unlike other read commands, does not provide a discovery mode. Consequently, other commands will not be provided with a list of time series identifiers for the binary file. The reason for this is that StateMod and StateCU binary files can contain a huge number of time series and providing a list could be overwhelming and slow. Alternatives are being evaluated. Currently, commands that reference time series in the binary files must use more generic selection methods such as
- Plotting features do not know understand the concept of instantaneous, mean, and accumulated time series (referred to as the time scale). All values are plotted at data value date/time. In the future, features may be implemented to automatically determine from the data type and time scale whether to adjust the visual representation based on the time scale, for example to use a “carry forward” line instead of connecting points.
- Using the
SetWorkingDircommand may result in warnings after commands are edited. This is due to the initial checks on filenames not fully recognizing the impacts of previous
SetWorkingDircommands. It is recommended that the
SetWorkingDircommand be avoided and that paths be specified relative to the command file.