Below is a chart of the file names and locations of the outputs generated by REDPy assuming the default output folder structure (i.e., within `REDPy/runs/`). Many files are generated by default as outputs of running `redpy-catfill`, `redpy-backfill`, or `redpy-force-plot`. Some are generated when other scripts are run, and these are denoted with the name of the script in square brackets. Yet others may be generated as default outputs, but only when certain settings are enabled and/or conditions met, and those are denoted in parentheses.
```
REDPy/
default/
clusters/
0.html
0.png
fam0.jpg
map0.png (if checkComcat is True)
0-report.html (if createReport.py was run)
0-report-bokeh.html (if createReport.py was run)
0-report.png (if createReport.py was run)
0-reportcmat.png (if createReport.py was run)
0-reportwaves.png (if createReport.py was run)
...
junk/ (if plotJunk.py was run)
2018-01-01T00/00/00.000000Z-0.png (if plotJunk.py was run)
...
catalog.txt
cores.txt
dailycounts.txt
junk.txt (if plotJunk.py was run)
orphancatalog.txt
overview_recent.html
overview.html
swarm.csv
├── ...
├── runs/
│ ├── groupname/ (e.g., default)
│ │ ├── families/
│ │ │ ├── *.html
│ │ │ ├── *.png
│ │ │ ├── *.pdf [redpy-create-pdf-family]
│ │ │ ├── fam*.png
│ │ │ ├── map*.png (if checkcomcat=True and local matches found)
* denotes a family number (chronological by time of first member)
```
## Bokeh Plots ##
`overview.html` and `overview_recent.html` are interactive plots with a shared time axis (i.e., panning or zooming in one window will update the rest). `overview_recent.html` shares the same format as `overview.html` but for only the last `recplot` days, and shows all families active within that period in the occurrence timeline (instead of clusters with at least `minplot` members).
## Interactive Timelines
`overview.html`, `overview_meta.html`, and `overview_recent.html` are interactive plots with a shared time axis (i.e., panning or zooming in one window will update the rest). `overview_recent.html` shares the same format as `overview.html` but for only the last `recplot` days, and shows all families active within that period in the occurrence timeline (instead of clusters with at least `minplot` members). Meanwhile, `overview_meta.html` condenses all plots into tabs so many runs can appear on `meta.html` at once. This plot shows the last `mrecplot` days with at least `mminplot` members.
**Navigation bar** at top right has options to pan, zoom, tap, reset, and save. Title (here, 'REDPy Catalog') is set in `title`.
...
...
@@ -43,7 +65,7 @@ The **Cluster Longevity** plot orders the clusters in the occurrence timeline by
Below is the `overview_recent.html` output of the suggested default run:
Each cluster has its own detailed page with statistics and plots. At the very top are links to the previous and next clusters (ordered by starting time) for navigation between subsequent clusters (though you may always change the number just before `.html` manually, if you wish). The preview waveform is the same as the [occurrence plot](#bokeh-plots) on `overview.html`, and some quick statistics are listed below it.
Top left plot shows the core (black) and stacked (red) waveforms at each station/channel used, and at right is the sum of the Fourier amplitude spectra over all stations. Below those are three timelines. First, the amplitude (on the same preview station only) of each event with time. Next, the time between successive members of the cluster in hours (note the logarithmic scale). Last is the cross-correlation coefficient relative to the best correlated event. Open circles at the bottom mean that no value is stored for that pair (either not computed or below `cmin`). This is intended to help visualize how the waveforms are changing with time. *Note that the coefficient plotted here is what is stored in the table, which is the maximum across all stations used.*
...
...
@@ -51,7 +73,7 @@ Top left plot shows the core (black) and stacked (red) waveforms at each station
Below is the page for Cluster 1 from the suggested default run:
`catalog.txt`: Dates of all repeaters in the catalog and their associated cluster number. If `verbosecatalog` is `True`, then frequency index, amplitude, time since previous event in hours, and correlation coefficient with respect to the best correlated event are also included.
`cores.txt`: Dates of core events and their cluster number. Could be used to create templates from core events.
...
...
@@ -67,3 +89,15 @@ Below is the page for Cluster 1 from the suggested default run:
`default1, #ffff00`
changes the appearance of members of the `default1` family to be yellow to stand out against the default red-orange of the rest of the catalog.
