Installation¶

Prerequisites¶

ROS2 Required

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

Install a Model Inference Platform

EmbodiedAgents is agnostic to model serving platforms. You must have one of the following installed:

Ollama (Recommended for local inference)
RoboML
OpenAI API Compatible Inference Servers (e.g., llama.cpp, vLLM, SGLang)
LeRobot (For VLA models)

Note: You can skip this if using a cloud service like HuggingFace inference endpoints.

Tip

For utilizing larger models, it is recommended that model serving platforms are not installed directly on the robot (or the edge device) but on a GPU powered machine on the local network (or use one of the cloud providers).

Install EmbodiedAgents¶

Binary

Best for users who want to get started quickly

For ROS versions >= humble, you can install EmbodiedAgents with your package manager. For example on Ubuntu:

sudo apt install ros-$ROS_DISTRO-automatika-embodied-agents

Alternatively, grab your favorite deb package from the release page and install it as follows:

sudo dpkg -i ros-$ROS_DISTRO-automatica-embodied-agents_$version$DISTRO_$ARCHITECTURE.deb

If the attrs version from your package manager is < 23.2, install it using pip as follows:

pip install 'attrs>=23.2.0'

Source

Best for contributors or users needing the absolute latest features

Create your ROS workspace.

mkdir -p agents_ws/src
cd agents_ws/src

Install python dependencies

pip install numpy opencv-python-headless 'attrs>=23.2.0' jinja2 httpx setproctitle msgpack msgpack-numpy platformdirs tqdm pyyaml toml websockets

Install Sugarcoat🍬

git clone https://github.com/automatika-robotics/sugarcoat

Install EmbodiedAgents

# Clone repository
git clone https://github.com/automatika-robotics/embodied-agents.git
cd ..

# Build and source
colcon build
source install/setup.bash

# Run your recipe!
python your_script.py