Diversity
=========

The diversity module provides functions for calculating various diversity indices.

.. currentmodule:: nuee.diversity

General Diversity Function
---------------------------

.. autofunction:: diversity

Diversity Indices
-----------------

Shannon Diversity
~~~~~~~~~~~~~~~~~

.. autofunction:: shannon

Simpson Diversity
~~~~~~~~~~~~~~~~~

.. autofunction:: simpson

Fisher's Alpha
~~~~~~~~~~~~~~

.. autofunction:: fisher_alpha

Species Richness
~~~~~~~~~~~~~~~~

.. autofunction:: specnumber

Evenness
~~~~~~~~

.. autofunction:: evenness

Renyi Entropy
~~~~~~~~~~~~~

.. autofunction:: renyi

Rarefaction
-----------

.. autofunction:: rarefy

.. autofunction:: rarecurve

Base Classes
------------

.. autoclass:: DiversityResult
   :members:
   :undoc-members:
   :show-inheritance: