UNav-Sim

UNav-Sim

Visually Realistic Underwater Robotics Simulator UNav-Sim

Stars: 63

Visit
 screenshot

UNav-Sim is an open-source underwater robotics simulator tool that leverages the power of Unreal Engine 5 (UE5) and AirSim to provide highly detailed rendering and simulation capabilities. With UNav-Sim, you can explore underwater terrains, design and test autonomous underwater vehicles (AUVs), and accelerate your learning and experimentation process in the field of underwater robotics.

README:

πŸŒŠπŸ€– Introducing UNav-Sim: The Ultimate Underwater Robotics Simulator! πŸš€

UNavSim_logo

UNav-Sim is an open-source cutting-edge underwater robotics simulator tool that leverages the power of Unreal Engine 5 (UE5) and AirSim to provide highly detailed rendering and simulation capabilities. Whether you're a researcher, developer, or robotics enthusiast, UNav-Sim offers a platform for you to dive deep into the world of underwater robotics.

Key Features:

  • Open-source βœ”οΈ
  • High-fidelity rendering using Unreal Engine 5 βœ”οΈ
  • Underwater physics and robot models βœ”οΈ
  • Works on Linux and Windows OS βœ”οΈ
  • ROS1 and ROS2 support βœ”οΈ

Discover a wide range of possibilities with UNav-Sim, from exploring underwater terrains to designing and testing autonomous underwater vehicles (AUVs). Whether you're a student, researcher, or hobbyist, this powerful tool will accelerate your learning and experimentation process.

Index

1. Installation

2. Running the simulation

3. UNav-Sim ros navigation stack

4. UNav-Sim documentation

1. Installation

UNav-Sim relies in Unreal Engine 5 for generating realistic renderings. First, install UE5 and then proceed to install UNav-Sim

1.1. UE5

  • Make sure you are registered with Epic Games. This is required to get source code access for Unreal Engine.

  • Clone Unreal 5.1 in your favorite folder and build it (this may take a while!)

# go to the folder where you clone GitHub projects
git clone -b 5.1 [email protected]:EpicGames/UnrealEngine.git
cd UnrealEngine
./Setup.sh
./GenerateProjectFiles.sh
make

1.2. UNav-Sim

Clone this repo in your favourite folder:

git clone [email protected]:open-airlab/UNav-Sim.git
cd UNav-Sim

We provide you scripts to automatically setup and build UNav-Sim:

./setup.sh
./build.sh
# use ./build.sh --debug to build in debug mode

Troubleshooting: If you're installing UNav-Sim from Ubuntu 22, then instead of vulkan-utils you will need to install vulkan-tools:

sudo apt update
sudo apt install vulkan-tools

1.3. Setting up the UE5 environment

cd ~/UNav-Sim/Unreal/Environments/Blocks
right-click on Blocks.uproject, select Unreal Engine Generate Project Files

2. Running the simulation

  • Add the settings.json file to C:\Users[username]\Documents\AirSim
- open the project using your IDE 
- Run and debug using Launch BlocksEditor(DebugGame)

3. UNav-Sim ros navigation stack (COMING SOON)

....

4. UNav-Sim documentation

Link to paper

Citation

If you use this framework in your work, please cite the following paper:Link to paper

@inproceedings{amer2023unav,
  title={UNav-Sim: A Visually Realistic Underwater Robotics Simulator and Synthetic Data-generation Framework},
  author={Amer, Abdelhakim and {\'A}lvarez-Tu{\~n}{\'o}n, Olaya and U{\u{g}}urlu, Halil {\.I}brahim and Sejersen, Jonas Le Fevre and Brodskiy, Yury and Kayacan, Erdal},
  booktitle={2023 21st International Conference on Advanced Robotics (ICAR)},
  pages={570--576},
  year={2023},
  organization={IEEE}
}

⭐ Please star this repository if you find it useful! ⭐

Thank you for using this project! 🌟

For Tasks:

Click tags to check more tools for each tasks

For Jobs:

Alternative AI tools for UNav-Sim

Similar Open Source Tools

For similar tasks

For similar jobs