pysiral.scripts.l3proc
======================

.. py:module:: pysiral.scripts.l3proc


Classes
-------

.. autoapisummary::

   pysiral.scripts.l3proc.L3ProcScriptArguments


Functions
---------

.. autoapisummary::

   pysiral.scripts.l3proc.l3proc


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

.. py:function:: l3proc(processing_period: dateperiods.DatePeriod = None, l2_product_directory: List[pathlib.Path] = None, l3_product_directory: Union[str, pathlib.Path] = None, l3_settings: Union[str, pathlib.Path] = None, l3_grid_id: str = None, l3_output: List[Union[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

   :param processing_period:
   :param l2_product_directory:
   :param l3_product_directory:
   :param l3_settings:
   :param l3_grid_id:
   :param l3_output:
   :param duration:
   :param doi:
   :param processing_level:
   :param data_record:
   :param 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.
   :return:


.. py:class:: L3ProcScriptArguments

   Bases: :py:obj:`object`


   .. py:attribute:: parser


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


   .. py:method:: autocomplete_product_processing_level(l2_product_directory: Union[List[pathlib.Path]]) -> str
      :staticmethod:


      Autocomplete the product processing level based on the provided arguments.

      :param l2_product_directory: The L2 product directory path or multiple thereof.

      :return: product processing level as a string.



   .. py:method:: autocomplete_l3_product_directory(l3_product_directory: Union[str, pathlib.Path, None], l2_product_directory: Union[str, pathlib.Path, List[pathlib.Path]], processing_level: str) -> pathlib.Path
      :staticmethod:


      Autocomplete the L3 product directory based on the provided arguments.

      :param l3_product_directory: The L3 product directory path or None if not provided.
      :param l2_product_directory: The L2 product directory path or multiple thereof.
      :param processing_level: The target processing level.

      :return: Updated Level-3 product directory path.



   .. py:method:: autocomplete_l3_product_duration(duration: Union[str, None], processing_period: dateperiods.DatePeriod) -> str
      :staticmethod:


      Autocomplete the L3 product directory based on the provided arguments.

      :param duration:
      :param processing_period:

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



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


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

      :return: The argument parser object.