:py:mod:`mnp.MNP`
=================

.. py:module:: mnp.MNP

.. autodoc2-docstring:: mnp.MNP
   :allowtitles:

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

Functions
~~~~~~~~~

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

   * - :py:obj:`prepare_input <mnp.MNP.prepare_input>`
     - .. autodoc2-docstring:: mnp.MNP.prepare_input
          :summary:
   * - :py:obj:`evaluate_models <mnp.MNP.evaluate_models>`
     - .. autodoc2-docstring:: mnp.MNP.evaluate_models
          :summary:
   * - :py:obj:`run_and_evaluate <mnp.MNP.run_and_evaluate>`
     - .. autodoc2-docstring:: mnp.MNP.run_and_evaluate
          :summary:
   * - :py:obj:`save_config_and_log <mnp.MNP.save_config_and_log>`
     - .. autodoc2-docstring:: mnp.MNP.save_config_and_log
          :summary:
   * - :py:obj:`mnp <mnp.MNP.mnp>`
     - .. autodoc2-docstring:: mnp.MNP.mnp
          :summary:

Data
~~~~

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

   * - :py:obj:`DATA_COVERAGE_TIF <mnp.MNP.DATA_COVERAGE_TIF>`
     - .. autodoc2-docstring:: mnp.MNP.DATA_COVERAGE_TIF
          :summary:

API
~~~

.. py:data:: DATA_COVERAGE_TIF
   :canonical: mnp.MNP.DATA_COVERAGE_TIF
   :value: 'spatial_data_coverage.tif'

   .. autodoc2-docstring:: mnp.MNP.DATA_COVERAGE_TIF

.. py:function:: prepare_input(parameters: mnp.config.MNPParameters, input_pathway: mnp.preparation.io_pathways.InputPathway) -> (dict[str, scipy.sparse.sparray] | None, dict[str, scipy.sparse.sparray] | None, dict[str, scipy.sparse.sparray] | None, set)
   :canonical: mnp.MNP.prepare_input

   .. autodoc2-docstring:: mnp.MNP.prepare_input

.. py:function:: evaluate_models(output_pathway: mnp.preparation.io_pathways.OutputPathway, parameters: mnp.config.MNPParameters, species_models: weakref.ReferenceType, land_types: dict[str, scipy.sparse.sparray])
   :canonical: mnp.MNP.evaluate_models

   .. autodoc2-docstring:: mnp.MNP.evaluate_models

.. py:function:: run_and_evaluate(land_types: dict[str, scipy.sparse.sparray] | None, environmentals: dict[str, scipy.sparse.sparray] | None, parameters: mnp.config.MNPParameters, output_pathway: mnp.preparation.io_pathways.OutputPathway) -> (list[mnp.species_models.species_model.SpeciesModel], dict[list[str:SpeciesModel]] or None)
   :canonical: mnp.MNP.run_and_evaluate

   .. autodoc2-docstring:: mnp.MNP.run_and_evaluate

.. py:function:: save_config_and_log(parameters: mnp.config.MNPParameters, config: configparser.ConfigParser)
   :canonical: mnp.MNP.save_config_and_log

   .. autodoc2-docstring:: mnp.MNP.save_config_and_log

.. py:function:: mnp(config: configparser.ConfigParser)
   :canonical: mnp.MNP.mnp

   .. autodoc2-docstring:: mnp.MNP.mnp