|
|
|
## Waveform Data
|
|
|
|
|
|
|
|
REDPy reads and processes continuous timeseries of waveforms from any format that [ObsPy can read](https://docs.obspy.org/packages/autogen/obspy.core.stream.read.html), including but not strictly limited to seismic and acoustic data. Triggered data (i.e., small snippets of data around known events) may be used so long as they can be read, but with reduced utility. Users must specify in the [configuration file](#configuration-file) the source of the waveform data, which may be the path to files on a local disk, a local or remote waveserver (e.g. [Winston](https://volcanoes.usgs.gov/software/winston/index.shtml)), or [FDSN webservice](https://www.fdsn.org/datacenters/) (e.g., `IRIS`). The station, channel, network, and location codes for each channel of data to be incorporated must also be specified, and must match the metadata exactly—no wildcards are supported.
|
|
|
|
|
|
|
|
## Configuration File
|
|
|
|
|
|
|
|
A `.cfg`/`.ini`-style configuration file controls all of the various customizable settings for a single REDPy run's behavior, fed into various [console scripts](Console-Scripts) with `-c CONFIGFILE`. The only _required_ line is `[Settings]` at the top of the file, as every setting that is not included in the file will be set to default values. These defaults are listed in the comments of `settings.cfg` included in the code release. Edits may be made directly to `settings.cfg` if the user desires, though it is not recommended.
|
|
|
|
|
|
|
|
Most of the default settings correspond to a possible run of the onset of the 2004 Mount St. Helens dome-building eruption. I recommend _at minimum_ the following settings are customized for any new runs:
|
|
|
|
- Name/Path: `title`, `groupname`, and `filename`
|
|
|
|
- Data Source: `server`, and if `server=file` the `searchdir` and likely `filepattern`
|
|
|
|
- SCNL: `nsta`, `station`, `channel`, `network`, and `location`
|
|
|
|
- Triggering: `nstac`
|
|
|
|
- Cross-Correlation: `ncor`
|
|
|
|
|
|
|
|
The next most likely settings that may need changing are related to the outputs:
|
|
|
|
- Timeline: likely `minplot`, `recplot`, and `dybin` depending on the length of your run
|
|
|
|
- Family Plot: likely `printsta`
|
|
|
|
- If you wish to utilize the external catalog parameters with `checkcomcat=True`, you will likely need to change `stalats` and `stalons`.
|
|
|
|
|
|
|
|
Recommendations for further changes are included in the comments of `settings.cfg`.
|
|
|
|
|
|
|
|
## Optional Event Catalog
|
|
|
|
|
|
|
|
A catalog of events of interest may be given as an argument to [`redpy-catfill`](Console-Scripts#redpy-catfill) to reduce the amount of continuous data to be processed and/or to explicitly specify triggering times. At minimum, this file should have one column dedicated to event times in a relatively standard format (e.g., [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601)) that [`pandas.to_datetime()`](https://pandas.pydata.org/docs/reference/api/pandas.to_datetime.html) can automatically parse and return as [UTC](https://en.wikipedia.org/wiki/Coordinated_Universal_Time) datetimes. Additional columns may be included, and some features may require columns for latitude, longitude, and depth. All columns must have headers, though the "Time" column may have a customized name. Although `.csv` files are comma-separated by definition, custom delimiters (e.g., `|`) may be used when commas are used within a column for place names. Similar formats are also expected for other scripts that expect a `.csv`-like catalog. |
|
|
\ No newline at end of file |
