Skip to content

Renames joint dynamic and static friction variables#3461

Closed
matthewtrepte wants to merge 26 commits into
isaac-sim:mainfrom
matthewtrepte:mtrepte/rename_joint_vars
Closed

Renames joint dynamic and static friction variables#3461
matthewtrepte wants to merge 26 commits into
isaac-sim:mainfrom
matthewtrepte:mtrepte/rename_joint_vars

Conversation

@matthewtrepte

@matthewtrepte matthewtrepte commented Sep 15, 2025

Copy link
Copy Markdown
Contributor

Description

Rename misnamed joint coefficient variables in Articulation as the new joint friction APIs are forces/torques and not coefficients.

In Articulation

  • Rename joint_friction_coeff to joint_static_friction_effort
  • Rename joint_dynamic_friction_coeff to joint_dynamic_friction_effort
  • Update a few comments / descriptions
  • Added proxies to preserve old name and mark them as deprecated

Type of change

  • Bug fix (non-breaking change which fixes an issue)

Screenshots

Please attach before and after screenshots of the change if 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
  • 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 the isaac-lab Related to Isaac Lab team label Sep 15, 2025
@kellyguo11 kellyguo11 changed the title rename joint dynamic and static friction variables Renames joint dynamic and static friction variables Sep 16, 2025
Comment thread source/isaaclab/isaaclab/assets/articulation/articulation.py Outdated

@jtigue-bdai jtigue-bdai left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

all looks good. the main thing is the use of torque. In most cases it will be torque but for prismatic joints it will be a force. Effort is a more general term but you can add clarification that effort (force or torque).

Comment thread source/isaaclab/isaaclab/assets/articulation/articulation.py Outdated
Comment thread source/isaaclab/isaaclab/assets/articulation/articulation.py Outdated
Comment thread source/isaaclab/isaaclab/assets/articulation/articulation.py Outdated
Comment thread source/isaaclab/isaaclab/assets/articulation/articulation.py Outdated
Comment thread source/isaaclab/isaaclab/assets/articulation/articulation_data.py Outdated
Comment thread source/isaaclab/isaaclab/assets/articulation/articulation_data.py Outdated
Comment thread source/isaaclab/isaaclab/assets/articulation/articulation_data.py Outdated
Comment thread source/isaaclab/isaaclab/envs/manager_based_env.py Outdated
Comment thread source/isaaclab/isaaclab/envs/mdp/events.py Outdated
kellyguo11 and others added 11 commits September 17, 2025 10:28
Co-authored-by: James Tigue <166445701+jtigue-bdai@users.noreply.github.com>
Signed-off-by: matthewtrepte <mtrepte@nvidia.com>
Co-authored-by: James Tigue <166445701+jtigue-bdai@users.noreply.github.com>
Signed-off-by: matthewtrepte <mtrepte@nvidia.com>
Co-authored-by: James Tigue <166445701+jtigue-bdai@users.noreply.github.com>
Signed-off-by: matthewtrepte <mtrepte@nvidia.com>
Co-authored-by: James Tigue <166445701+jtigue-bdai@users.noreply.github.com>
Signed-off-by: matthewtrepte <mtrepte@nvidia.com>
Co-authored-by: James Tigue <166445701+jtigue-bdai@users.noreply.github.com>
Signed-off-by: matthewtrepte <mtrepte@nvidia.com>
Co-authored-by: James Tigue <166445701+jtigue-bdai@users.noreply.github.com>
Signed-off-by: matthewtrepte <mtrepte@nvidia.com>
Co-authored-by: James Tigue <166445701+jtigue-bdai@users.noreply.github.com>
Signed-off-by: matthewtrepte <mtrepte@nvidia.com>
Co-authored-by: James Tigue <166445701+jtigue-bdai@users.noreply.github.com>
Signed-off-by: matthewtrepte <mtrepte@nvidia.com>
Co-authored-by: James Tigue <166445701+jtigue-bdai@users.noreply.github.com>
Signed-off-by: matthewtrepte <mtrepte@nvidia.com>
Signed-off-by: matthewtrepte <mtrepte@nvidia.com>
Comment thread source/isaaclab/isaaclab/assets/articulation/articulation.py
Comment thread source/isaaclab/isaaclab/assets/articulation/articulation_data.py
"""

# TODO(mtrepte): do these friction vars need to be renamed as well?
friction: dict[str, float] | float | None = None

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.

maybe we can mark this as deprecated as well and keep it for now for backward support for 4.5 where it's still a coefficient. we can update the docstring to mention in 4.5 it's coeff, and in 5.0+ it's effort. then, we can also create a new static_friction parameter for the new API that will be effort. @jtigue-bdai do you think that would make sense?

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

done, though please check again

@Mayankm96

Copy link
Copy Markdown
Contributor

Let's merge this after #3318 is done since that one has been hanging for a while.

(see :attr:`static_friction`). This field is therefore considered deprecated in newer versions.
"""

