.. _plugins:

Plugins
====================

API-24SEA provides a plugin system that allows users to extend its functionality
by adding new features. Plugins can be developed by anyone and can be easily
installed and managed using the Python namespace packages system.

Installation
------------

Currently, there are two plugins available:

* :ref:`fatigue extra <fatigue-extra-04>`: Adds cycle-count metrics analysis
  capabilities to the package by leveraging the `py-fatigue <https://owi-lab.github.io/py_fatigue/>`_
  and `swifter <https://github.com/jmcarpenter2/swifter>`_ packages.

  .. tab-set-code::

     .. code-block:: powershell

        pip install api-24sea[fatigue]

     .. code-block:: bash

        pip install 'api-24sea[fatigue]'

* `ai extra <https://api24seapydocs.z6.web.core.windows.net/ai/index.html>`_: Integrates AI
  functionalities into the package leveraging the 24SEA AI models API. The package
  can be installed from `PyPI <https://pypi.org/project/api-24sea-ai/>`_.

  .. tab-set-code::

     .. code-block:: powershell

        pip install api-24sea[ai]

     .. code-block:: bash

        pip install 'api-24sea[ai]'


To install both plugins, run the following command in your terminal:

.. tab-set-code::

   .. code-block:: powershell

      pip install api-24sea[fatigue,ai]

   .. code-block:: bash

      pip install 'api-24sea[fatigue,ai]'