:py:mod:`mnp.utils`
===================

.. py:module:: mnp.utils

.. autodoc2-docstring:: mnp.utils
   :allowtitles:

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

Classes
~~~~~~~

.. list-table::
   :class: autosummary longtable
   :align: left

   * - :py:obj:`List <mnp.utils.List>`
     - .. autodoc2-docstring:: mnp.utils.List
          :summary:
   * - :py:obj:`CustomFormatter <mnp.utils.CustomFormatter>`
     - .. autodoc2-docstring:: mnp.utils.CustomFormatter
          :summary:

Functions
~~~~~~~~~

.. list-table::
   :class: autosummary longtable
   :align: left

   * - :py:obj:`get_logger <mnp.utils.get_logger>`
     - .. autodoc2-docstring:: mnp.utils.get_logger
          :summary:
   * - :py:obj:`log_start_completed <mnp.utils.log_start_completed>`
     - .. autodoc2-docstring:: mnp.utils.log_start_completed
          :summary:
   * - :py:obj:`log_file_to_cover <mnp.utils.log_file_to_cover>`
     - .. autodoc2-docstring:: mnp.utils.log_file_to_cover
          :summary:
   * - :py:obj:`clear_temp <mnp.utils.clear_temp>`
     - .. autodoc2-docstring:: mnp.utils.clear_temp
          :summary:
   * - :py:obj:`slugify <mnp.utils.slugify>`
     - .. autodoc2-docstring:: mnp.utils.slugify
          :summary:
   * - :py:obj:`config_info_to_temp <mnp.utils.config_info_to_temp>`
     - .. autodoc2-docstring:: mnp.utils.config_info_to_temp
          :summary:
   * - :py:obj:`create_directories <mnp.utils.create_directories>`
     - .. autodoc2-docstring:: mnp.utils.create_directories
          :summary:
   * - :py:obj:`config_section_to_cover <mnp.utils.config_section_to_cover>`
     - .. autodoc2-docstring:: mnp.utils.config_section_to_cover
          :summary:
   * - :py:obj:`add_dynamics_to_config <mnp.utils.add_dynamics_to_config>`
     - .. autodoc2-docstring:: mnp.utils.add_dynamics_to_config
          :summary:
   * - :py:obj:`list_sources_destinations <mnp.utils.list_sources_destinations>`
     - .. autodoc2-docstring:: mnp.utils.list_sources_destinations
          :summary:
   * - :py:obj:`copy_input_file <mnp.utils.copy_input_file>`
     - .. autodoc2-docstring:: mnp.utils.copy_input_file
          :summary:
   * - :py:obj:`geo_profile_from_hsi <mnp.utils.geo_profile_from_hsi>`
     - .. autodoc2-docstring:: mnp.utils.geo_profile_from_hsi
          :summary:

Data
~~~~

.. list-table::
   :class: autosummary longtable
   :align: left

   * - :py:obj:`LOG_FILE_NAME <mnp.utils.LOG_FILE_NAME>`
     - .. autodoc2-docstring:: mnp.utils.LOG_FILE_NAME
          :summary:
   * - :py:obj:`TEMP_DIR <mnp.utils.TEMP_DIR>`
     - .. autodoc2-docstring:: mnp.utils.TEMP_DIR
          :summary:

API
~~~

.. py:data:: LOG_FILE_NAME
   :canonical: mnp.utils.LOG_FILE_NAME
   :value: 'log_file.txt'

   .. autodoc2-docstring:: mnp.utils.LOG_FILE_NAME

.. py:data:: TEMP_DIR
   :canonical: mnp.utils.TEMP_DIR
   :value: 'mkdtemp(...)'

   .. autodoc2-docstring:: mnp.utils.TEMP_DIR

.. py:class:: List()
   :canonical: mnp.utils.List

   Bases: :py:obj:`list`

   .. autodoc2-docstring:: mnp.utils.List

   .. rubric:: Initialization

   .. autodoc2-docstring:: mnp.utils.List.__init__

