pysiral.scripts.info

Attributes

__author__

Classes

InfoScriptArguments

Functions

info(→ None)	Main entry point for the info script.
pysiral_basic_info(→ None)	Prints basic information about pysiral.
get_git_revision_hash(→ str)
get_git_branch(→ str)
pysiral_settings_info(→ None)	Prints information about pysiral settings.

Module Contents

pysiral.scripts.info.__author__ = 'Stefan Hendricks <stefan.hendricks@awi.de>'

pysiral.scripts.info.info(target: str = None, search_string: str = None) → None

Main entry point for the info script.

This function provides information about the specified target.

Parameters:

• target – The target to get information about.

• search_string – Optional search string to filter information.

pysiral.scripts.info.pysiral_basic_info() → None

Prints basic information about pysiral.

pysiral.scripts.info.get_git_revision_hash(target='HEAD') → str

pysiral.scripts.info.get_git_branch() → str

pysiral.scripts.info.pysiral_settings_info(processing_level: pysiral.core.flags.PysiralProcessingLevels | pysiral.core.flags.ProductProcessingLevels, settings_type: Literal['proc', 'output'], search_string: str = None) → None

Prints information about pysiral settings.

Parameters:

• processing_level – The processing level (e.g., LEVEL1, LEVEL2).

• settings_type – The type of settings (e.g., “proc”, “output”).

• search_string – Optional search string to filter information.

class pysiral.scripts.info.InfoScriptArguments

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-2 Processor.

Returns:

The argument parser object.