LIGOtools, as re-scoped in March 2014, is a collection of miscellaneous software tools which are useful for LIGO data analysis. It is distributed via standard packaging methods such as rpm. (The previous incarnation, which had its own package distribution and management scheme and included several additional packages such as Frame and metaio, is described here for historical reference.)
The current tools in LIGOtools are:
- tconvert: Command-line utility which converts a free-form date/time string to GPS seconds and vice versa. For usage information, type 'tconvert' without any arguments. tconvert is designed to automatically know about new leap seconds as they are announced. When necessary, it gets its information either from and LDAS web server or from the latest Bulletin C of the International Earth Rotation Service. This leap-second information is normally cached in the file ~/tcleaps.txt along with a "valid through" time. When the disk file expires, it is automatically updated, so leap seconds should be known about some time before they actually take effect. (Of course, if you perform a conversion on a time several months in the future, it may not yet be known whether there will be a leap second added in the meantime.) It is hoped that these web files will continue to exist, in basically the same format, for the forseeable future; if not, a warning or error message will be printed to standard error.
- gpsclock: Graphical display of current GPS time, with time conversion dialog. Knows about leap seconds using the same mechanism as tconvert.
- segsum: Command-line utility to calculate the total time in the segments in an ascii segment list file. For usage information, type 'segsum -h'.
- segdiff: Command-line utility to compare two ascii segment list files. For usage information, type 'segdiff' without any arguments.
- segexpr: Command-line utility to perform operations (unions, intersections, inversions) on ascii segment list files. For usage information, type 'segexpr' without any arguments.
- guild: Graphical user interface to LIGO databases. More information is here.
- getFrameData: Retrieves frame data from an LDAS system using LDAS username/password access. Format example: 'getFrameData cit R 845000000-845000042 H1:LSC-AS_Q'. Type 'getFrameData' without any arguments for a little more help.
- ldaspw: Stores your LDAS password (obscured, but not strongly encrypted) on disk so that you don't have to enter it when using getFrameData.
- LDASJobH: Helper program for running LDAS jobs.
- cleanlatex: Produces a single clean .tex file from (possibly multiple) source files, stripping out internal comments. For usage information, type 'cleanlatex' without any arguments.
The ligotools source code repository is one of the LSC software repositories hosted by UWM. To clone it on your local system, do 'git clone email@example.com:/usr/local/git/ligotools.git' (subsituting your own ligo.org identity, of course). You can also browse the source code using the cgit web interface.
Package distribution files are temporarily hosted at the University of Maryland. There is a single source distribution file, but the tools are divided into two rpm files:
- Source: ligotools-1.0.0.tar.gz
- RPM (tconvert and gpsclock): ligotools-tconvert-1.0.0-1.noarch.rpm
- RPM (all other tools): ligotools-scripts-1.0.0-1.noarch.rpm
'guild' was written by Peter Shawhan with contributions from Alex Ivanov and Mary Lei. All of the other programs in the current incarnation of LIGOtools were written by Peter Shawhan; however, other people are welcome to add useful tools to LIGOtools if they wish. Adam Mercer and Ed Maros helped set up the ligotools git repository and the packaging procedure.