.. _kpi_documentation:

KPIs documentation
****************************


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

    .. grid-item-card::  Temporal KPIs
        :img-top: ../_static/temporal_kpis_logo.png
        :class-card: intro-card
        :shadow: md

        Visualise all your optimization results as timeseries over your optimisation horizon

        +++

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

            To the temporal KPIS

    .. grid-item-card::  Scalar KPIs
        :img-top: ../_static/scalar_kpis_logo.png
        :class-card: intro-card
        :shadow: md

        Have an immediate insight of your optimization results with aggregated KPIs

        +++

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

            To the scalar KPIS

    .. grid-item-card::  Pathway KPIs
        :img-top: ../_static/pathway_kpis_logo.png
        :class-card: intro-card
        :shadow: md

        Visualise pathway-specific KPIs

        +++

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

            To the pathway KPIS

    .. grid-item-card::  Equation notations
        :img-top: ../_static/notations_logo.png
        :class-card: intro-card
        :shadow: md

        Get yourself familiar with the common conventions used in the KPI description equations

        +++

        .. button-ref:: notations
            :click-parent:
            :color: secondary
            :expand:

            To the notations description

.. toctree::
   :titlesonly:
   :hidden:

   scalar_kpis/index
   temporal_kpis/index
   pathway_kpis/index
   notations

:Release: |release|