Practical overview
When it fits
Use OceanGym when an experiment needs simulated underwater conditions for perception or navigation evaluation, rather than a general-purpose agent framework.
Who it is for
- Researchers benchmarking autonomous underwater vehicles and other embodied agents.
- Teams evaluating agent perception with camera or sonar imagery.
- Developers studying navigation and decision-making in underwater simulation.
Documented uses
- Compare agent performance across underwater scenes and benchmark tasks.
- Collect camera-only or camera-and-sonar images for perception experiments.
- Run navigation decision tasks and inspect evaluation outputs.
- Customize objects, scenes, and environmental or task parameters.
Requirements & limits
The project repository is publicly accessible. The supplied repository metadata does not identify a license.
- The documented Unreal Engine decision-task setup is Windows-specific.
- The repository describes HoloOcean installation and world configuration as part of setup.
- OceanGym includes both camera and sonar perception workflows.
- The README contains an IsaacLab conversion path in addition to its Unreal Engine environment.
Check current requirements in the official documentation. Source-based guidance does not mean OpenViST has run or independently tested this project.
Install OceanGym’s Python package and add a world configuration
Prepare the documented HoloOcean-based OceanGym environment by installing its Python package and world package, then placing a task configuration file in HoloOcean’s worlds directory.
Before you start
- A cloned OceanGym repository.
- Python and HoloOcean, as referenced by the installation instructions.
- A configuration JSON file from
asset/decision/map_configorasset/perception/map_config. - A Windows environment is shown for the example world-file path.
Steps
From the cloned repository, change to
OceanGym_large/clientand install the Python package with the command below.pip install .Install the worlds package by running
import holooceanfollowed byholoocean.install("Ocean")in Python.Copy a JSON configuration from
asset/decision/map_configorasset/perception/map_configinto HoloOcean’sworlds/Oceandirectory; the documented Windows example isC:\Users\Windows\AppData\Local\holoocean\2.0.0\worlds\Ocean.For first-time use, locate
Holodeck.uprojectin theenginefolder, generate Visual Studio project files, open the project, and follow the README’s Unreal Engine setup guidance before proceeding to its documented world-opening stage.
Expected outcome
The OceanGym Python package and Ocean world package are installed, and a selected task configuration is placed in HoloOcean’s worlds directory.
Guide limitations
- The README identifies the subsequent Unreal Engine workflow as requiring full UE5 support and states its commands apply to Windows only.
- The README’s example world path is specific to Windows.
- This recipe stops at environment preparation; running a task is a separate documented stage.
Run OceanGym decision task 4 and evaluate its saved results
Run the documented decision task 4 after preparing the OceanGym environment, then configure and run the evaluation script on its saved memory files.
Before you start
- The OceanGym environment must first be built using the README’s setup instructions.
- The experimental code environment is installed with
pip install -r requirements.txt. - A compatible environment for the documented decision-task workflow; the README says its decision-task commands apply to Windows only because full UE5 support is required.
Steps
Install the experimental code requirements with the command below.
pip install -r requirements.txtStart the Unreal Engine project and load the
HAIDImap in thedemodirectory, following the README’s Open the World instructions.Run task 4 with the command below; use the keyboard instructions for control, or press
Mto switch to LLM mode. PressQto exit.python decision\tasks\task4.pyAfter the run, place the generated
memoryandimportant_memoryfiles into the correspondingpointfolders and set the evaluation paths inevaluate.py.Run the command below to generate evaluation results.
python decision\utils\evaluate.py
Expected outcome
The task saves logs and memory files in `log/` and `memory/`; the evaluation script saves results under the `\eval\decision` folder.
Guide limitations
- The README warns that switching to LLM mode may cause temporary lag.
- The README states that the decision-task commands apply to Windows only and require full support from UE5.
- The
memoryandimportant_memoryfiles must be placed in correspondingpointfolders and the evaluation paths configured before evaluation.
Sources & review
Source record details
- Source availability
- Active
- Sources checked
- 18 October 2026
- Original website title
- OceanGPT/OceanGym · Official homepage title · retained in its source language

