Skip to main content
Ctrl+K

navsim v2.0.0 docs

  • Home
  • Getting started
  • navsim_envs Tutorial
  • navsim_envs API
  • ARORA Sim Tutorial - After Action Review (AAR) Mode
  • Conda/Container Tutorial
  • NavSim Labs API
  • .rst

navsim_envs API

Contents

  • env classes
    • AroraGymEnv
      • AroraGymEnv.register_with_gym()
      • AroraGymEnv.register_with_ray()
    • AroraUnityEnv
      • AroraUnityEnv.actions

navsim_envs API#

env classes#

class navsim_envs.arora.AroraGymEnv(env_config)[source]#

Bases: AroraGymEnvBase

AroraGymEnv inherits from Unity2Gym that inherits from the Gym interface.

Read the NavSim Environment Tutorial on how to use this class.

static register_with_gym()[source]#

Registers the environment with gym registry with the name navsim

static register_with_ray()[source]#

Registers the environment with ray registry with the name navsim

class navsim_envs.arora.AroraUnityEnv(env_config)[source]#

Bases: AroraUnityEnvBase

AroraUnityEnv Class is a wrapper to UnityEnvironment

Read the NavSim Environment Tutorial on how to use this class.

actions = {'backward': [-1, 0, 0], 'forward': [1, 0, 0], 'forward_left': [1, -1, 0], 'forward_right': [1, 1, 0]}#

previous

navsim_envs Package Tutorial

next

ARORA actions playback (AAR Mode)

By STTC, UCF

© Copyright 2021, STTC, UCF.