Skip to content

Update readme to execute all examples with uv run#641

Merged
mzamoramora-nvidia merged 1 commit into
newton-physics:mainfrom
MiguelZamoraM:readme-run-instructions
Aug 26, 2025
Merged

Update readme to execute all examples with uv run#641
mzamoramora-nvidia merged 1 commit into
newton-physics:mainfrom
MiguelZamoraM:readme-run-instructions

Conversation

@mzamoramora-nvidia

@mzamoramora-nvidia mzamoramora-nvidia commented Aug 26, 2025

Copy link
Copy Markdown
Member

Description

This PR closes #640

Newton Migration Guide

Please ensure the migration guide for warp.sim users is up-to-date with the changes made in this PR.

  • The migration guide in docs/migration.rst is up-to date

Before your PR is "Ready for review"

  • [-] Necessary tests have been added and new examples are tested (see newton/tests/test_examples.py)
  • [-] Documentation is up-to-date
  • Code passes formatting and linting checks with pre-commit run -a

Summary by CodeRabbit

  • Documentation
    • Updated README to use uv run -m for all example invocations, replacing python -m across sections.
    • Covered examples include: basic_viewer; IK (ik_franka, ik_h1, ik_benchmark); DiffSim (diffsim_ball, diffsim_cloth, diffsim_drone, diffsim_spring_cage, diffsim_soft_body).
    • Revised a placeholder note from “Future MPM example” to “Future diffsim example”.
    • No functional changes.

@coderabbitai

coderabbitai Bot commented Aug 26, 2025

Copy link
Copy Markdown
Contributor
📝 Walkthrough

Walkthrough

README.md updated to replace example commands from "python -m" to "uv run -m" across example sections. One placeholder comment text changed from "Future MPM example" to "Future diffsim example". No code changes.

Changes

Cohort / File(s) Summary
Docs: README example commands
README.md
Replaced all example invocations using python -m with uv run -m across Basic, Inverse Kinematics, and DiffSim sections; updated a placeholder comment text.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~2 minutes

Assessment against linked issues

Objective Addressed Explanation
Update README instructions to use uv run (#640)

Tip

🔌 Remote MCP (Model Context Protocol) integration is now available!

Pro plan users can now connect to remote MCP servers from the Integrations page. Connect with popular remote MCPs such as Notion and Linear to add more context to your reviews and chats.

✨ Finishing Touches
🧪 Generate unit tests
  • Create PR with unit tests
  • Post copyable unit tests in a comment

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
🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>, please review it.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

CodeRabbit Commands (Invoked using PR/Issue comments)

Type @coderabbitai help to get the list of available commands.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

Status, Documentation and Community

  • Visit our Status Page to check the current availability of CodeRabbit.
  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

@preist-nvidia preist-nvidia left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Thank you!

@coderabbitai coderabbitai Bot left a comment

Copy link
Copy Markdown
Contributor

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 (1)
README.md (1)

105-105: Remove commented-out duplicate command to avoid confusion.

This HTML-commented command is redundant with the Basic Viewer example already shown above. Consider deleting it to keep the table clean.

-      <!-- <code>uv run -m newton.examples basic_viewer</code> -->
📜 Review details

Configuration used: Path: .coderabbit.yml

Review profile: CHILL

Plan: Pro

💡 Knowledge Base configuration:

  • MCP integration is disabled by default for public repositories
  • Jira integration is disabled by default for public repositories
  • Linear integration is disabled by default for public repositories

You can enable these sources in your CodeRabbit configuration.

📥 Commits

Reviewing files that changed from the base of the PR and between a32ad9d and efa8698.

📒 Files selected for processing (1)
  • README.md (4 hunks)
🧰 Additional context used
🧠 Learnings (1)
📚 Learning: 2025-08-12T05:17:34.423Z
Learnt from: shi-eric
PR: newton-physics/newton#521
File: newton/examples/example_cloth_hanging.py:36-36
Timestamp: 2025-08-12T05:17:34.423Z
Learning: The Newton migration guide (docs/migration.rst) is specifically for documenting how to migrate existing warp.sim functionality to Newton equivalents. New Newton-only features that didn't exist in warp.sim do not need migration documentation.

Applied to files:

  • README.md
⏰ Context from checks skipped due to timeout of 900000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (4)
  • GitHub Check: Run GPU Unit Tests on AWS EC2 (Pull Request)
  • GitHub Check: Run GPU Benchmarks (Pull Request)
  • GitHub Check: run-newton-tests / newton-unittests (windows-latest)
  • GitHub Check: run-newton-tests / newton-unittests (ubuntu-latest)
🔇 Additional comments (2)
README.md (2)

322-330: DiffSim examples updated to uv run -m — LGTM.

Consistent with Quickstart and other sections.


348-356: Second DiffSim row: commands and placeholder are consistent.

The switch to uv run -m is correct; placeholder label matches the section.

Comment thread README.md
@mzamoramora-nvidia mzamoramora-nvidia merged commit a8947bc into newton-physics:main Aug 26, 2025
12 checks passed
@mzamoramora-nvidia mzamoramora-nvidia deleted the readme-run-instructions branch September 4, 2025 09:25
eric-heiden pushed a commit to eric-heiden/newton that referenced this pull request Jan 28, 2026
vidurv-nvidia pushed a commit to vidurv-nvidia/newton that referenced this pull request Mar 6, 2026
)

# Description

Introduced CoM randomization in events.py for manager based envs.
Individual range can be selected for individual axis and bodies.

Thanks to newton-physics#641 and newton-physics#693  for motivation of the code.  

## Type of change

- New feature (non-breaking change which adds functionality)
- This change requires a documentation update

## Checklist

- [x] I have run the [`pre-commit` checks](https://pre-commit.com/) with
`./isaaclab.sh --format`
- [ ] I have made corresponding changes to the documentation
- [x] 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
- [x] I have added my name to the `CONTRIBUTORS.md` or my name already
exists there
mmacklin pushed a commit to mmacklin/newton that referenced this pull request Apr 7, 2026
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.

Update readme instructions to use uv run

2 participants