pysiral.scripts.l1preproc

Classes

L1PreProcScriptArguments

Functions

l1preproc(→ None)

Workflow script of the pysiral l1b preprocessor.

Module Contents

pysiral.scripts.l1preproc.l1preproc(l1p_settings: str | pathlib.Path = None, processing_period: dateperiods.DatePeriod = None, exclude_months: List[int] | None = None, hemisphere: str = 'global', platform: str = None, output_handler_cfg: dict = None, source_dataset_id: str = None, use_multiprocessing: bool = False, multiprocessing_num_cores: int | None = None) → None

Workflow script of the pysiral l1b preprocessor.

Parameters:

  • l1p_settings – Level-1 preprocessor settings file or ID.

  • processing_period – The processing period to run the preprocessor for.

  • exclude_months – List of months to exclude from processing (optional).

  • hemisphere – Hemisphere to process data for, default is “global”.

  • platform – Platform identifier (optional).

  • output_handler_cfg – Configuration for the output handler (optional).

  • source_dataset_id – Identifier for the source repository (optional).

Returns:

None

class pysiral.scripts.l1preproc.L1PreProcScriptArguments

Bases: object

parser
get(args_list: List[str] = None) → argparse.Namespace
static get_argument_parser() → argparse.ArgumentParser

Set up the command line argument parser for the Level-1 Pre-Processor.

Returns:

The argument parser object.