Skip to content

Upgrade to Isaac Sim 5.1.0#114

Merged
j3soon merged 2 commits intomainfrom
feat/isaac-sim-5-1-0
Mar 29, 2026
Merged

Upgrade to Isaac Sim 5.1.0#114
j3soon merged 2 commits intomainfrom
feat/isaac-sim-5-1-0

Conversation

@j3soon
Copy link
Copy Markdown
Owner

@j3soon j3soon commented Mar 24, 2026

Fixes: #98

Summary by CodeRabbit

Release Notes

  • Documentation

    • Updated Isaac Sim documentation and references from version 5.0.0 to 5.1.0.
    • Updated documentation URLs to the new Isaac Sim domain.
  • Chores

    • Upgraded Isaac Sim from version 5.0.0 to 5.1.0 across all workspaces and Docker configurations.
    • Consolidated Isaac Sim cache directory structure for improved organization and streamlined volume management.

j3soon added 2 commits March 24, 2026 23:53
- The isaac sim compatibility checker already exists in the binary install (updated docs)
- The cache path is different with Isaac Sim 5.0.0
@coderabbitai
Copy link
Copy Markdown

coderabbitai bot commented Mar 24, 2026

Walkthrough

This PR systematically updates the Isaac Sim version from 5.0.0 to 5.1.0 across the entire project. Changes include updating version arguments in Dockerfiles, restructuring Docker Compose cache directory layouts, modifying the installation script, and updating documentation and URLs to reflect the new version.

Changes

Cohort / File(s) Summary
Documentation & Configuration
CLAUDE.md, README.md, docs/docker-modules/isaac-sim.md
Updated Isaac Sim version string references from 5.0.0 to 5.1.0; modified compatibility test commands and directory paths in Isaac Sim documentation; changed documentation URL domain.
Dockerfile Version Updates
aloha_ws/docker/Dockerfile, delto_gripper_ws/docker/Dockerfile, gazebo_world_ws/docker/Dockerfile, go2_ws/docker/Dockerfile, h1_ws/docker/Dockerfile, husky_ws/docker/Dockerfile, kobuki_ws/docker/Dockerfile, orbslam3_ws/docker/Dockerfile, stretch3_ws/docker/Dockerfile, template_ws/docker/Dockerfile, turtlebot3_ws/docker/Dockerfile, ur5_ws/docker/Dockerfile, vlp_ws/docker/Dockerfile, tests/diff_base/docker/Dockerfile
Changed default ISAAC_SIM_VERSION build argument from 5.0.0 to 5.1.0; all other build logic remains unchanged.
Docker Compose Cache Restructuring
aloha_ws/docker/compose.yaml, delto_gripper_ws/docker/compose.yaml, gazebo_world_ws/docker/compose.yaml, go2_ws/docker/compose.yaml, h1_ws/docker/compose.yaml, husky_ws/docker/compose.yaml, kobuki_ws/docker/compose.yaml, orbslam3_ws/docker/compose.yaml, stretch3_ws/docker/compose.yaml, template_ws/docker/compose.yaml, turtlebot3_ws/docker/compose.yaml, vlp_ws/docker/compose.yaml, tests/diff_base/docker/compose.yaml
Consolidated Isaac Sim cache directory initialization from /isaac-sim/cache/{kit,ov,pip,glcache,computecache}, /isaac-sim/{logs,data,documents}, and /isaac-sim/standalone/... to /isaac-sim/.cache, /isaac-sim/.nv/ComputeCache, /isaac-sim/.nvidia-omniverse/{logs,config}, and /isaac-sim/.local/share/ov/{data,pkg}; updated corresponding volume mount targets and subpaths; updated version comments and documentation URLs.
Device & Mount Configuration
ur5_ws/docker/compose.yaml
Added/adjusted device passthrough settings (disabled /dev/dri, /dev/snd, /dev/shm; enabled /dev:/dev); commented out environment build args.
Installation & Runtime Scripts
docker_modules/install_isaac_sim.sh, scripts/docker_run_official_isaac_sim.sh
Updated install script version-gating logic for 5.1.0 (removed compatibility checker download for 5.0.0, adjusted installer paths); updated official Isaac Sim docker run script to use new image tag 5.1.0 and consolidated cache mount directory structure; added non-root user UID:GID execution.
Test Dockerfile
tests/diff_base/docker/Dockerfile
Updated ISAAC_SIM_VERSION from 5.0.0 to 5.1.0; removed placeholder-prefixed directives from realsense configuration section and replaced with standard ARG, COPY, and RUN instructions.

