Command-line interface

GW Summary

The primary interface for GWSumm is a command-line utility called gw_summary. For a full explanation of the available command-line arguments and options, you can run

$ python ../bin/gw_summary --help
python: can't open file '/home/docs/checkouts/readthedocs.org/user_builds/gwsumm/checkouts/latest/docs/../bin/gw_summary': [Errno 2] No such file or directory

This tool can be run in four modes: daily, weekly, and monthly analyses, and a specific range of GPS times.

Day mode

To run in daily summary mode, the following command-line options are available:

$ python gw_summary day --help
python: can't open file '/home/docs/checkouts/readthedocs.org/user_builds/gwsumm/checkouts/latest/docs/gw_summary': [Errno 2] No such file or directory

Week mode

The arguments in weekly mode are as follows:

$ python gw_summary week --help
python: can't open file '/home/docs/checkouts/readthedocs.org/user_builds/gwsumm/checkouts/latest/docs/gw_summary': [Errno 2] No such file or directory

Month mode

In monthly mode:

$ python gw_summary month --help
python: can't open file '/home/docs/checkouts/readthedocs.org/user_builds/gwsumm/checkouts/latest/docs/gw_summary': [Errno 2] No such file or directory

GPS mode

To run within a specific (but arbitrary) range of GPS seconds:

$ python gw_summary gps --help
python: can't open file '/home/docs/checkouts/readthedocs.org/user_builds/gwsumm/checkouts/latest/docs/gw_summary': [Errno 2] No such file or directory

Batch mode

To stage a batch of analyses with a large collection of configuration files, as is done in embarrassingly parallel fashion when the summary pages run online, you can use the gw_summary_pipe command-line utility. This tool uses HT Condor to schedule and run jobs in parallel.

To see all the available arguments and options for this tool, you can run with –help as usual:

$ python gw_summary_pipe --help
python: can't open file '/home/docs/checkouts/readthedocs.org/user_builds/gwsumm/checkouts/latest/docs/gw_summary_pipe': [Errno 2] No such file or directory