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

.. py:module:: mnp.preparation.input_verification_functions

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

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

Functions
~~~~~~~~~

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

   * - :py:obj:`is_geospatial_raster <mnp.preparation.input_verification_functions.is_geospatial_raster>`
     - .. autodoc2-docstring:: mnp.preparation.input_verification_functions.is_geospatial_raster
          :summary:
   * - :py:obj:`path_exists <mnp.preparation.input_verification_functions.path_exists>`
     - .. autodoc2-docstring:: mnp.preparation.input_verification_functions.path_exists
          :summary:
   * - :py:obj:`raster_has_resolution <mnp.preparation.input_verification_functions.raster_has_resolution>`
     - .. autodoc2-docstring:: mnp.preparation.input_verification_functions.raster_has_resolution
          :summary:
   * - :py:obj:`is_directory <mnp.preparation.input_verification_functions.is_directory>`
     - .. autodoc2-docstring:: mnp.preparation.input_verification_functions.is_directory
          :summary:
   * - :py:obj:`directory_contains <mnp.preparation.input_verification_functions.directory_contains>`
     - .. autodoc2-docstring:: mnp.preparation.input_verification_functions.directory_contains
          :summary:
   * - :py:obj:`rasters_have_identical_bounds <mnp.preparation.input_verification_functions.rasters_have_identical_bounds>`
     - .. autodoc2-docstring:: mnp.preparation.input_verification_functions.rasters_have_identical_bounds
          :summary:
   * - :py:obj:`verify_parameters <mnp.preparation.input_verification_functions.verify_parameters>`
     - .. autodoc2-docstring:: mnp.preparation.input_verification_functions.verify_parameters
          :summary:
   * - :py:obj:`csv_is_readable <mnp.preparation.input_verification_functions.csv_is_readable>`
     - .. autodoc2-docstring:: mnp.preparation.input_verification_functions.csv_is_readable
          :summary:
   * - :py:obj:`is_valid_csv <mnp.preparation.input_verification_functions.is_valid_csv>`
     - .. autodoc2-docstring:: mnp.preparation.input_verification_functions.is_valid_csv
          :summary:
   * - :py:obj:`occurs_in_formula <mnp.preparation.input_verification_functions.occurs_in_formula>`
     - .. autodoc2-docstring:: mnp.preparation.input_verification_functions.occurs_in_formula
          :summary:
   * - :py:obj:`verify_local_distance <mnp.preparation.input_verification_functions.verify_local_distance>`
     - .. autodoc2-docstring:: mnp.preparation.input_verification_functions.verify_local_distance
          :summary:

API
~~~

.. py:function:: is_geospatial_raster(file_path: str) -> (bool, str)
   :canonical: mnp.preparation.input_verification_functions.is_geospatial_raster

   .. autodoc2-docstring:: mnp.preparation.input_verification_functions.is_geospatial_raster

.. py:function:: path_exists(path)
   :canonical: mnp.preparation.input_verification_functions.path_exists

   .. autodoc2-docstring:: mnp.preparation.input_verification_functions.path_exists

.. py:function:: raster_has_resolution(file_path: str, target_resolution) -> (bool, str)
   :canonical: mnp.preparation.input_verification_functions.raster_has_resolution

   .. autodoc2-docstring:: mnp.preparation.input_verification_functions.raster_has_resolution

.. py:function:: is_directory(directory_path: str) -> (bool, str)
   :canonical: mnp.preparation.input_verification_functions.is_directory

   .. autodoc2-docstring:: mnp.preparation.input_verification_functions.is_directory

.. py:function:: directory_contains(directory_path: str, pattern: str, n) -> (bool, str)
   :canonical: mnp.preparation.input_verification_functions.directory_contains

   .. autodoc2-docstring:: mnp.preparation.input_verification_functions.directory_contains

.. py:function:: rasters_have_identical_bounds(rasters: list) -> (bool, str)
   :canonical: mnp.preparation.input_verification_functions.rasters_have_identical_bounds

   .. autodoc2-docstring:: mnp.preparation.input_verification_functions.rasters_have_identical_bounds

.. py:function:: verify_parameters(configuration: configparser.ConfigParser) -> (bool, str)
   :canonical: mnp.preparation.input_verification_functions.verify_parameters

   .. autodoc2-docstring:: mnp.preparation.input_verification_functions.verify_parameters

.. py:function:: csv_is_readable(file_path: str) -> bool
   :canonical: mnp.preparation.input_verification_functions.csv_is_readable

   .. autodoc2-docstring:: mnp.preparation.input_verification_functions.csv_is_readable

.. py:function:: is_valid_csv(file_path: str, table_type: str) -> (bool, str)
   :canonical: mnp.preparation.input_verification_functions.is_valid_csv

   .. autodoc2-docstring:: mnp.preparation.input_verification_functions.is_valid_csv

.. py:function:: occurs_in_formula(name: str, species_traits: str)
   :canonical: mnp.preparation.input_verification_functions.occurs_in_formula

   .. autodoc2-docstring:: mnp.preparation.input_verification_functions.occurs_in_formula

.. py:function:: verify_local_distance(species_traits: str, target_resolution: int)
   :canonical: mnp.preparation.input_verification_functions.verify_local_distance

   .. autodoc2-docstring:: mnp.preparation.input_verification_functions.verify_local_distance