Usage#
Software for computing relative seismic moment tensors
usage: relmt [-h]
{init,align,exclude,amplitude,admit,solve,plot-alignment,plot-spectra,plot-mt}
...
Positional Arguments#
- mode
Possible choices: init, align, exclude, amplitude, admit, solve, plot-alignment, plot-spectra, plot-mt
Sub-commands#
init#
Initialize default directories and files
relmt init [-h] [directory]
Positional Arguments#
- directory
Name of the directory to initiate
Default:
.
align#
Align waveforms
relmt align [-h] [-c CONFIG] [-a [ALIGNMENT]] [-o] [--mccc] [--pca]
Named Arguments#
- -c, --config
Use this configuration file
Default:
config.yaml- -a, --alignment
Alignment iteration
Default:
0- -o, --overwrite
Overwrite existing files
Default:
False- --mccc
Align with Multi-Channel Cross Correlation (MCCC)
Default:
False- --pca
Align with principal component analysis (PCA).
Default:
False
When neither ‘–pca’ nor ‘–mccc’ are given, we assume both.
exclude#
Exclude phase observations from alignment based on criteria in header files
relmt exclude [-h] [--nodata] [--snr] [--cc] [--ecn] [--overwrite]
[-a [ALIGNMENT]] [-c CONFIG] [--cc_from_file]
Named Arguments#
- --nodata
Exlude data with no data or data containing NaNs
Default:
False- --snr
Exlude data with signal to noise ratio lower than ‘min_signal_noise_ratio’ in the station header file
Default:
False- --cc
Exlude data with correlation coefficient lower than ‘min_correlation’ in the station header file
Default:
False- --ecn
Exlude data with expansion coefficient norm lower than ‘min_expansion_coefficient_norm’ in the station header file
Default:
False- --overwrite, -o
Overwrite existing entries per category. Never overwrites manuallyexluded phases
Default:
False- -a, --alignment
Alignment iteration
Default:
0- -c, --config
Use this configuration file
Default:
config.yaml- --cc_from_file
Use cross-correlation values from alignment procedure. Faster, but cc values do not reflect changes in time window or filter band.
Default:
False
amplitude#
Measure relative amplitudes on aligned waveforms
relmt amplitude [-h] [-c CONFIG] [-a [ALIGNMENT]] [-o]
Named Arguments#
- -c, --config
Use this configuration file
Default:
config.yaml- -a, --alignment
Alignment iteration
Default:
0- -o, --overwrite
Overwrite existing files
Default:
False
admit#
Apply admission parameters from configuration file to amplitude measurements
relmt admit [-h] [-c CONFIG]
Named Arguments#
- -c, --config
Use this configuration file
Default:
config.yaml
solve#
Compute moment tensors from amplitude measurements
relmt solve [-h] [-c CONFIG] [-a [ALIGNMENT]] [-o] [--predict]
Named Arguments#
- -c, --config
Use this configuration file
Default:
config.yaml- -a, --alignment
Alignment iteration
Default:
0- -o, --overwrite
Overwrite existing files
Default:
False- --predict
Predict relative amplitudes of the solution and compute prediction misfits
Default:
False
plot-alignment#
Plot waveform alignment resuts to screen
relmt plot-alignment [-h] [-c CONFIG] [--sort {pci,magnitude,none}]
[--highlight HIGHLIGHT [HIGHLIGHT ...]] [--exclude]
[--cc {calculate,file,none}] [--saveas SAVEAS]
file
Positional Arguments#
- file
Path to -wvarr.npy file
Named Arguments#
- -c, --config
Use this configuration file
Default:
config.yaml- --sort
Possible choices: pci, magnitude, none
The sorting to apply: ‘pci’ (default), ‘magnitude’, ‘none’
Default:
'pci'- --highlight
Event IDs to highligh in the plot
Default:
[]- --exclude
Exclude events listed in the exclude file
Default:
False- --cc
Possible choices: calculate, file, none
Method to obtain the cross-correlation matrix:* calculate: Re-calculate using current header values.* file: Use cross-correlation values from alignment procedure. Faster, but cc values do not reflect changes in time window or filter band.* none: Do not show cc values.
Default:
'calculate'- --saveas, -s
Save the figure to file
plot-spectra#
Plot waveform spectra to screen
relmt plot-spectra [-h] [-c CONFIG] [--highlight HIGHLIGHT [HIGHLIGHT ...]]
[--integrate] [--saveas SAVEAS]
waveformfile [bandpassfile]
Positional Arguments#
- waveformfile
Path to -wvarr.npy file
- bandpassfile
Path to bandpass.yaml file
Named Arguments#
- -c, --config
Use this configuration file
Default:
config.yaml- --highlight
Event IDs to highligh in the plot
Default:
[]- --integrate
Integrate waveforms (e.g. velocity to displacement)
Default:
False- --saveas, -s
Save the figure to file
plot-mt#
Plot waveform spectra to screen
relmt plot-mt [-h] [-c CONFIG] [--dc DC]
[--highlight HIGHLIGHT [HIGHLIGHT ...]]
[--sort-by {number,name,mag,mw,gap,links,p-links,s-links,moment-rms,amplitude-rms,boot-rms,boot-kagan}]
[--color-by {number,name,mag,mw,gap,links,p-links,s-links,moment-rms,amplitude-rms,boot-rms,boot-kagan}]
[--saveas SAVEAS]
mtfile
Positional Arguments#
- mtfile
Path to mt summary file
Named Arguments#
- -c, --config
Use this configuration file
Default:
config.yaml- --dc
Overlay DC component at this fraction of the full moment (0-1)
Default:
1.0- --highlight
Event IDs to highligh in the plot
Default:
[]- --sort-by
Possible choices: number, name, mag, mw, gap, links, p-links, s-links, moment-rms, amplitude-rms, boot-rms, boot-kagan
Sorting method for MTs. One of: * ‘number’: Event ID * ‘name’: Event Name * ‘mag’: Input magnitude * ‘mw’: Relative moment magnitude * ‘gap’: Azimuthal gap (deg) * ‘links’: Total links * ‘p-links’: P links * ‘s-links’: S links * ‘moment-rms’: Moment RMS (scaled Nm) * ‘amplitude-rms’: Amplitude RMS * ‘boot-rms’: normalized Bootstrap RMS (Nm/M0) * ‘boot-kagan’: Bootstrap Kagan angle (deg)
- --color-by
Possible choices: number, name, mag, mw, gap, links, p-links, s-links, moment-rms, amplitude-rms, boot-rms, boot-kagan
Coloring method for MTs. One of: * ‘number’: Event ID * ‘name’: Event Name * ‘mag’: Input magnitude * ‘mw’: Relative moment magnitude * ‘gap’: Azimuthal gap (deg) * ‘links’: Total links * ‘p-links’: P links * ‘s-links’: S links * ‘moment-rms’: Moment RMS (scaled Nm) * ‘amplitude-rms’: Amplitude RMS * ‘boot-rms’: normalized Bootstrap RMS (Nm/M0) * ‘boot-kagan’: Bootstrap Kagan angle (deg)
- --saveas, -s
Save the figure to file