Command line¶
| Command | Purpose |
|---|---|
init |
Print a configuration file with all defaults. |
check |
Validate a configuration file. |
metadata |
Download only the station inventory and StationXML. |
download |
Download data from FDSN servers into an SDS archive. |
convert |
Sort existing MiniSEED files into an SDS archive. |
Every command accepts --help.
init¶
Print the default configuration as JSON.
fdsn-rush init --help
The defaults are documented in the configuration reference.
check¶
Validate a configuration file.
fdsn-rush check --help
Usage: fdsn-rush check [OPTIONS] {file}
Validate the configuration file.
╭─ Arguments ──────────────────────────────────────────────────────────────────╮
│ * file <path> Path to the configuration file [required] │
╰──────────────────────────────────────────────────────────────────────────────╯
╭─ Options ────────────────────────────────────────────────────────────────────╮
│ --help Show this message and exit. │
╰──────────────────────────────────────────────────────────────────────────────╯
It loads the file in strict mode, as download does, and prints FILE is valid. An invalid file raises the validation error and exits with 1. Nothing is contacted or written.
metadata¶
Fetch the station inventory and write the StationXML to metadata_path, but download no waveforms.
fdsn-rush metadata --help
Usage: fdsn-rush metadata [OPTIONS] {file}
Download only the station inventory and StationXML, no waveforms.
╭─ Arguments ──────────────────────────────────────────────────────────────────╮
│ * file <path> Path to the configuration file [required] │
╰──────────────────────────────────────────────────────────────────────────────╯
╭─ Options ────────────────────────────────────────────────────────────────────╮
│ --help Show this message and exit. │
╰──────────────────────────────────────────────────────────────────────────────╯
download¶
Download waveforms and StationXML as described in a configuration file.
fdsn-rush download --help
Usage: fdsn-rush download [OPTIONS] {file}
Download data from FDSN to local SDS archive.
Logs to <config>.log next to the configuration file.
╭─ Arguments ──────────────────────────────────────────────────────────────────╮
│ * file <path> Path to the configuration file [required] │
╰──────────────────────────────────────────────────────────────────────────────╯
╭─ Options ────────────────────────────────────────────────────────────────────╮
│ --verbose -v <int> [default: 0] │
│ --non-interactive -n No live view and no console output except │
│ a few key: value lines on stdout. Exit │
│ code: 0 ok, 1 error, 2 partial. │
│ --help Show this message and exit. │
╰──────────────────────────────────────────────────────────────────────────────╯
FILE- Path to the configuration file.
-v,--verbose- Show debug output, including the request URLs.
-n,--non-interactive- Run without console output except a few
key: valuelines on stdout, and exit with a status code. See Scripting and automation.
Every run writes its log to <config>.log next to the configuration file (config.json → config.log) and keeps fdsn-rush-stats.json in the SDS archive up to date.
The command exits once all clients have finished. Running it again resumes or extends the archive. See Resuming and updating archives.
convert¶
Sort MiniSEED files from a directory tree into an SDS archive.
fdsn-rush convert --help
Usage: fdsn-rush convert [OPTIONS] {input} {output}
Convert existing MiniSEED files to SDS archive.
╭─ Arguments ──────────────────────────────────────────────────────────────────╮
│ * input <path> Path to the input directory containing MiniSEED │
│ files │
│ [required] │
│ * output <path> Path to the output directory for SDS archive │
│ [required] │
╰──────────────────────────────────────────────────────────────────────────────╯
╭─ Options ────────────────────────────────────────────────────────────────────╮
│ --rename <str> Rename codes, as FROM=TO in NET.STA.LOC.CHA form, │
│ e.g. '1X...=2D...'. Empty parts match any code │
│ (FROM) or keep it (TO), '--' is the blank │
│ location. Repeatable, applied in order. │
│ --steim <int> STEIM compression type to use (1 or 2) │
│ [default: 2] │
│ --n-workers <int> Number of worker threads for conversion │
│ [default: 64] │
│ --help Show this message and exit. │
╰──────────────────────────────────────────────────────────────────────────────╯
INPUT- Directory that is searched recursively for MiniSEED files.
OUTPUT- Root directory of the SDS archive to write.
--rename FROM=TO- Rename codes. Both sides are written as
NET.STA.LOC.CHA, and missing trailing parts are empty. InFROM, each part is an fnmatch pattern, an empty part matches any code and--matches the blank location. InTO, an empty part keeps the code and--sets the blank location. Repeatable. The rules are applied in the given order, each one to the codes left by the rules before it. See Renaming codes. --steim 1|2- STEIM compression level. Default:
2. --n-workers N- Number of files converted concurrently. Default:
64.
See Converting MiniSEED to SDS for details and caveats.