Clarify PhysX backend docs#5811
Conversation
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.
Greptile SummaryThis PR is a documentation-only update to the PhysX backend docs, clarifying the
Confidence Score: 5/5Documentation-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
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 ✓"]
Reviews (1): Last reviewed commit: "docs: Clarify PhysX backend guidance" | Re-trigger Greptile |
| 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. |
There was a problem hiding this comment.
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.
| 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!
… 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>
Description
Clarifies the PhysX backend documentation around timestep/frequency wording, stabilization guidance, and the Isaac Lab 3.0
PhysxCfgimport path.This PR also updates the example configuration to keep
enable_stabilization=Falseatdt=1 / 120, softens the contact-sensor caveat wording, and clarifies the Isaac Sim version note forsolve_articulation_contact_last.No new dependencies are required.
Fixes # (issue)
No linked issue.
Type of change
Screenshots
Not applicable.
Checklist
pre-commitchecks with./isaaclab.sh --formatsource/<pkg>/changelog.d/for every touched package (not applicable: docs-only change under top-level docs)CONTRIBUTORS.mdor my name already exists there