.. module:: discrimintools

****************************
discrimintools documentation
****************************

**Date**: |today| **Version**: |release|

**Useful links**:
`Binary Installers <https://pypi.org/project/discrimintools/>`_ |
`Source Repository <https://github.com/enfantbenidedieu/discrimintools>`_ |
`Issues & Ideas <https://github.com/enfantbenidedieu/discrimintools/issues>`_ |

**Others packages**:
`scientisttools <https://pypi.org/project/scientisttools/>`_ | 
`scientistmetrics <https://pypi.org/project/scientistmetrics/>`_ | 
`scientistshiny <https://pypi.org/project/scientistshiny/>`_ |
`scientisttseries <https://pypi.org/project/scientistshiny/>`_ |
`ggcorrplot <https://pypi.org/project/ggcorrplot/>`_ |

`discrimintools <https://github.com/enfantbenidedieu/discrimintools>`_ is an open source `Python <https://www.python.org/>`_ library dedicated to Discriminant Analysis (DA) distributed under 
the MIT Licence. 

.. grid:: 1 2 2 2
    :gutter: 4
    :padding: 2 2 0 0
    :class-container: sd-text-center

    .. grid-item-card:: install
        :class-card: intro-card
        :shadow: md
        :width: 100%

        New to *discrimintools*? Check out the install guide.

        +++

        .. button-ref:: install
            :ref-type: ref
            :click-parent:
            :color: secondary
            :expand:

            To the install guides

    .. grid-item-card:: Getting started
        :class-card: intro-card
        :shadow: md

        Check out the getting started guide.

        +++

        .. button-ref:: getting_started
            :ref-type: ref
            :click-parent:
            :color: secondary
            :expand:

            To the getting started guide

    .. grid-item-card::  User guide
        :class-card: intro-card
        :shadow: md

        The user guide provides information on the key concepts of discrimintools.

        +++

        .. button-ref:: user_guide
            :ref-type: ref
            :click-parent:
            :color: secondary
            :expand:

            To the user guide

    .. grid-item-card::  API reference
        :class-card: intro-card
        :shadow: md

        The reference describes how the methods work and which parameters can be used.

        +++

        .. button-ref:: api
            :ref-type: ref
            :click-parent:
            :color: secondary
            :expand:

            To the reference guide

    .. grid-item-card::  About Us
        :class-card: intro-card
        :shadow: md

        Contact Us.

        +++

        .. button-ref:: about_us
            :ref-type: ref
            :click-parent:
            :color: secondary
            :expand:

            To the about us guide

    .. grid-item-card::  Citing discrimintools
        :class-card: intro-card
        :shadow: md

        Citing discrimintools.

        +++

        .. button-ref:: citing_discrimintools
            :ref-type: ref
            :click-parent:
            :color: secondary
            :expand:

            To the citing discrimintools guide

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

    source/install/index
    source/getting_started/index
    source/user_guide/index
    source/reference/index
    source/examples/index