TSPROC: a general time-series processor to assist in model calibration and result summarization

TSPROC (Time Series PROCessor) is a software package designed to assist in the calibration of models by editing and distilling time series datasets into more meaningful observations to be used in the optimization objective function. TSPROC uses a simple scripting language to process and analyze time series. The software is designed to perform calculations on time-series data commonly associated with surface-water models, including calculation of flow volumes, transformation by means of basic arithmetic operations, and generation of seasonal and annual statistics and hydrologic indices. TSPROC can also be used to generate some of the key input files required to perform parameter optimization by means of the PEST (Parameter ESTimation) computer software. Through the use of TSPROC, the objective function for use in the model-calibration process can be focused on specific components of a hydrograph.

INFORMATION AND DOWNLOADS

User Guides and Technical Information

Westenbroek, S.M., Doherty, J., Walker, J.F., Kelson, V.A., Hunt, R.J., and Cera, T.B., 2012, Approaches in Highly Parameterized Inversion: TSPROC, a general time-series processor to assist in model calibration and result summarization: U.S. Geological Survey Techniques and Methods, book 7, chap. C7, 79 p., three appendixes

Supported Computing Platforms and Source Code Compilation

TSPROC is known to run on Windows (XP/7) and Linux platforms. There should be no problems running the code on Macintosh hardware, but this has not been attempted by the authors. The TSPROC code is written mostly in Fortran 95/2003; the hydrologic indices module is written in C. Compilation of the code has been routinely accomplished using the G95/gcc, gfortran/gcc, and Intel Fortran/C compilers.

EXECUTABLES

TSPROC executables are currently available for Windows 32-bit and 64-bit systems. There is no installation procedure needed; unzip or untar the archive files and ensure that the executables are placed into your path and are accessible from the command line.

Version 1.0.4 (CURRENT)

Windows (32-bit): 655KB, compiled November 8, 2013

Windows (64-bit): 1.17MB, compiled November 8, 2013

SOURCE CODE

A ZIP file that contains all of the source code for TSPROC may be downloaded here (55 MB).

Source Code Documentation, Repository, and Changelog

Git is software that helps manage collaborative development of software projects. TSPROC has a publicly accessible GitHub repository for current, developmental, and experimental versions of TSPROC. Keep in mind that the versions of TSPROC found on GitHub may contain undocumented features and incomplete additions to the code.

POINTS OF CONTACT

Support is provided for correcting bugs and clarification of how the code is intended to work. Only limited assistance can be provided for applying TSPROC to specific problems. For support or comments regarding this site contact Stephen Westenbroek.

ACKNOWLEDGEMENTS

In addition to code created by the authors named in the user guide, TSPROC contains subroutines and code fragments originally authored by:

• Arjen Markus and Michael Baudin: tokenize.F90 - FLIBS module to tokenize a string.
• Brian Cade and John Heasley: compute_hi.cpp - subroutine to calculate hydrologic indices as part of NATHAT, the USGS National Hydrologic Assessment Tool.
• Walter Brainerd, Charles Goldberg, and Jeanne Adams, as modified by Alan Miller: quicksort - recursive sorting subroutine.

Software User Rights Notice

This software, documentation, and example data sets are made available by the U.S. Geological Survey (USGS) to be used in the public interest and in the advancement of science. You may, without any fee or cost, use, copy, modify, or distribute this software, and any derivative works thereof, and its supporting documentation, subject to the restrictions and understandings found at: http://water.usgs.gov/software/help/notice/

* Any use of trade, firm, or product names is for descriptive purposes only and does not imply endorsement by the U.S. Government.