Skip to content

Commit 90af2be

Browse files
Updates docstring clarifications for joint modeling in 4.5 vs 5.0 (#3869)
# Description <!-- Thank you for your interest in sending a pull request. Please make sure to check the contribution guidelines. Link: https://isaac-sim.github.io/IsaacLab/main/source/refs/contributing.html 💡 Please try to keep PRs small and focused. Large PRs are harder to review and merge. --> Add docstring clarifications for joint modeling in 4.5 vs 5.0 Replaces this MR - #3461 <!-- As a practice, it is recommended to open an issue to have discussions on the proposed pull request. This makes it easier for the community to keep track of what is being developed or added, and if a given feature is demanded by more than one party. --> ## Type of change <!-- As you go through the list, delete the ones that are not applicable. --> - Documentation update ## Screenshots Please attach before and after screenshots of the change if applicable. <!-- Example: | Before | After | | ------ | ----- | | _gif/png before_ | _gif/png after_ | To upload images to a PR -- simply drag and drop an image while in edit mode and it should upload the image directly. You can then paste that source into the above before/after sections. --> ## Checklist - [ ] I have read and understood the [contribution guidelines](https://isaac-sim.github.io/IsaacLab/main/source/refs/contributing.html) - [ ] I have run the [`pre-commit` checks](https://pre-commit.com/) 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 <!-- As you go through the checklist above, you can mark something as done by putting an x character in it For example, - [x] I have done this task - [ ] I have not done this task -->
1 parent 6f59b88 commit 90af2be

File tree

4 files changed

+32
-3
lines changed

4 files changed

+32
-3
lines changed

source/isaaclab/config/extension.toml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
[package]
22

33
# Note: Semantic Versioning is used: https://semver.org/
4-
version = "0.47.4"
4+
version = "0.47.5"
55

66
# Description
77
title = "Isaac Lab framework for Robot Learning"

source/isaaclab/docs/CHANGELOG.rst

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,15 @@
11
Changelog
22
---------
33

4+
0.47.5 (2025-10-30)
5+
~~~~~~~~~~~~~~~~~~~
6+
7+
Changed
8+
^^^^^^^
9+
10+
* Added docstrings notes to clarify the friction coefficient modeling in Isaac Sim 4.5 and 5.0.
11+
12+
413
0.47.4 (2025-10-30)
514
~~~~~~~~~~~~~~~~~~~
615

source/isaaclab/isaaclab/actuators/actuator_cfg.py

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -153,10 +153,16 @@ class ActuatorBaseCfg:
153153
similar to static and Coulomb static friction.
154154
155155
If None, the joint static friction is set to the value from the USD joint prim.
156+
157+
Note: In Isaac Sim 4.5, this parameter is modeled as a coefficient. In Isaac Sim 5.0 and later,
158+
it is modeled as an effort (torque or force).
156159
"""
157160

158161
dynamic_friction: dict[str, float] | float | None = None
159162
"""The dynamic friction coefficient of the joints in the group. Defaults to None.
163+
164+
Note: In Isaac Sim 4.5, this parameter is modeled as a coefficient. In Isaac Sim 5.0 and later,
165+
it is modeled as an effort (torque or force).
160166
"""
161167

162168
viscous_friction: dict[str, float] | float | None = None

source/isaaclab/isaaclab/assets/articulation/articulation_data.py

Lines changed: 16 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -196,6 +196,9 @@ def update(self, dt: float):
196196
This quantity is configured through the actuator model's :attr:`isaaclab.actuators.ActuatorBaseCfg.friction`
197197
parameter. If the parameter's value is None, the value parsed from the USD schema, at the time of initialization,
198198
is used.
199+
200+
Note: In Isaac Sim 4.5, this parameter is modeled as a coefficient. In Isaac Sim 5.0 and later,
201+
it is modeled as an effort (torque or force).
199202
"""
200203

201204
default_joint_dynamic_friction_coeff: torch.Tensor = None
@@ -204,6 +207,9 @@ def update(self, dt: float):
204207
This quantity is configured through the actuator model's :attr:`isaaclab.actuators.ActuatorBaseCfg.dynamic_friction`
205208
parameter. If the parameter's value is None, the value parsed from the USD schema, at the time of initialization,
206209
is used.
210+
211+
Note: In Isaac Sim 4.5, this parameter is modeled as a coefficient. In Isaac Sim 5.0 and later,
212+
it is modeled as an effort (torque or force).
207213
"""
208214

209215
default_joint_viscous_friction_coeff: torch.Tensor = None
@@ -347,10 +353,18 @@ def update(self, dt: float):
347353
"""Joint armature provided to the simulation. Shape is (num_instances, num_joints)."""
348354

349355
joint_friction_coeff: torch.Tensor = None
350-
"""Joint static friction coefficient provided to the simulation. Shape is (num_instances, num_joints)."""
356+
"""Joint static friction coefficient provided to the simulation. Shape is (num_instances, num_joints).
357+
358+
Note: In Isaac Sim 4.5, this parameter is modeled as a coefficient. In Isaac Sim 5.0 and later,
359+
it is modeled as an effort (torque or force).
360+
"""
351361

352362
joint_dynamic_friction_coeff: torch.Tensor = None
353-
"""Joint dynamic friction coefficient provided to the simulation. Shape is (num_instances, num_joints)."""
363+
"""Joint dynamic friction coefficient provided to the simulation. Shape is (num_instances, num_joints).
364+
365+
Note: In Isaac Sim 4.5, this parameter is modeled as a coefficient. In Isaac Sim 5.0 and later,
366+
it is modeled as an effort (torque or force).
367+
"""
354368

355369
joint_viscous_friction_coeff: torch.Tensor = None
356370
"""Joint viscous friction coefficient provided to the simulation. Shape is (num_instances, num_joints)."""

0 commit comments

Comments
 (0)