:py:mod:`mnp.preparation.io_pathways`
=====================================

.. py:module:: mnp.preparation.io_pathways

.. autodoc2-docstring:: mnp.preparation.io_pathways
   :allowtitles:

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

Classes
~~~~~~~

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

   * - :py:obj:`VerificationProcedure <mnp.preparation.io_pathways.VerificationProcedure>`
     -
   * - :py:obj:`VerifyMetadataComment <mnp.preparation.io_pathways.VerifyMetadataComment>`
     - .. autodoc2-docstring:: mnp.preparation.io_pathways.VerifyMetadataComment
          :summary:
   * - :py:obj:`VerifyTable <mnp.preparation.io_pathways.VerifyTable>`
     - .. autodoc2-docstring:: mnp.preparation.io_pathways.VerifyTable
          :summary:
   * - :py:obj:`VerifyEnvironmentalTable <mnp.preparation.io_pathways.VerifyEnvironmentalTable>`
     - .. autodoc2-docstring:: mnp.preparation.io_pathways.VerifyEnvironmentalTable
          :summary:
   * - :py:obj:`VerifyLandTypeDirectory <mnp.preparation.io_pathways.VerifyLandTypeDirectory>`
     - .. autodoc2-docstring:: mnp.preparation.io_pathways.VerifyLandTypeDirectory
          :summary:
   * - :py:obj:`VerifyHSIFromDisk <mnp.preparation.io_pathways.VerifyHSIFromDisk>`
     - .. autodoc2-docstring:: mnp.preparation.io_pathways.VerifyHSIFromDisk
          :summary:
   * - :py:obj:`VerifyParameters <mnp.preparation.io_pathways.VerifyParameters>`
     - .. autodoc2-docstring:: mnp.preparation.io_pathways.VerifyParameters
          :summary:
   * - :py:obj:`VerifySpeciesTraits <mnp.preparation.io_pathways.VerifySpeciesTraits>`
     - .. autodoc2-docstring:: mnp.preparation.io_pathways.VerifySpeciesTraits
          :summary:
   * - :py:obj:`VerifyIsGeospatialRasterAndResolution <mnp.preparation.io_pathways.VerifyIsGeospatialRasterAndResolution>`
     - .. autodoc2-docstring:: mnp.preparation.io_pathways.VerifyIsGeospatialRasterAndResolution
          :summary:
   * - :py:obj:`VerifyRasterBounds <mnp.preparation.io_pathways.VerifyRasterBounds>`
     - .. autodoc2-docstring:: mnp.preparation.io_pathways.VerifyRasterBounds
          :summary:
   * - :py:obj:`VerifyRasterAndGeospatialProfileBounds <mnp.preparation.io_pathways.VerifyRasterAndGeospatialProfileBounds>`
     - .. autodoc2-docstring:: mnp.preparation.io_pathways.VerifyRasterAndGeospatialProfileBounds
          :summary:
   * - :py:obj:`ErrorMessage <mnp.preparation.io_pathways.ErrorMessage>`
     -
   * - :py:obj:`VerifySpeciesSubselection <mnp.preparation.io_pathways.VerifySpeciesSubselection>`
     - .. autodoc2-docstring:: mnp.preparation.io_pathways.VerifySpeciesSubselection
          :summary:
   * - :py:obj:`VerifyHasEnvironmentalFactors <mnp.preparation.io_pathways.VerifyHasEnvironmentalFactors>`
     -
   * - :py:obj:`InputPathway <mnp.preparation.io_pathways.InputPathway>`
     - .. autodoc2-docstring:: mnp.preparation.io_pathways.InputPathway
          :summary:
   * - :py:obj:`OutputPathway <mnp.preparation.io_pathways.OutputPathway>`
     - .. autodoc2-docstring:: mnp.preparation.io_pathways.OutputPathway
          :summary:

Functions
~~~~~~~~~

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

   * - :py:obj:`verify_user_input <mnp.preparation.io_pathways.verify_user_input>`
     - .. autodoc2-docstring:: mnp.preparation.io_pathways.verify_user_input
          :summary:

