Welcome to HoloOcean’s documentation!

HoloOcean is a realistic underwater robotics simulator with multi-agent missions, various underwater sensors including a novel imaging sonar sensor implementation, easy installation, and simple use. It’s a fork of Holodeck, a high-fidelity reinforcement learning simulator built on Unreal Engine 4.

HoloOcean Documentation

• Installation
  • Requirements
  • Stable Installation
  • Development Installation
  • Docker Installation
  • Managing World Packages
• Getting Started & Examples
  • Visualizing RGBCamera Output
  • Manually Controlling
  • Custom Scenario Configurations
  • Multi Agent Example
  • Multi-Agent Communications
  • Visualizing Imaging Sonar
  • Visualizing Profiling Sonar
  • Visualizing Sidescan Sonar
  • Visualizing Singlebeam Sonar
• Using HoloOcean
  • Scenarios
  • Viewport Hotkeys
  • Publishing Sensor Data
  • Units and Coordinates in HoloOcean
  • Improving HoloOcean Performance
  • Using HoloOcean Headless
  • Octree Generation
• HoloOcean Packages
  • Ocean Package
  • Package Structure
  • Package Installation Location
• HoloOcean Agents
  • HoveringAUV
  • TorpedoAUV
  • TurtleAgent
  • UavAgent
• Changelog
  • HoloOcean 0.5.0
  • HoloOcean 0.4.1
  • HoloOcean 0.4.0
  • Pre-HoloOcean

API Documentation

• HoloOcean
• Agents
• Environments
• Spaces
• Commands
• HoloOcean Client
• Package Manager
• Sensors
• LCM
• Shared Memory
• Util
• Exceptions
• Weather Controller

Indices and tables

• Index

• Module Index

• Search Page