.. Artelys Crystal Super Grid documentation master file, created on Thu Feb 08 15:00:00 2024.


Welcome to Artelys Crystal Super Grid’s Documentation!
======================================================

Purpose
-------
Unlock the full potential of your energy system models with **Artelys Crystal Super Grid**. This documentation provides
you with everything you need to analyze, understand, and optimize your simulations.

**Explore the key resources below to get started**


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

    .. grid-item-card::  Usages
        :img-top: _static/usages_logo.png
        :class-card: intro-card
        :shadow: md

        Follow the user guide to explore different usage scenarios.

        +++

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

            Explore Usage Examples

    .. grid-item-card::  Models documentation
        :img-top: _static/datasets_logo.png
        :class-card: intro-card
        :shadow: md

        Discover the assets and technologies available in the system.

        +++

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

            Go to Asset Documentation

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

        Dive into detailed Key Performance Indicators descriptions to assess your results.

        +++

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

            View KPI Documentation


Search the Documentation
------------------------

Use the search function below to quickly find what you're looking for.

* :ref:`search`


Additional Content
------------------

Check out the `Release Notes <release_note.md>`_ for details on recent updates.


Purpose of the Documentation
----------------------------

This documentation aims to:

- Provide step-by-step instructions to use the Artelys Crystal Super Grid's interface and tools.
- Explain the indicators and models available for analyzing simulation results.
- Offer use cases and real-world examples for better understanding.


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

   usage/index
   models/index
   kpis/index
   release_note

:Release: |release|