Skip to content

Conversation

@kellyguo11
Copy link
Contributor

Description

Updates documentation for newton beta 2:

  • Installation instructions
  • Visualizers instructions
  • Multi-backends - folder restructuring and mechanism to switch between backends
  • Quaternion convention change - switching to XYZW
  • Warp dependency changes - data will be returned in Warp and users need to call wp.to_torch to convert to torch

Type of change

  • Documentation update

Checklist

  • I have read and understood the contribution guidelines
  • I have run the pre-commit checks with ./isaaclab.sh --format
  • I have made corresponding changes to the documentation
  • My changes generate no new warnings
  • I have added tests that prove my fix is effective or that my feature works
  • I have updated the changelog and the corresponding version in the extension's config/extension.toml file
  • I have added my name to the CONTRIBUTORS.md or my name already exists there

@github-actions github-actions bot added documentation Improvements or additions to documentation enhancement New feature or request labels Dec 9, 2025
@greptile-apps
Copy link
Contributor

greptile-apps bot commented Dec 9, 2025

Greptile Overview

Greptile Summary

Updated installation documentation from Isaac Sim 5.0 to 5.1 for Newton beta 2 release.

Major changes:

  • Updated Isaac Sim version requirement from 5.0 to 5.1 throughout the document
  • Removed the "Binary Installation" section entirely, simplifying to pip-only installation
  • Added warning to use fresh virtual environment to avoid dependency conflicts
  • Updated pip install command to use isaacsim[all,extscache]==5.1.0

The changes align with the Newton beta 2 release mentioned in the PR description and streamline the installation process by focusing solely on pip installation.

Confidence Score: 4/5

  • This PR is safe to merge with one minor correction needed
  • Score reflects straightforward documentation update with clear improvements. The only issue is a section header inconsistency where line 51 still references version 5.0 instead of 5.1. All other version references were correctly updated.
  • The installation.rst file needs one quick fix to update the section header from "5.0" to "5.1"

Important Files Changed

File Analysis

Filename Score Overview
docs/source/experimental-features/newton-physics-integration/installation.rst 4/5 Updates Isaac Sim version from 5.0 to 5.1, removes binary installation section, adds fresh environment warning. One inconsistency found in section header.

Sequence Diagram

sequenceDiagram
    participant User
    participant Conda
    participant Pip
    participant IsaacSim
    participant IsaacLab
    
    User->>Conda: Create python 3.11 environment
    Conda-->>User: Environment created
    User->>Conda: Activate environment
    Conda-->>User: Environment activated
    User->>Pip: Install torch 2.7.0 & torchvision 0.22.0
    Pip-->>User: PyTorch installed
    User->>Pip: Install isaacsim[all,extscache]==5.1.0
    Pip->>IsaacSim: Download and install Isaac Sim 5.1
    IsaacSim-->>User: Isaac Sim 5.1 installed
    User->>IsaacLab: Run ./isaaclab.sh -i
    IsaacLab->>IsaacLab: Install extensions and dependencies
    IsaacLab-->>User: Installation complete
    User->>IsaacLab: Run test script
    IsaacLab->>IsaacSim: Launch simulation
    IsaacSim-->>User: Verification successful
Loading

Copy link
Contributor

@greptile-apps greptile-apps bot left a comment

Choose a reason for hiding this comment

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

Additional Comments (1)

  1. docs/source/experimental-features/newton-physics-integration/installation.rst, line 51 (link)

    syntax: Section header still says "5.0" but should say "5.1" to match the version being installed

1 file reviewed, 1 comment

Edit Code Review Agent Settings | Greptile

@kellyguo11 kellyguo11 marked this pull request as draft December 10, 2025 00:06
@kellyguo11 kellyguo11 closed this Dec 17, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation enhancement New feature or request

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant