Skip to main content

hydrogym.nek.pettingzoo_env

Optional PettingZoo-compatible wrapper for NekParallelEnv. Only needed if you want to use PettingZoo-specific libraries.

NekPettingZooEnv Objects​

class NekPettingZooEnv(ParallelEnv)

PettingZoo-compatible wrapper for NekParallelEnv.

This wrapper makes the environment compatible with PettingZoo's API, allowing use with PettingZoo-specific libraries and tools.

Arguments:

  • parallel_env - NekParallelEnv instance to wrap

unwrapped​

@property
def unwrapped()

Return the base environment without wrappers.

observation_space​

@functools.lru_cache(maxsize=None)
def observation_space(agent)

Return observation space for agent (cached).

action_space​

@functools.lru_cache(maxsize=None)
def action_space(agent)

Return action space for agent (cached).

reset​

def reset(seed=None, options=None)

Reset the environment.

step​

def step(actions)

Step the environment.

render​

def render(mode="human")

Render the environment.

close​

def close()

Close the environment.

make_pettingzoo_env​

def make_pettingzoo_env(nek_env, render_mode=None)

Convenience function to create PettingZoo environment from NekEnv.

Arguments:

  • nek_env - Base NekEnv instance
  • render_mode - Render mode for the environment (default: None)

Returns:

NekPettingZooEnv instance