Installation

Prerequisites

ROS2 Required

Kompass supports all ROS2 distributions from Foxy up to Rolling. Please ensure you have a working ROS2 installation before proceeding.

Install Core Engine

kompass-core is the package providing the highly optimized implementations of planning and control algorithms for Kompass. Choose the installation method that matches your hardware needs.


Best for production robots and high-performance simulation.

This installs AdaptiveCPP and compiles the core engine from source to fully utilize your specific GPU (Nvidia, AMD, Intel, etc.).

Run the following on any Ubuntu-based machine (including Jetson):

curl -sSL https://raw.githubusercontent.com/automatika-robotics/kompass-core/refs/heads/main/build_dependencies/install_gpu.sh | bash

It is good practice to read the script before running it.


Best for quick testing or lightweight environments.

Installs the standard Python package along with the CPP package bindings via pip.

pip install kompass-core

Install Kompass

Once the core engine is ready, install Kompass ROS2 packages (kompass and kompass_interfaces).


Option A: Install via APT (Recommended)

sudo apt install ros-$ROS_DISTRO-kompass

Option B: Manual .deb Install Download the specific version for your architecture from GitHub Releases.

# Replace variables with your version/distro/arch
sudo dpkg -i ros-$ROS_DISTRO-kompass-interfaces_$version$DISTRO_$ARCHITECTURE.deb
sudo dpkg -i ros-$ROS_DISTRO-kompass_$version$DISTRO_$ARCHITECTURE.deb

Best for contributors or debugging.

# 1. Create workspace
mkdir -p kompass_ws/src
cd kompass_ws/src

# 2. Clone repositories
git clone [https://github.com/automatika-robotics/sugarcoat](https://github.com/automatika-robotics/sugarcoat)
git clone [https://github.com/automatika-robotics/kompass](https://github.com/automatika-robotics/kompass)

# 3. Install dependencies
rosdep update
rosdep install -y --from-paths . --ignore-src

# 4. Build
cd ..
colcon build
source install/setup.bash

Next Steps

Now that you have Kompass installed, verify your setup or jump straight into the tutorials.

Quick Start

Run your first navigation task in simulation

Quick Start
Tutorials

Learn how to create custom navigation capabilities with Kompass

Basic Navigation Patterns