CLI (Command Line Interface)#
swarmpal#
Usage
swarmpal [OPTIONS] COMMAND [ARGS]...
batch#
Run SwarmPAL in batch mode. The datasets and processes need to be specified in YAML file and passed as the first CONFIG argument. The results are written to NetCDF files specified by OUT.
Usage
swarmpal batch [OPTIONS] CONFIG OUT
Options
- --time <time>#
Override the start and end times in the configuration file
- --overwrite#
Overwrite output file if it already exists
Arguments
- CONFIG#
Required argument
- OUT#
Required argument
fac-single-sat#
Execute FAC single-satellite processor
Usage
swarmpal fac-single-sat [OPTIONS]
Options
- --spacecraft <spacecraft>#
Required Check available with: swarmpal spacecraft
- --time_start <time_start>#
Required ISO 8601 time
- --time_end <time_end>#
Required ISO 8601 time
- --grade <grade>#
Required ‘OPER’ or ‘FAST’
- --to_cdf_file <to_cdf_file>#
Required Output CDF file
fetch-data#
Fetch data described in yaml file CONFIG and save the resulting DataTree in NetCDF file OUT
Usage
swarmpal fetch-data [OPTIONS] CONFIG OUT
Options
- --time <time>#
Override the start and end times in the configuration file
- --overwrite#
Overwrite output file if it already exists
Arguments
- CONFIG#
Required argument
- OUT#
Required argument
last-available-time#
UTC of last available data for a collection, e.g. SW_FAST_MAGA_LR_1B
Usage
swarmpal last-available-time [OPTIONS] COLLECTION
Arguments
- COLLECTION#
Required argument
quicklook#
Create a quicklook plot if possible
Usage
swarmpal quicklook [OPTIONS] FILE OUT
Options
- --overwrite#
Overwrite output file if it already exists
Arguments
- FILE#
Required argument
- OUT#
Required argument
spacecraft#
List names of available spacecraft
Usage
swarmpal spacecraft [OPTIONS]