iteraa
======

.. py:module:: iteraa

.. autoapi-nested-parse::

   The IterAA Package
   =====================
   Descriptions

   Features
   --------
   Provides
     1. Plotting functionalities to visualise output.

   Documentations
   --------------
   Documentation is available in two forms: docstrings provided with the code,
   and a loose standing reference guide, available from
   `the IterAA homepage <https://iteraa.readthedocs.io/en/latest/>`_.

   Code snippets in docstrings are indicated by three greater-than signs::

     >>> x = 42
     >>> x = x + 1

   Use the built-in ``help`` function to view a function's docstring::

     >>> import iteraa
     >>> help(iteraa.ArchetypalAnalysis)
     ... # docstring: +SKIP

   Utilities
   ---------
   test (To be implemented)
       Run IterAA tests.
   __version__
       Return IterAA version string.



Submodules
----------

.. toctree::
   :maxdepth: 1

   /autoapi/iteraa/constants/index
   /autoapi/iteraa/datasets/index
   /autoapi/iteraa/iaa/index
   /autoapi/iteraa/piaa/index
   /autoapi/iteraa/plot/index
   /autoapi/iteraa/runAA/index
   /autoapi/iteraa/utils/index