pysiral.scripts.l3proc

Classes

L3ProcScriptArguments

Functions

l3proc(→ None)

Module Contents

pysiral.scripts.l3proc.l3proc(processing_period: dateperiods.DatePeriod = None, l2_product_directory: List[pathlib.Path] = None, l3_product_directory: str | pathlib.Path = None, l3_settings: str | pathlib.Path = None, l3_grid_id: str = None, l3_output: List[str | pathlib.Path] = None, duration: pysiral.core.flags.DurationType = DurationType.P1M, doi: str = None, processing_level: pysiral.core.flags.ProductProcessingLevels = ProductProcessingLevels.LEVEL3_COLLATED, data_record: pysiral.core.flags.DataRecordType = None, exclude_months: List[int] = None) → None
Parameters:

  • processing_period

  • l2_product_directory

  • l3_product_directory

  • l3_settings

  • l3_grid_id

  • l3_output

  • duration

  • doi

  • processing_level

  • data_record

  • exclude_months – List of months to exclude from processing (1-12). If None, no months are excluded. If provided, the months will be filtered out from the processing period.

Returns:

class pysiral.scripts.l3proc.L3ProcScriptArguments

Bases: object

parser
get(args_list: List[str] = None) → argparse.Namespace
static autocomplete_product_processing_level(l2_product_directory: List[pathlib.Path]) → str

Autocomplete the product processing level based on the provided arguments.

Parameters:

l2_product_directory – The L2 product directory path or multiple thereof.

Returns:

product processing level as a string.

static autocomplete_l3_product_directory(l3_product_directory: str | pathlib.Path | None, l2_product_directory: str | pathlib.Path | List[pathlib.Path], processing_level: str) → pathlib.Path

Autocomplete the L3 product directory based on the provided arguments.

Parameters:

  • l3_product_directory – The L3 product directory path or None if not provided.

  • l2_product_directory – The L2 product directory path or multiple thereof.

  • processing_level – The target processing level.

Returns:

Updated Level-3 product directory path.

static autocomplete_l3_product_duration(duration: str | None, processing_period: dateperiods.DatePeriod) → str

Autocomplete the L3 product directory based on the provided arguments.

Parameters:

  • duration

  • processing_period

Returns:

Updated arguments namespace with the L3 product directory set (if required)

static get_argument_parser() → argparse.ArgumentParser

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

Returns:

The argument parser object.