pysiral.scripts.config
======================

.. py:module:: pysiral.scripts.config


Attributes
----------

.. autoapisummary::

   pysiral.scripts.config.__author__


Classes
-------

.. autoapisummary::

   pysiral.scripts.config.ConfigActions
   pysiral.scripts.config.ConfigScriptArguments


Functions
---------

.. autoapisummary::

   pysiral.scripts.config.config
   pysiral.scripts.config.config_init
   pysiral.scripts.config.config_set
   pysiral.scripts.config.local_machine_def_copy_template
   pysiral.scripts.config.copy_config_files
   pysiral.scripts.config.set_pysiral_cfg_loc


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

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


.. py:class:: ConfigActions

   Bases: :py:obj:`enum.StrEnum`


   Enum where members are also (and must be) strings


   .. py:attribute:: INIT
      :value: 'init'



   .. py:attribute:: SET
      :value: 'set'



.. py:function:: config(action: ConfigActions = ConfigActions.INIT, target_or_directory: Optional[Union[pathlib.Path, str]] = None, yes: bool = False) -> None

   Main entry point for the config script. Can either initialize the pysiral configuration
   in the default configuration directory or set/update the configuration to a specific
   directory.

   :param action:
   :param target_or_directory:
   :param yes:

   :return: None


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

   Initial pysiral configuration in the default configuration directory.

   :return: None


.. py:function:: config_set(target: Union[pathlib.Path, str], yes: bool) -> None

   :param target:
   :param yes:

   :return: None


.. py:function:: local_machine_def_copy_template(target_filepath: pathlib.Path) -> None

   Copy the local machine definition template to the target filepath.

   :param target_filepath:

   :return: None


.. py:function:: copy_config_files(target_directory: pathlib.Path, yes: bool) -> None

   Copy the configuration files to the target directory.

   :param target_directory: The
   :param yes:

   :return:


.. py:function:: set_pysiral_cfg_loc(target)

   Write the location of the pysiral configuration for the current package
   NOTE: If you don't know what this means: Please Don't! An incorrect setting
   can break your pysiral installation!

   :param target: The target directory or identifier (e.g., "USER_HOME", "PACKAGE", or a specific path)

   :return: None


.. py:class:: ConfigScriptArguments

   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.