Running

Command line arguments

Requake is based on a single executable, aptly named requake 😉.

To get help, use:

requake -h

Different commands are available:

sample_config       write sample config file to current directory and exit
update_config       update an existing config file to the latest version
read_catalog        read an event catalog from web services or from a file
print_catalog       print the event catalog to screen
scan_catalog        scan an existing catalog for earthquake pairs
print_pairs         print pairs to screen
plot_pair           plot traces for a given event pair
build_families      build families of repeating earthquakes from a catalog
                    of pairs
print_families      print families to screen
plot_families       plot traces for one or more event families
plot_timespans      plot family timespans
plot_cumulative     cumulative plot for one or more families
map_families        plot families on a map
flag_family         flag a family of repeating earthquakes as valid or not
                    valid.
build_templates     build waveform templates for one or more event
                    families
scan_templates      scan a continuous waveform stream using one or more
                    templates
wfcache             manage persistent waveform cache (prefetch, print,
                    inspect, extract, reset_failures)

Certain commands (e.g., plot_pair) require further arguments (use, e.g., requake plot_pair -h to get help).

Requake supports command line tab completion for commands and arguments, thanks to argcomplete. To enable command line tab completion run:

activate-global-python-argcomplete

(This is a one-time command that needs to be run only once).

Or, alternatively, add the following line to your .bashrc or .zshrc:

eval "$(register-python-argcomplete requake)"

Typical workflow

The first thing you will want to do is to generate a sample Configuration File:

requake sample_config

Edit the Configuration File according to your needs, then read or download the event catalog:

requake read_catalog

or

requake read_catalog CATALOG_FILE

When relying on FDSN web services for waveform data, it is strongly recommended to prefetch all waveform windows before running the scan. This downloads every required waveform once and stores it in a local SQLite cache, avoiding repeated downloads and dramatically reducing overall runtime for large catalogs:

requake wfcache prefetch

Now, build the catalog of event pairs with:

requake scan_catalog

Once done (it will take time!), you are ready to build repeating earthquake families:

requake build_families