API
~~~

.. py:class:: VerificationProcedure()
   :canonical: mnp.preparation.io_pathways.VerificationProcedure

   Bases: :py:obj:`abc.ABC`

   .. py:method:: update_status()
      :canonical: mnp.preparation.io_pathways.VerificationProcedure.update_status

      .. autodoc2-docstring:: mnp.preparation.io_pathways.VerificationProcedure.update_status

.. py:class:: VerifyMetadataComment(configuration: configparser.ConfigParser)
   :canonical: mnp.preparation.io_pathways.VerifyMetadataComment

   Bases: :py:obj:`mnp.preparation.io_pathways.VerificationProcedure`

   .. autodoc2-docstring:: mnp.preparation.io_pathways.VerifyMetadataComment

   .. rubric:: Initialization

   .. autodoc2-docstring:: mnp.preparation.io_pathways.VerifyMetadataComment.__init__

.. py:class:: VerifyTable(table_path: str, table_type: str)
   :canonical: mnp.preparation.io_pathways.VerifyTable

   Bases: :py:obj:`mnp.preparation.io_pathways.VerificationProcedure`

   .. autodoc2-docstring:: mnp.preparation.io_pathways.VerifyTable

   .. rubric:: Initialization

   .. autodoc2-docstring:: mnp.preparation.io_pathways.VerifyTable.__init__

.. py:class:: VerifyEnvironmentalTable(configuration: configparser.ConfigParser, environmental_section: str)
   :canonical: mnp.preparation.io_pathways.VerifyEnvironmentalTable

   Bases: :py:obj:`mnp.preparation.io_pathways.VerifyTable`

   .. autodoc2-docstring:: mnp.preparation.io_pathways.VerifyEnvironmentalTable

   .. rubric:: Initialization

   .. autodoc2-docstring:: mnp.preparation.io_pathways.VerifyEnvironmentalTable.__init__

.. py:class:: VerifyLandTypeDirectory(configuration: configparser.ConfigParser)
   :canonical: mnp.preparation.io_pathways.VerifyLandTypeDirectory

   Bases: :py:obj:`mnp.preparation.io_pathways.VerificationProcedure`

   .. autodoc2-docstring:: mnp.preparation.io_pathways.VerifyLandTypeDirectory

   .. rubric:: Initialization

   .. autodoc2-docstring:: mnp.preparation.io_pathways.VerifyLandTypeDirectory.__init__

.. py:class:: VerifyHSIFromDisk(configuration: configparser.ConfigParser)
   :canonical: mnp.preparation.io_pathways.VerifyHSIFromDisk

   Bases: :py:obj:`mnp.preparation.io_pathways.VerificationProcedure`

   .. autodoc2-docstring:: mnp.preparation.io_pathways.VerifyHSIFromDisk

   .. rubric:: Initialization

   .. autodoc2-docstring:: mnp.preparation.io_pathways.VerifyHSIFromDisk.__init__

.. py:class:: VerifyParameters(configuration: configparser.ConfigParser)
   :canonical: mnp.preparation.io_pathways.VerifyParameters

   Bases: :py:obj:`mnp.preparation.io_pathways.VerificationProcedure`

   .. autodoc2-docstring:: mnp.preparation.io_pathways.VerifyParameters

   .. rubric:: Initialization

   .. autodoc2-docstring:: mnp.preparation.io_pathways.VerifyParameters.__init__

.. py:class:: VerifySpeciesTraits(configuration: configparser.ConfigParser, target_resolution: int)
   :canonical: mnp.preparation.io_pathways.VerifySpeciesTraits

   Bases: :py:obj:`mnp.preparation.io_pathways.VerificationProcedure`

   .. autodoc2-docstring:: mnp.preparation.io_pathways.VerifySpeciesTraits

   .. rubric:: Initialization

   .. autodoc2-docstring:: mnp.preparation.io_pathways.VerifySpeciesTraits.__init__

