Inheritance diagram for ark_env.ArkEnv:

Detailed Description

ArkEnv base class.

This environment integrates the Noah system with the :mod:gymnasium API. It handles action publishing, observation retrieval and exposes helper utilities for resetting parts of the system. Sub‑classes are expected to implement the packing/unpacking logic for messages as well as the reward and termination functions.

Parameters

environment_name	Name of the environment (also the node name). @type environment_name str
action_channels	Channels on which actions will be published. @type action_channels List[Tuple[str, type]]
observation_channels	Channels on which observations will be received. @type observation_channels List[Tuple[str, type]]
global_config	Path or dictionary describing the complete Noah system configuration. If None a warning is emitted and only minimal functionality is available. @type global_config Union[str, Dict[str, Any], Path]
sim	Set True when running in simulation mode. @type sim bool

The documentation for this class was generated from the following file:

ark/env/ark_env.py