Estimated code review effort

🎯 3 (Moderate) | ⏱️ ~22 minutes

Possibly related PRs

Suggested labels

enhancement

Poem

🐰 A fleet of bots hops up to date,
From Isaac Sim 5.0.0's fate,
Now 5.1.0 takes the stage,
With consolidated cache—a modern age,
All cache paths tucked in hidden retreat,
Makes Isaac's heart skip a roborabbit beat! 🤖✨

🚥 Pre-merge checks | ✅ 3
✅ Passed checks (3 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title 'Upgrade to Isaac Sim 5.1.0' accurately summarizes the main change across the pull request—updating Isaac Sim from version 5.0.0 to 5.1.0 across all documentation, Docker files, and configuration files.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
📝 Generate docstrings
  • Create stacked PR
  • Commit on current branch
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch feat/isaac-sim-5-1-0

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

Copy link
Copy Markdown

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 1

🧹 Nitpick comments (2)
template_ws/docker/compose.yaml (1)

133-164: Consider keeping the template’s shared cache mount Isaac-Sim-specific.

Line 137 now mounts the entire /home/user/.cache tree into isaac-sim-cache, so unrelated tool caches will persist and be shared here too. Since this is the template, that broader behavior will also be copied into future workspaces. If only Isaac Sim state needs persistence, narrow this back to the required subdirectories or add a short note that the wider sharing is intentional.

ur5_ws/docker/compose.yaml (1)

117-123: Stale TODO comment is now misleading.

The TODO on line 122 says "Uncomment the line below and comment out the three entries above to enable USB support", but the current state is already the inverse (individual devices commented, /dev:/dev enabled). This creates confusion about the intended default configuration.

Consider updating or removing this TODO to reflect the new default state.

✏️ Suggested comment update
      # Mount shared memory for ROS2 communication.
      # - /dev/shm:/dev/shm
-     # TODO: Uncomment the line below and comment out the three entries above to enable USB support.
+     # NOTE: Mounting /dev:/dev provides broader device access (USB, DRI, sound, etc.).
+     # For more restrictive access, comment out the line below and uncomment individual device mounts above.
      - /dev:/dev
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.

In `@ur5_ws/docker/compose.yaml` around lines 117 - 123, Update the stale TODO
that instructs to "Uncomment the line below and comment out the three entries
above" to reflect the current state where the individual device mounts (# -
/dev/dri:/dev/dri, # - /dev/snd:/dev/snd, # - /dev/shm:/dev/shm) are commented
and the consolidated device mount "- /dev:/dev" is enabled; either remove the
TODO or replace it with a clear note stating that USB/device support is
currently enabled via "- /dev:/dev" and documenting when to prefer the
individual mounts vs the consolidated mount.
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.

Inline comments:
In `@scripts/docker_run_official_isaac_sim.sh`:
- Line 31: The volume mount uses an unquoted $(pwd) which will undergo word
splitting if the current directory contains spaces; update the docker run
argument in scripts/docker_run_official_isaac_sim.sh to quote the expansion
(e.g., use "$(pwd)" or "$PWD") for the -v mount so the entire path is passed as
a single argument; change the occurrence of -v $(pwd):/home/ros2-essentials \ to
use a quoted expansion for robust mounts.

---

Nitpick comments:
In `@ur5_ws/docker/compose.yaml`:
- Around line 117-123: Update the stale TODO that instructs to "Uncomment the
line below and comment out the three entries above" to reflect the current state
where the individual device mounts (# - /dev/dri:/dev/dri, # -
/dev/snd:/dev/snd, # - /dev/shm:/dev/shm) are commented and the consolidated
device mount "- /dev:/dev" is enabled; either remove the TODO or replace it with
a clear note stating that USB/device support is currently enabled via "-
/dev:/dev" and documenting when to prefer the individual mounts vs the
consolidated mount.

ℹ️ Review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: c093575d-8149-4f85-a41f-39538364e6f9

📥 Commits

Reviewing files that changed from the base of the PR and between d39ad67 and 4689b87.

📒 Files selected for processing (33)
  • CLAUDE.md
  • README.md
  • aloha_ws/docker/Dockerfile
  • aloha_ws/docker/compose.yaml
  • delto_gripper_ws/docker/Dockerfile
  • delto_gripper_ws/docker/compose.yaml
  • docker_modules/install_isaac_sim.sh
  • docs/docker-modules/isaac-sim.md
  • gazebo_world_ws/docker/Dockerfile
  • gazebo_world_ws/docker/compose.yaml
  • go2_ws/docker/Dockerfile
  • go2_ws/docker/compose.yaml
  • h1_ws/docker/Dockerfile
  • h1_ws/docker/compose.yaml
  • husky_ws/docker/Dockerfile
  • husky_ws/docker/compose.yaml
  • kobuki_ws/docker/Dockerfile
  • kobuki_ws/docker/compose.yaml
  • orbslam3_ws/docker/Dockerfile
  • orbslam3_ws/docker/compose.yaml
  • scripts/docker_run_official_isaac_sim.sh
  • stretch3_ws/docker/Dockerfile
  • stretch3_ws/docker/compose.yaml
  • template_ws/docker/Dockerfile
  • template_ws/docker/compose.yaml
  • tests/diff_base/docker/Dockerfile
  • tests/diff_base/docker/compose.yaml
  • turtlebot3_ws/docker/Dockerfile
  • turtlebot3_ws/docker/compose.yaml
  • ur5_ws/docker/Dockerfile
  • ur5_ws/docker/compose.yaml
  • vlp_ws/docker/Dockerfile
  • vlp_ws/docker/compose.yaml

-v ~/docker/isaac-sim/data:/isaac-sim/.local/share/ov/data:rw \
-v ~/docker/isaac-sim/pkg:/isaac-sim/.local/share/ov/pkg:rw \
-u 1234:1234 \
-v $(pwd):/home/ros2-essentials \
Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

⚠️ Potential issue | 🟡 Minor

Quote $(pwd) to prevent word splitting.

If the current working directory contains spaces, word splitting will cause the mount to fail.

🛠️ Proposed fix
-  -v $(pwd):/home/ros2-essentials \
+  -v "$(pwd)":/home/ros2-essentials \
📝 Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change
-v $(pwd):/home/ros2-essentials \
-v "$(pwd)":/home/ros2-essentials \
🧰 Tools
🪛 Shellcheck (0.11.0)

[warning] 31-31: Quote this to prevent word splitting.

(SC2046)

🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.

In `@scripts/docker_run_official_isaac_sim.sh` at line 31, The volume mount uses
an unquoted $(pwd) which will undergo word splitting if the current directory
contains spaces; update the docker run argument in
scripts/docker_run_official_isaac_sim.sh to quote the expansion (e.g., use
"$(pwd)" or "$PWD") for the -v mount so the entire path is passed as a single
argument; change the occurrence of -v $(pwd):/home/ros2-essentials \ to use a
quoted expansion for robust mounts.

@j3soon j3soon merged commit b8109fe into main Mar 29, 2026
2 checks passed
@j3soon j3soon deleted the feat/isaac-sim-5-1-0 branch March 29, 2026 09:37
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Add Isaac Sim 5.1.0

1 participant