.. py:class:: VerifyIsGeospatialRasterAndResolution(raster_path: str, target_resolution: int)
   :canonical: mnp.preparation.io_pathways.VerifyIsGeospatialRasterAndResolution

   Bases: :py:obj:`mnp.preparation.io_pathways.VerificationProcedure`

   .. autodoc2-docstring:: mnp.preparation.io_pathways.VerifyIsGeospatialRasterAndResolution

   .. rubric:: Initialization

   .. autodoc2-docstring:: mnp.preparation.io_pathways.VerifyIsGeospatialRasterAndResolution.__init__

.. py:class:: VerifyRasterBounds(*args: str or list)
   :canonical: mnp.preparation.io_pathways.VerifyRasterBounds

   Bases: :py:obj:`mnp.preparation.io_pathways.VerificationProcedure`

   .. autodoc2-docstring:: mnp.preparation.io_pathways.VerifyRasterBounds

   .. rubric:: Initialization

   .. autodoc2-docstring:: mnp.preparation.io_pathways.VerifyRasterBounds.__init__

.. py:class:: VerifyRasterAndGeospatialProfileBounds(geospatial_profile_path: str, raster_path: str)
   :canonical: mnp.preparation.io_pathways.VerifyRasterAndGeospatialProfileBounds

   Bases: :py:obj:`mnp.preparation.io_pathways.VerificationProcedure`

   .. autodoc2-docstring:: mnp.preparation.io_pathways.VerifyRasterAndGeospatialProfileBounds

   .. rubric:: Initialization

   .. autodoc2-docstring:: mnp.preparation.io_pathways.VerifyRasterAndGeospatialProfileBounds.__init__

.. py:class:: ErrorMessage(message: str)
   :canonical: mnp.preparation.io_pathways.ErrorMessage

   Bases: :py:obj:`mnp.preparation.io_pathways.VerificationProcedure`

.. py:class:: VerifySpeciesSubselection(configuration: configparser.ConfigParser)
   :canonical: mnp.preparation.io_pathways.VerifySpeciesSubselection

   Bases: :py:obj:`mnp.preparation.io_pathways.VerificationProcedure`

   .. autodoc2-docstring:: mnp.preparation.io_pathways.VerifySpeciesSubselection

   .. rubric:: Initialization

   .. autodoc2-docstring:: mnp.preparation.io_pathways.VerifySpeciesSubselection.__init__

.. py:class:: VerifyHasEnvironmentalFactors(has_environmentals: bool)
   :canonical: mnp.preparation.io_pathways.VerifyHasEnvironmentalFactors

   Bases: :py:obj:`mnp.preparation.io_pathways.VerificationProcedure`

.. py:class:: InputPathway()
   :canonical: mnp.preparation.io_pathways.InputPathway

   .. autodoc2-docstring:: mnp.preparation.io_pathways.InputPathway

   .. rubric:: Initialization

   .. autodoc2-docstring:: mnp.preparation.io_pathways.InputPathway.__init__

   .. py:method:: identify(configuration: configparser.ConfigParser)
      :canonical: mnp.preparation.io_pathways.InputPathway.identify

      .. autodoc2-docstring:: mnp.preparation.io_pathways.InputPathway.identify

   .. py:method:: verify()
      :canonical: mnp.preparation.io_pathways.InputPathway.verify

      .. autodoc2-docstring:: mnp.preparation.io_pathways.InputPathway.verify

   .. py:method:: log_messages()
      :canonical: mnp.preparation.io_pathways.InputPathway.log_messages

      .. autodoc2-docstring:: mnp.preparation.io_pathways.InputPathway.log_messages

.. py:class:: OutputPathway(configuration: configparser.ConfigParser)
   :canonical: mnp.preparation.io_pathways.OutputPathway

   .. autodoc2-docstring:: mnp.preparation.io_pathways.OutputPathway

   .. rubric:: Initialization

   .. autodoc2-docstring:: mnp.preparation.io_pathways.OutputPathway.__init__

.. py:function:: verify_user_input(configuration: configparser.ConfigParser)
   :canonical: mnp.preparation.io_pathways.verify_user_input

   .. autodoc2-docstring:: mnp.preparation.io_pathways.verify_user_input