energy_analysis_toolbox documentation
=====================================

**Date**: |today|

**Version**: |version|

``energy_analysis_toolbox`` is an open source library providing a set of tools to process energy and power pandas time-series for the Python programming language.

Originally developed by the R&D team of `Eco CO2 <https://www.ecoco2.com>`_, it was released in open source in October, 2024.


.. grid:: 1 2 2 2
    :class-container: sd-text-center sd-d-inline-flex

    .. grid-item-card:: Getting started
        :img-top: ./_static/index_getting_started.svg

        New to |eat|? Check out the getting started guides.

        .. button-ref:: getting_started/index
            :expand:
            :color: primary
            :click-parent:
            :outline:

            Get started

    .. grid-item-card:: User guide
        :img-top: ./_static/index_user_guide.svg

        The user guide provides in-depth information on the
        key concepts of pandas with useful background information and explanation.

        .. button-ref:: user_guide/index
            :expand:
            :color: primary
            :click-parent:
            :outline:

            To the user guide

    .. grid-item-card:: API reference
        :img-top: ./_static/index_api.svg


        The reference guide contains a detailed description of
        the |eat| API. The reference describes how the methods work and which parameters can
        be used. It assumes that you have an understanding of the key concepts.

        .. button-ref:: sources/index
            :expand:
            :color: primary
            :click-parent:
            :outline:

            To the reference guide

    .. grid-item-card:: Developer guide
        :img-top: ./_static/index_contribute.svg


        Saw a typo in the documentation? Want to improve
        existing functionalities? The contributing guidelines will guide
        you through the process of improving |eat|.

        .. button-ref:: developer_guide/index
            :expand:
            :color: primary
            :click-parent:
            :outline:

            To the contributor's guide



.. toctree::
   :maxdepth: 1
   :hidden:
   :caption: Contents:

   getting_started/index
   user_guide/index
   sources/index
   developer_guide/index
   whatsnew/index