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

.. py:module:: mnp.preparation.select_valid_species

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

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

Functions
~~~~~~~~~

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

   * - :py:obj:`melt_boolean_dataframe <mnp.preparation.select_valid_species.melt_boolean_dataframe>`
     - .. autodoc2-docstring:: mnp.preparation.select_valid_species.melt_boolean_dataframe
          :summary:
   * - :py:obj:`get_valid_species <mnp.preparation.select_valid_species.get_valid_species>`
     - .. autodoc2-docstring:: mnp.preparation.select_valid_species.get_valid_species
          :summary:
   * - :py:obj:`get_valid_species_selections <mnp.preparation.select_valid_species.get_valid_species_selections>`
     - .. autodoc2-docstring:: mnp.preparation.select_valid_species.get_valid_species_selections
          :summary:

API
~~~

.. py:function:: melt_boolean_dataframe(df: pandas.DataFrame) -> str
   :canonical: mnp.preparation.select_valid_species.melt_boolean_dataframe

   .. autodoc2-docstring:: mnp.preparation.select_valid_species.melt_boolean_dataframe

.. py:function:: get_valid_species(hsi_from_disk: bool, parameters) -> set
   :canonical: mnp.preparation.select_valid_species.get_valid_species

   .. autodoc2-docstring:: mnp.preparation.select_valid_species.get_valid_species

.. py:function:: get_valid_species_selections(valid_species: set, parameters) -> typing.Dict[str, typing.List[str]]
   :canonical: mnp.preparation.select_valid_species.get_valid_species_selections

   .. autodoc2-docstring:: mnp.preparation.select_valid_species.get_valid_species_selections