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

.. py:module:: mnp.species_models.clustering

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

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

Classes
~~~~~~~

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

   * - :py:obj:`ClusteringProcedure <mnp.species_models.clustering.ClusteringProcedure>`
     - .. autodoc2-docstring:: mnp.species_models.clustering.ClusteringProcedure
          :summary:
   * - :py:obj:`ClusterLocal <mnp.species_models.clustering.ClusterLocal>`
     -
   * - :py:obj:`Clustering <mnp.species_models.clustering.Clustering>`
     - .. autodoc2-docstring:: mnp.species_models.clustering.Clustering
          :summary:

API
~~~

.. py:class:: ClusteringProcedure(geospatial_profile, output_path: str = '')
   :canonical: mnp.species_models.clustering.ClusteringProcedure

   Bases: :py:obj:`mnp.species_models.species_geo_map.SpeciesGeoMap`, :py:obj:`abc.ABC`

   .. autodoc2-docstring:: mnp.species_models.clustering.ClusteringProcedure

   .. rubric:: Initialization

   .. autodoc2-docstring:: mnp.species_models.clustering.ClusteringProcedure.__init__

   .. py:method:: run(hsi_array: scipy.sparse.csr_array)
      :canonical: mnp.species_models.clustering.ClusteringProcedure.run
      :abstractmethod:

      .. autodoc2-docstring:: mnp.species_models.clustering.ClusteringProcedure.run

.. py:class:: ClusterLocal(parameters: mnp.config.MNPParameters, species_code: str)
   :canonical: mnp.species_models.clustering.ClusterLocal

   Bases: :py:obj:`mnp.species_models.clustering.ClusteringProcedure`

   .. py:method:: run(hsi_array: scipy.sparse.csr_array)
      :canonical: mnp.species_models.clustering.ClusterLocal.run

      .. autodoc2-docstring:: mnp.species_models.clustering.ClusterLocal.run

.. py:class:: Clustering(parameters: mnp.config.MNPParameters, species_code: str)
   :canonical: mnp.species_models.clustering.Clustering

   .. autodoc2-docstring:: mnp.species_models.clustering.Clustering

   .. rubric:: Initialization

   .. autodoc2-docstring:: mnp.species_models.clustering.Clustering.__init__