HAMLET (Hierarchical Agent-based Markets for Local Energy Trading)
==================================================================

Welcome to HAMLET (Hierarchical Agent-based Markets for Local Energy Trading), an agent-based energy system simulation tool!
It is designed to support energy experts in researching various aspects of the energy system.
This guide will help you get up and running quickly.

.. toctree::
   :maxdepth: 1
   :caption: Getting Started

   getting_started/getting_started
   getting_started/installation
   getting_started/usage
   getting_started/examples

.. toctree::
   :maxdepth: 1
   :caption: Core Concepts

   core_concepts/overview
   core_concepts/architecture
   core_concepts/design_principles

.. toctree::
   :maxdepth: 1
   :caption: Core Components

   core_components/overview
   core_components/creator/overview
   core_components/executor/overview
   core_components/analyzer/overview

.. toctree::
   :maxdepth: 1
   :caption: Advanced Topics

   advanced_topics/configuration_guide
   advanced_topics/models/overview
.. advanced_topics/api/overview

.. toctree::
   :maxdepth: 1
   :caption: Community & Support

   community_support/contributing
   community_support/changelog
   community_support/about