HoloOcean
2.0.0

HoloOcean Documentation

  • Installation
  • Getting Started
  • Using HoloOcean
    • Scenarios
    • Environments
    • Viewport
    • Improving Performance
    • Units and Coordinates in HoloOcean
    • HoloOcean Client-Server Communication
  • HoloOcean Packages
  • HoloOcean Agents
  • HoloOcean Sensors
  • Examples
  • Other Versions Documentation
  • Developing HoloOcean
  • Changelog

API Documentation

  • HoloOcean
  • Agents
  • Environments
  • Action Spaces
  • Commands
  • HoloOcean Client
  • Package Manager
  • Sensors
  • LCM
  • Fossen Dynamics
  • Shared Memory
  • Util
  • Exceptions
  • Weather Controller
HoloOcean
  • Using HoloOcean
  • View page source

Using HoloOcean

The following pages explain the basic concepts and usage of HoloOcean.

Topics

  • Scenarios
    • Scenario File Format
    • Accessing and Modifying Pre-Built Scenarios
    • Making Custom Scenarios
  • Environments
    • HoloOcean Make
    • Act, Tick, and Step
  • Viewport
    • Hotkeys
    • Opening Console
    • Using HoloOcean Headless
  • Improving Performance
    • Frame Rate
    • Sonar Sensors
    • Camera Sensors
    • Disable Viewport Rendering
    • Change Render Quality
  • Units and Coordinates in HoloOcean
    • Coordinate System
    • Rotations
    • Agent, Socket, & Sensor Frames
  • HoloOcean Client-Server Communication
    • Prerequisite Reading
    • The Two Halves of HoloOcean
    • Simple Usage Example
    • Part 1: holoocean.make()
    • Part 2: .step()
    • Remarks
Previous Next

© Copyright BYU FRoStLab.

Built with Sphinx using a theme provided by Read the Docs.