:py:mod:`mnp.species_models.species_model`
==========================================

.. py:module:: mnp.species_models.species_model

.. autodoc2-docstring:: mnp.species_models.species_model
   :allowtitles:

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

Classes
~~~~~~~

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

   * - :py:obj:`SpeciesModel <mnp.species_models.species_model.SpeciesModel>`
     - .. autodoc2-docstring:: mnp.species_models.species_model.SpeciesModel
          :summary:

Functions
~~~~~~~~~

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

   * - :py:obj:`run_species <mnp.species_models.species_model.run_species>`
     - .. autodoc2-docstring:: mnp.species_models.species_model.run_species
          :summary:
   * - :py:obj:`run_species_models <mnp.species_models.species_model.run_species_models>`
     - .. autodoc2-docstring:: mnp.species_models.species_model.run_species_models
          :summary:

API
~~~

.. py:class:: SpeciesModel(species_code: str, parameters: mnp.config.MNPParameters)
   :canonical: mnp.species_models.species_model.SpeciesModel

   .. autodoc2-docstring:: mnp.species_models.species_model.SpeciesModel

   .. rubric:: Initialization

   .. autodoc2-docstring:: mnp.species_models.species_model.SpeciesModel.__init__

   .. py:method:: name_info() -> dict[str, str]
      :canonical: mnp.species_models.species_model.SpeciesModel.name_info

      .. autodoc2-docstring:: mnp.species_models.species_model.SpeciesModel.name_info

   .. py:method:: trait_info() -> dict[str, float]
      :canonical: mnp.species_models.species_model.SpeciesModel.trait_info

      .. autodoc2-docstring:: mnp.species_models.species_model.SpeciesModel.trait_info

   .. py:method:: run_hsi(land_types: dict or None, environmentals: dict or None) -> None
      :canonical: mnp.species_models.species_model.SpeciesModel.run_hsi

      .. autodoc2-docstring:: mnp.species_models.species_model.SpeciesModel.run_hsi

   .. py:method:: get_populations_array(*args, **kwargs) -> csr_array or int
      :canonical: mnp.species_models.species_model.SpeciesModel.get_populations_array

      .. autodoc2-docstring:: mnp.species_models.species_model.SpeciesModel.get_populations_array

   .. py:method:: run_clustering() -> None
      :canonical: mnp.species_models.species_model.SpeciesModel.run_clustering

      .. autodoc2-docstring:: mnp.species_models.species_model.SpeciesModel.run_clustering

   .. py:method:: run_evaluation() -> None
      :canonical: mnp.species_models.species_model.SpeciesModel.run_evaluation

      .. autodoc2-docstring:: mnp.species_models.species_model.SpeciesModel.run_evaluation

   .. py:method:: evaluation_results() -> dict
      :canonical: mnp.species_models.species_model.SpeciesModel.evaluation_results

      .. autodoc2-docstring:: mnp.species_models.species_model.SpeciesModel.evaluation_results

   .. py:method:: log_messages()
      :canonical: mnp.species_models.species_model.SpeciesModel.log_messages

      .. autodoc2-docstring:: mnp.species_models.species_model.SpeciesModel.log_messages

.. py:function:: run_species(species_model: mnp.species_models.species_model.SpeciesModel, land_types: dict or None, environmentals: dict or None)
   :canonical: mnp.species_models.species_model.run_species

   .. autodoc2-docstring:: mnp.species_models.species_model.run_species

.. py:function:: run_species_models(species_models: list[mnp.species_models.species_model.SpeciesModel], land_types: dict or None, environmentals: dict or None)
   :canonical: mnp.species_models.species_model.run_species_models

   .. autodoc2-docstring:: mnp.species_models.species_model.run_species_models