compass-newembodiment

Generate COMPASS configuration files and register new robot embodiments.

125|14|Updated Feb 21, 2025
One-click install
npx skills add https://github.com/NVlabs/COMPASS --skill compass-newembodiment
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: compass-newembodiment
Source: https://github.com/NVlabs/COMPASS/tree/main/.claude/skills/compass-newembodiment
Command: npx skills add https://github.com/NVlabs/COMPASS --skill compass-newembodiment

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Manually onboarding a new robot to COMPASS requires creating multiple specialized configuration files, registering the embodiment in the correct system map, and verifying the robot spawns without simulation errors — a process that is error-prone and requires deep familiarity with the COMPASS codebase structure.

Core Features & Use Cases

  • Guided Config Generation: Automatically generates the required ArticulationCfg block and per-embodiment environment config by mirroring existing robot patterns for wheeled, quadruped, or humanoid platforms.
  • Automated Registration: Updates the EmbodimentEnvCfgMap in run.py to register the new robot, making it available via the --embodiment CLI flag for training and testing.
  • Smoke Test Validation: Runs a controlled test with a single environment to verify the robot spawns at the correct initial pose, does not clip through the floor, and completes the first PPO iteration without joint controller errors.
  • Use Case: A robotics researcher wants to add their custom quadruped robot to COMPASS for mobility policy training; this skill walks them through selecting the Spot base pattern, generating the required configs, and running a smoke test to confirm the robot functions correctly in simulation.

Quick Start

Use the compass-newembodiment skill to add your new robot to COMPASS by providing its USD file path, desired lowercase identifier, and matching base robot pattern, then confirm the generated changes and run the smoke test to verify the robot spawns correctly.

Frequently Asked Questions about compass-newembodiment

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I add a custom robot to COMPASS for reinforcement learning training?

Adding a robot to COMPASS requires generating specific configuration files and registering the embodiment in the system map. It mirrors existing robot patterns for wheeled, quadruped, or humanoid platforms to prevent simulation errors like joint mismatches or incorrect initial poses.

What configuration files are needed to onboard a new robot platform to COMPASS?

Onboarding a new robot platform to COMPASS requires an ArticulationCfg block and a per-embodiment environment configuration. These files are automatically generated by mirroring existing base robot patterns to ensure correct simulation setup.

How do I register a new embodiment in the COMPASS cross-embodiment mobility framework?

Registering a new embodiment in the COMPASS framework involves updating the EmbodimentEnvCfgMap in run.py. This automated registration makes the new robot available via the --embodiment CLI flag for training and testing workflows.

Why does my custom robot spawn with simulation errors like joint mismatches in COMPASS?

Simulation errors like joint mismatches or floor clipping occur when the robot configuration is incomplete or incorrect. Running a controlled smoke test validates the initial pose and joint controllers to prevent these PPO iteration failures.

Can I onboard a humanoid robot to COMPASS using an existing base pattern?

Yes, you can onboard a humanoid robot to COMPASS by selecting a matching base robot pattern. The system generates the required configuration files by mirroring existing patterns for wheeled, quadruped, or humanoid platforms to ensure proper articulation setup.

How do I validate that my new robot spawns correctly in a COMPASS simulation?

You validate a new robot spawn in COMPASS by running a controlled smoke test with a single environment. This test verifies the initial pose, checks for floor clipping, and ensures the first PPO iteration completes without joint controller errors.