pysiral.scripts.info
====================

.. py:module:: pysiral.scripts.info


Attributes
----------

.. autoapisummary::

   pysiral.scripts.info.__author__


Classes
-------

.. autoapisummary::

   pysiral.scripts.info.InfoScriptArguments


Functions
---------

.. autoapisummary::

   pysiral.scripts.info.info
   pysiral.scripts.info.pysiral_basic_info
   pysiral.scripts.info.get_git_revision_hash
   pysiral.scripts.info.get_git_branch
   pysiral.scripts.info.pysiral_settings_info


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

.. py:data:: __author__
   :value: 'Stefan Hendricks <stefan.hendricks@awi.de>'


.. py:function:: info(target: str = None, search_string: str = None) -> None

   Main entry point for the info script.

   This function provides information about the specified target.

   :param target: The target to get information about.
   :param search_string: Optional search string to filter information.


.. py:function:: pysiral_basic_info() -> None

   Prints basic information about pysiral.


.. py:function:: get_git_revision_hash(target='HEAD') -> str

.. py:function:: get_git_branch() -> str

.. py:function:: pysiral_settings_info(processing_level: Union[pysiral.core.flags.PysiralProcessingLevels, pysiral.core.flags.ProductProcessingLevels], settings_type: Literal['proc', 'output'], search_string: str = None) -> None

   Prints information about pysiral settings.

   :param processing_level: The processing level (e.g., LEVEL1, LEVEL2).
   :param settings_type: The type of settings (e.g., "proc", "output").
   :param search_string: Optional search string to filter information.


.. py:class:: InfoScriptArguments

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

      :return: The argument parser object.