.. _homepage:

.. toctree::
   :maxdepth: 3
   :hidden:

   getting_started/first_steps
   user/introduction
   reference/api_reference
   developer/introduction
   release/summary

anomalearn documentation
========================

**Date**: Apr 20, 2023 **Version**: Pre-alpha 0.0.2

:ref:`anomalearn <homepage>` is an open source EUPL1.2-licensed library
providing modular and extensible tools for developing time series anomaly
detection models for the `Python <https://www.python.org/>`_ programming language.

.. grid:: 2
   :gutter: 5

   .. grid-item-card::
      :text-align: center
      :class-header: card-title

      Getting started
      ^^^

      New to *anomalearn*? Check out the getting started guides. They contain
      tutorials from installation to simple *anomalearn* concepts.

      +++
      .. button-ref:: getting_started
         :ref-type: ref
         :color: primary
         :align: center
         :click-parent:

         Go to getting started guides

   .. grid-item-card::
      :text-align: center
      :class-header: card-title

      User guide
      ^^^

      Want to know more? The user guides contain more detailed information on
      how to use *anomalearn*, going more in depth with respect to the getting
      started guides.

      +++
      .. button-ref:: user_guide
         :ref-type: ref
         :color: primary
         :align: center
         :click-parent:

         Go to user guides guides

.. grid:: 2
   :gutter: 5

   .. grid-item-card::
      :text-align: center
      :class-header: card-title

      API Reference
      ^^^

      The API reference contains very detailed information on the functions and
      classes of *anomalearn* by means of descriptions and detailed documentation
      for each function, class or constant. It assumes you have some
      understanding of *anomalearn*.

      +++
      .. button-ref:: api_reference
         :ref-type: ref
         :color: primary
         :align: center
         :click-parent:

         Go to the api reference

   .. grid-item-card::
      :text-align: center
      :class-header: card-title

      Developer guide
      ^^^

      Saw a bug and want to fix it? Want to improve documentation? Want to
      improve or extend *anomalearn*'s functionalities? The developer guidelines
      guide you through the process of contributing to *anomalearn*.

      +++
      .. button-ref:: developer_guides
         :ref-type: ref
         :color: primary
         :align: center
         :click-parent:

         Go to developer guides guides