| ... | ... | @@ -4,7 +4,7 @@ REDPy reads and processes continuous timeseries of waveforms from any format tha |
|
|
|
|
|
|
|
## 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.
|
|
|
|
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`](https://code.usgs.gov/vsc/REDPy/-/blob/main/settings.cfg) included in the code release. Edits may be made directly to [`settings.cfg`](https://code.usgs.gov/vsc/REDPy/-/blob/main/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](https://www.usgs.gov/volcanoes/mount-st.-helens/2004-2008-renewed-volcanic-activity). I recommend _at minimum_ the following settings are customized for any new runs:
|
|
|
|
- Name/Path: `title`, `groupname`, and `filename`
|
| ... | ... | @@ -18,7 +18,7 @@ The next most likely settings that may need changing are related to the outputs: |
|
|
|
- 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`, evaluate the distance and magnitude thresholds appropriate for your dataset, and consider setting `matchmax` to a value other than its default
|
|
|
|
|
|
|
|
Many other settings are configurable that are documented in the comments of `settings.cfg`, but some settings introduced in V1.0 that I like to use for my runs are: `merge_ratio=0.6`, `corr_nrecent=25`, `corr_nyoungest=25`, `corr_nlargest=50`, `use_nthcor=True`, and `corr_permit=0.1`.
|
|
|
|
Many other settings are configurable that are documented in the comments of [`settings.cfg`](https://code.usgs.gov/vsc/REDPy/-/blob/main/settings.cfg), but some settings introduced in V1.0 that I like to use for my runs are: `merge_ratio=0.6`, `corr_nrecent=25`, `corr_nyoungest=25`, `corr_nlargest=50`, `use_nthcor=True`, and `corr_permit=0.1`.
|
|
|
|
|
|
|
|
## Optional Event Catalog
|
|
|
|
|
| ... | ... | |
| ... | ... | |