.. py:class:: CustomFormatter(fmt=None, datefmt=None, style='%', validate=True, *, defaults=None)
   :canonical: mnp.utils.CustomFormatter

   Bases: :py:obj:`logging.Formatter`

   .. autodoc2-docstring:: mnp.utils.CustomFormatter

   .. rubric:: Initialization

   .. autodoc2-docstring:: mnp.utils.CustomFormatter.__init__

   .. py:attribute:: grey
      :canonical: mnp.utils.CustomFormatter.grey
      :value: '\x1b[38;20m'

      .. autodoc2-docstring:: mnp.utils.CustomFormatter.grey

   .. py:attribute:: yellow
      :canonical: mnp.utils.CustomFormatter.yellow
      :value: '\x1b[38;5;214m'

      .. autodoc2-docstring:: mnp.utils.CustomFormatter.yellow

   .. py:attribute:: red
      :canonical: mnp.utils.CustomFormatter.red
      :value: '\x1b[31;20m'

      .. autodoc2-docstring:: mnp.utils.CustomFormatter.red

   .. py:attribute:: bold_red
      :canonical: mnp.utils.CustomFormatter.bold_red
      :value: '\x1b[31;1m'

      .. autodoc2-docstring:: mnp.utils.CustomFormatter.bold_red

   .. py:attribute:: cyan
      :canonical: mnp.utils.CustomFormatter.cyan
      :value: '\x1b[38;5;33m'

      .. autodoc2-docstring:: mnp.utils.CustomFormatter.cyan

   .. py:attribute:: reset
      :canonical: mnp.utils.CustomFormatter.reset
      :value: '\x1b[0m'

      .. autodoc2-docstring:: mnp.utils.CustomFormatter.reset

   .. py:attribute:: time
      :canonical: mnp.utils.CustomFormatter.time
      :value: '%(asctime)s'

      .. autodoc2-docstring:: mnp.utils.CustomFormatter.time

   .. py:attribute:: levelname
      :canonical: mnp.utils.CustomFormatter.levelname
      :value: '%(levelname)s'

      .. autodoc2-docstring:: mnp.utils.CustomFormatter.levelname

   .. py:attribute:: funcname
      :canonical: mnp.utils.CustomFormatter.funcname
      :value: '%(funcName)s'

      .. autodoc2-docstring:: mnp.utils.CustomFormatter.funcname

   .. py:attribute:: message
      :canonical: mnp.utils.CustomFormatter.message
      :value: '%(message)s'

      .. autodoc2-docstring:: mnp.utils.CustomFormatter.message

   .. py:attribute:: FORMATS
      :canonical: mnp.utils.CustomFormatter.FORMATS
      :value: None

      .. autodoc2-docstring:: mnp.utils.CustomFormatter.FORMATS

   .. py:method:: format(record)
      :canonical: mnp.utils.CustomFormatter.format

.. py:function:: get_logger()
   :canonical: mnp.utils.get_logger

   .. autodoc2-docstring:: mnp.utils.get_logger

.. py:function:: log_start_completed(func)
   :canonical: mnp.utils.log_start_completed

   .. autodoc2-docstring:: mnp.utils.log_start_completed

.. py:function:: log_file_to_cover(folders: dict)
   :canonical: mnp.utils.log_file_to_cover

   .. autodoc2-docstring:: mnp.utils.log_file_to_cover

.. py:function:: clear_temp()
   :canonical: mnp.utils.clear_temp

   .. autodoc2-docstring:: mnp.utils.clear_temp

.. py:function:: slugify(value, allow_unicode=False)
   :canonical: mnp.utils.slugify

   .. autodoc2-docstring:: mnp.utils.slugify

.. py:function:: config_info_to_temp(configuration: configparser.ConfigParser, section: str, key: str, dest: str) -> bool
   :canonical: mnp.utils.config_info_to_temp

   .. autodoc2-docstring:: mnp.utils.config_info_to_temp

.. py:function:: create_directories(folders: dict) -> None
   :canonical: mnp.utils.create_directories

   .. autodoc2-docstring:: mnp.utils.create_directories

.. py:function:: config_section_to_cover(configuration: configparser.ConfigParser, section: str, cover_dir: str)
   :canonical: mnp.utils.config_section_to_cover

   .. autodoc2-docstring:: mnp.utils.config_section_to_cover

.. py:function:: add_dynamics_to_config(configuration: configparser.ConfigParser)
   :canonical: mnp.utils.add_dynamics_to_config

   .. autodoc2-docstring:: mnp.utils.add_dynamics_to_config

.. py:function:: list_sources_destinations(input_pathway, folders: dict, configuration: configparser.ConfigParser) -> tuple
   :canonical: mnp.utils.list_sources_destinations

   .. autodoc2-docstring:: mnp.utils.list_sources_destinations

.. py:function:: copy_input_file(source: str, destination: str)
   :canonical: mnp.utils.copy_input_file

   .. autodoc2-docstring:: mnp.utils.copy_input_file

.. py:function:: geo_profile_from_hsi(folders: dict)
   :canonical: mnp.utils.geo_profile_from_hsi

   .. autodoc2-docstring:: mnp.utils.geo_profile_from_hsi