svtk io

Command Tree

svtk io

Command Details

Usage

svtk io [-h]
            {prepare-stations,prepare-events,master-stations,master-events,inventory,preprocess-waveforms}
            ...

Parameters

Name	Required	Default / choices	Description
`-h`, `--help`	No		show this help message and exit

svtk io inventory

Usage

svtk io inventory [-h] --observed-root OBSERVED_ROOT --synthetic-root
                      SYNTHETIC_ROOT --output OUTPUT [--suffix SUFFIX]
                      [--relative-to RELATIVE_TO] [--no-sha256]

Parameters

Name	Required	Default / choices	Description
`-h`, `--help`	No		show this help message and exit
`--observed-root`	Yes		Value: `observed_root`. Observed waveform root directory.
`--synthetic-root`	Yes		Value: `synthetic_root`. Synthetic waveform root directory.
`--output`	Yes		Value: `output`. Output CSV/parquet path.
`--suffix`	No	Repeatable	Value: `suffix`. Waveform suffix to include. May be repeated.
`--relative-to`	No		Value: `relative_to`. Base path used for relative inventory paths.
`--no-sha256`	No	Flag	Skip SHA-256 hashing.

svtk io master-events

Usage

svtk io master-events [-h] --input INPUT [INPUT ...] --output OUTPUT

Parameters

Name	Required	Default / choices	Description
`-h`, `--help`	No		show this help message and exit
`--input`	Yes	Nargs: `+`	Value: `input`. Event CSV/parquet paths.
`--output`	Yes		Value: `output`. Output CSV path.

svtk io master-stations

Usage

svtk io master-stations [-h] --input INPUT [INPUT ...] --output OUTPUT

Parameters

Name	Required	Default / choices	Description
`-h`, `--help`	No		show this help message and exit
`--input`	Yes	Nargs: `+`	Value: `input`. Station CSV/parquet paths.
`--output`	Yes		Value: `output`. Output CSV path.

svtk io prepare-events

Usage

svtk io prepare-events [-h] --input INPUT --output OUTPUT

Parameters

Name	Required	Description
`-h`, `--help`	No	show this help message and exit
`--input`	Yes	Value: `input`. Event CSV/parquet path.
`--output`	Yes	Value: `output`. Output CSV/parquet path.

svtk io prepare-stations

Usage

svtk io prepare-stations [-h] --input INPUT --output OUTPUT

Parameters

Name	Required	Description
`-h`, `--help`	No	show this help message and exit
`--input`	Yes	Value: `input`. Station CSV/parquet path.
`--output`	Yes	Value: `output`. Output CSV/parquet path.

svtk io preprocess-waveforms

Usage

svtk io preprocess-waveforms [-h] --records RECORDS
                                 [--output-root OUTPUT_ROOT]
                                 [--config CONFIG]
                                 [--run-scenario RUN_SCENARIO]
                                 [--observed-column OBSERVED_COLUMN]
                                 [--synthetic-column SYNTHETIC_COLUMN]
                                 [--event-id-col EVENT_ID_COL]
                                 [--lowpass-hz LOWPASS_HZ]
                                 [--highpass-hz HIGHPASS_HZ]
                                 [--bandpass-low-hz BANDPASS_LOW_HZ]
                                 [--bandpass-high-hz BANDPASS_HIGH_HZ]
                                 [--resample-hz RESAMPLE_HZ]
                                 [--filter-order FILTER_ORDER]
                                 [--overwrite] [--continue-on-error]
                                 [--keep-input-columns]

Parameters

Name	Required	Default / choices	Description
`-h`, `--help`	No		show this help message and exit
`--records`	Yes		Value: `records`. Event-station CSV/parquet with waveform path columns.
`--output-root`	No		Value: `output_root`. Folder where processed waveforms and metadata tables are written. Defaults to outputs.preprocessed_waveforms from config.
`--config`	No		Value: `config`. Spatial-VTK config file.
`--run-scenario`	No		Value: `run_scenario`. Apply one named run_scenarios overlay.
`--observed-column`	No		Value: `observed_column`. Observed waveform path column. Auto-detected when omitted.
`--synthetic-column`	No		Value: `synthetic_column`. Synthetic waveform path column. Auto-detected when omitted.
`--event-id-col`	No	Default: `event_id`	Value: `event_id_col`. Event ID column in –records.
`--lowpass-hz`	No		Value: `lowpass_hz`. Optional lowpass cutoff in Hz.
`--highpass-hz`	No		Value: `highpass_hz`. Optional highpass cutoff in Hz.
`--bandpass-low-hz`	No		Value: `bandpass_low_hz`. Optional bandpass low corner in Hz.
`--bandpass-high-hz`	No		Value: `bandpass_high_hz`. Optional bandpass high corner in Hz.
`--resample-hz`	No		Value: `resample_hz`. Optional target sampling rate in Hz.
`--filter-order`	No		Value: `filter_order`. Butterworth filter order.
`--overwrite`	No	Flag	Rewrite processed files even if they already exist.
`--continue-on-error`	No	Flag	Record failed files in the manifest instead of stopping.
`--keep-input-columns`	No	Flag	Keep original waveform path columns pointed at raw files.