static_friction: dict[str, float] | float | None = None

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.

@Mayankm96 @jtigue-bdai are you ok with this change? I think it might make more sense to move towards using static_friction in future releases to differentiate from dynamic_friction

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

In general i think working towards static_friction is a good idea.

Currently it looks like you only add it to the actuator_cfg, I don't see where this get handled by the actuator_base

@jtigue-bdai jtigue-bdai self-requested a review September 24, 2025 20:21
@kellyguo11

Copy link
Copy Markdown
Contributor

I've merged in #3318, we might need some rework on this one to accommodate the changes in the other PR.

@Mayankm96 Mayankm96 moved this to In progress in Isaac Lab Oct 10, 2025
@matthewtrepte matthewtrepte changed the base branch from main to release/2.3.0 October 14, 2025 22:29
@matthewtrepte matthewtrepte changed the base branch from release/2.3.0 to main October 14, 2025 22:33
@Mayankm96

Mayankm96 commented Oct 22, 2025

Copy link
Copy Markdown
Contributor

@matthewtrepte @kellyguo11 Should we close this MR or change it to doc fixes only for now?

We will have another MR which reworks the actuator params more.

@kellyguo11

Copy link
Copy Markdown
Contributor

@matthewtrepte @kellyguo11 Should we close this MR or change it to doc fixes only for now?

We will have another MR which reworks the actuator params more.

Yes, let's make this a doc-only change for now. We can refactor it into the config setup that @jtigue-bdai and team are proposing along with the actuator updates.

kellyguo11 pushed a commit that referenced this pull request Oct 31, 2025
)

# 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
-->
@Mayankm96 Mayankm96 added the duplicate This issue or pull request already exists label Nov 3, 2025
@Mayankm96

Copy link
Copy Markdown
Contributor

Closing in favor of #3869

@Mayankm96 Mayankm96 closed this Nov 3, 2025
@github-project-automation github-project-automation Bot moved this from In progress to Done in Isaac Lab Nov 3, 2025
gattra-rai pushed a commit to gattra-rai/IsaacLab that referenced this pull request Nov 17, 2025
…aac-sim#3869)

<!--
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 - isaac-sim#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. -->

<!-- As you go through the list, delete the ones that are not
applicable. -->

- Documentation update

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.
-->

- [ ] 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
-->
koghalai123 pushed a commit to koghalai123/IsaacLab that referenced this pull request Dec 7, 2025
…aac-sim#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 - isaac-sim#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
-->
Edify0991 pushed a commit to Edify0991/IsaacLab that referenced this pull request Jan 14, 2026
…aac-sim#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 - isaac-sim#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
-->
raymondyu5 pushed a commit to raymondyu5/DexLab that referenced this pull request Jan 15, 2026
…869)

# 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 - isaac-sim/IsaacLab#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
-->
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

duplicate This issue or pull request already exists isaac-lab Related to Isaac Lab team

Projects

Status: Done

Development

Successfully merging this pull request may close these issues.

5 participants