Skip to content

Clarify PhysX backend docs#5811

Merged
kellyguo11 merged 1 commit into
isaac-sim:developfrom
AntoineRichard:antoine/physx-doc-clarity
May 27, 2026
Merged

Clarify PhysX backend docs#5811
kellyguo11 merged 1 commit into
isaac-sim:developfrom
AntoineRichard:antoine/physx-doc-clarity

Conversation

@AntoineRichard

Copy link
Copy Markdown
Collaborator

Description

Clarifies the PhysX backend documentation around timestep/frequency wording, stabilization guidance, and the Isaac Lab 3.0 PhysxCfg import path.

This PR also updates the example configuration to keep enable_stabilization=False at dt=1 / 120, softens the contact-sensor caveat wording, and clarifies the Isaac Sim version note for solve_articulation_contact_last.

No new dependencies are required.

Fixes # (issue)

No linked issue.

Type of change

  • Documentation update

Screenshots

Not applicable.

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 (not run: full Sphinx docs build)
  • I have added tests that prove my fix is effective or that my feature works (not applicable: docs-only wording change)
  • I have added a changelog fragment under source/<pkg>/changelog.d/ for every touched package (not applicable: docs-only change under top-level docs)
  • I have added my name to the CONTRIBUTORS.md or my name already exists there

Clarify PhysX stabilization guidance by using timestep and frequency consistently, disable stabilization in the high-rate example, and spell out the Isaac Lab 3.0 PhysxCfg import path.

Also soften contact-sensor warning wording and clarify the Isaac Sim version note for solve_articulation_contact_last.
@github-actions github-actions Bot added the documentation Improvements or additions to documentation label May 27, 2026
@greptile-apps

greptile-apps Bot commented May 27, 2026

Copy link
Copy Markdown
Contributor

Greptile Summary

This PR is a documentation-only update to the PhysX backend docs, clarifying the PhysxCfg import path for Isaac Lab 3.0, correcting the representative example (enable_stabilization=False at dt=1/120), expanding the enable_stabilization threshold description, and softening the contact-sensor caveat wording.

  • Import path: Explicitly guides users migrating from Isaac Lab 2.x to switch from isaaclab.sim to isaaclab_physx.physics.
  • Example fix: enable_stabilization is now False in the 120 Hz example, consistent with the rule that stabilization is only recommended below 30 Hz.
  • Wording polish: The enable_stabilization description and the supported-features.rst caveat are both made more precise; the solve_articulation_contact_last version note is reformulated (though the new phrasing is a bit verbose — see inline comment).

Confidence Score: 5/5

Documentation-only change with no runtime impact; all factual claims are internally consistent.

All changes are limited to .rst documentation files. The enable_stabilization=False correction is consistent with the 120 Hz example and the surrounding explanatory text. The import-path guidance matches the code block already present in the file. The only concern is a slightly verbose rewording of the solve_articulation_contact_last note, which is a minor clarity issue rather than a factual error.

The solve_articulation_contact_last paragraph in configuration.rst could be clearer — see the inline suggestion.

Important Files Changed

Filename Overview
docs/source/overview/core-concepts/physical-backends/physx/configuration.rst Clarifies import path for PhysxCfg in Isaac Lab 3.0, corrects the example to enable_stabilization=False at 120 Hz, expands the enable_stabilization threshold description, and softens the solve_articulation_contact_last version note (slightly verbose).
docs/source/overview/core-concepts/physical-backends/physx/supported-features.rst Softens enable_stabilization caveat wording from "corrupt" to "inaccurate" — consistent with the parallel change in configuration.rst.

Flowchart

%%{init: {'theme': 'neutral'}}%%
flowchart TD
    A[PhysxCfg setup] --> B{Isaac Lab version?}
    B -->|2.x| C["from isaaclab.sim import PhysxCfg"]
    B -->|3.0+| D["from isaaclab_physx.physics import PhysxCfg"]

    D --> E{Simulation rate?}
    E -->|dt > 1/30 s\nbelow 30 Hz| F["enable_stabilization=True\n⚠ contact-force magnitudes may be inaccurate"]
    E -->|dt ≤ 1/30 s\n30 Hz or faster| G["enable_stabilization=False\n✓ accurate contact-force readings"]

    G --> H["Example: dt=1/120\nenable_stabilization=False ✓"]
Loading

Reviews (1): Last reviewed commit: "docs: Clarify PhysX backend guidance" | Re-trigger Greptile

Comment on lines +49 to +51
gripping scenarios. For Isaac Lab 3.0, the supported Isaac Sim versions
include this feature; it depends on PhysX schema support introduced in
Isaac Sim 5.1.

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.

P2 The rewritten note is harder to parse than the original. "The supported Isaac Sim versions include this feature" is vague — a reader doesn't know which versions are "supported". If the intent is to convey that Isaac Lab 3.0 already requires Isaac Sim ≥ 5.1 (making the old "Requires 5.1+" caveat redundant), a more direct phrasing makes that clear without the circular reasoning.

Suggested change
gripping scenarios. For Isaac Lab 3.0, the supported Isaac Sim versions
include this feature; it depends on PhysX schema support introduced in
Isaac Sim 5.1.
gripping scenarios. Requires Isaac Sim 5.1+ (all Isaac Sim versions
supported by Isaac Lab 3.0 meet this requirement).

Note: If this suggestion doesn't match your team's coding style, reply to this and let me know. I'll remember it for next time!

@kellyguo11 kellyguo11 merged commit 8ee86ef into isaac-sim:develop May 27, 2026
36 of 37 checks passed
kellyguo11 added a commit that referenced this pull request May 28, 2026
… locomanip quaternion, deformable demo, IK, benchmark scripts (#5816)

# Description

Cherry pick following PRs from develop:

- #5779 
- #5760
- #5791
- #5810 
- #5811
- #5812 
- #5754 
- #5802 
- #5803 
- #5782
- #5804 
- #5744 
- #5775 
- #5784

---------

Signed-off-by: Kelly Guo <kellyg@nvidia.com>
Co-authored-by: John <jaybdub@users.noreply.github.com>
Co-authored-by: myurasov-nv <168484206+myurasov-nv@users.noreply.github.com>
Co-authored-by: Antoine RICHARD <antoiner@nvidia.com>
Co-authored-by: Mike Yan Michelis <46975745+mmichelis@users.noreply.github.com>
Co-authored-by: hujc <jichuanh@nvidia.com>
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

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants