API

HAMLET provides a well-structured API that allows users to interact with its core components programmatically. This section introduces the API, how it is structured, and how users can navigate the documentation.

API Structure

The HAMLET API is divided into the following categories:

  • Creator API: Classes and functions related to setting up agents, markets, and grids.

  • Executor API: Components responsible for executing simulations and managing data flows, including utility functions for forecasting, database access, trading strategies, and grid management.

  • Analyzer API: Tools for analyzing, visualizing, and extracting insights from simulation results.

How to Use the API

Users can interact with HAMLET by importing the relevant modules in Python scripts. Here are some common use cases:

  • Creating a new simulation scenario:

    from hamlet.creator import Creator

creator = Creator(path="./configs", name="example_scenario")
creator.new_scenario_from_configs()

  • Running a simulation:

    from hamlet.executor import Executor

executor = Executor(path_scenario="./scenarios/example_scenario")
executor.run()

  • Analyzing results:

    from hamlet.analyzer import ScenarioAnalyzer

analyzer = ScenarioAnalyzer(path_results="./results/example_scenario")
analyzer.plot_virtual_feeder_flow()

Generating the API Documentation

HAMLET’s API documentation is automatically generated using Sphinx and the autodoc extension.

To update the API documentation, navigate to the docs folder and run:

sphinx-apidoc -o source/api ../hamlet --force
make html

The updated documentation can be found in docs/build/html/index.html.