pysiral.scripts.l1preproc
=========================

.. py:module:: pysiral.scripts.l1preproc


Classes
-------

.. autoapisummary::

   pysiral.scripts.l1preproc.L1PreProcScriptArguments


Functions
---------

.. autoapisummary::

   pysiral.scripts.l1preproc.l1preproc


Module Contents
---------------

.. py:function:: l1preproc(l1p_settings: Union[str, pathlib.Path] = None, processing_period: dateperiods.DatePeriod = None, exclude_months: Optional[List[int]] = None, hemisphere: str = 'global', platform: str = None, output_handler_cfg: dict = None, source_dataset_id: str = None, use_multiprocessing: bool = False, multiprocessing_num_cores: Optional[int] = None) -> None

   Workflow script of the pysiral l1b preprocessor.

   :param l1p_settings: Level-1 preprocessor settings file or ID.
   :param processing_period: The processing period to run the preprocessor for.
   :param exclude_months: List of months to exclude from processing (optional).
   :param hemisphere: Hemisphere to process data for, default is "global".
   :param platform: Platform identifier (optional).
   :param output_handler_cfg: Configuration for the output handler (optional).
   :param source_dataset_id: Identifier for the source repository (optional).

   :return: None


.. py:class:: L1PreProcScriptArguments

   Bases: :py:obj:`object`


   .. py:attribute:: parser


   .. py:method:: get(args_list: List[str] = None) -> argparse.Namespace


   .. py:method:: get_argument_parser() -> argparse.ArgumentParser
      :staticmethod:


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

      :return: The argument parser object.