swarmpal.cli.commands

Functions

_update_times(start_time, end_time, dataset_config)	Helper to update start and end times in a dataset configuration.
_read_config(filename, times)	Helper function to read and validate YAML config files
cli()
spacecraft()	List names of available spacecraft
fac_single_sat(spacecraft, time_start, time_end, ...)	Execute FAC single-satellite processor
last_available_time(collection)	UTC of last available data for a collection, e.g. SW_FAST_MAGA_LR_1B
_check_overwrite(file, overwrite)
fetch_data(time, overwrite, config, out)	Fetch data described in yaml file CONFIG and save the resulting DataTree in NetCDF file OUT
batch(time, overwrite, config, out)	Run SwarmPAL in batch mode. The datasets and processes need to be specified in YAML file and
quicklook(overwrite, file, out)	Create a quicklook plot if possible

Module Contents

swarmpal.cli.commands._update_times(start_time, end_time, dataset_config)

Helper to update start and end times in a dataset configuration.

swarmpal.cli.commands._read_config(filename, times)

Helper function to read and validate YAML config files

swarmpal.cli.commands.cli()

swarmpal.cli.commands.spacecraft()

List names of available spacecraft

swarmpal.cli.commands.fac_single_sat(spacecraft: str, time_start: str, time_end: str, grade: str, to_cdf_file: str)

Execute FAC single-satellite processor

swarmpal.cli.commands.last_available_time(collection)

UTC of last available data for a collection, e.g. SW_FAST_MAGA_LR_1B

swarmpal.cli.commands._check_overwrite(file: click.Path, overwrite: bool)

swarmpal.cli.commands.fetch_data(time, overwrite, config: click.File, out: click.Path)

Fetch data described in yaml file CONFIG and save the resulting DataTree in NetCDF file OUT

swarmpal.cli.commands.batch(time, overwrite, config: click.File, out: click.Path)

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.

swarmpal.cli.commands.quicklook(overwrite, file: click.File, out: click.Path)

Create a quicklook plot if possible