Skip to content

Adds isaaclab_teleop as dependency of isaaclab_mimic during mimic only install#5820

Merged
peterd-NV merged 2 commits into
isaac-sim:developfrom
peterd-NV:peterd/add_teleop_dep_to_mimic
May 28, 2026
Merged

Adds isaaclab_teleop as dependency of isaaclab_mimic during mimic only install#5820
peterd-NV merged 2 commits into
isaac-sim:developfrom
peterd-NV:peterd/add_teleop_dep_to_mimic

Conversation

@peterd-NV
Copy link
Copy Markdown
Collaborator

Description

Adds isaaclab_teleop as a dep to isaaclab_mimic when using ./isaaclab.sh -i mimic

Fixes # (issue)

Previously when a user installs just mimic and tried to run data generation, an error would occur as isaaclab teleop was not installed. This change fixes the import error.

Type of change

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

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-mimic Related to Isaac Mimic team label May 27, 2026
@greptile-apps
Copy link
Copy Markdown
Contributor

greptile-apps Bot commented May 27, 2026

Greptile Summary

This PR fixes a missing-import error when running mimic data generation after a ./isaaclab.sh -i mimic install by adding isaaclab_teleop to the mimic entry in OPTIONAL_ISAACLAB_SUBMODULES. The append_submodules_once helper already deduplicates, so combining mimic,teleop in a single install command remains safe.

  • install.py: mimic tuple changed from (\"isaaclab_mimic\",) to (\"isaaclab_teleop\", \"isaaclab_mimic\") so teleop is installed first, satisfying mimic's import dependency.
  • test_install_command_parsing.py: assertion updated to match the new tuple.
  • Changelog in isaaclab_mimic incorrectly states the change was also made in config/extension.toml, which was not modified in this PR.

Confidence Score: 4/5

The install fix is minimal and correct; the only issue is a misleading sentence in one changelog file.

The core change in install.py is a one-line tuple expansion that correctly places isaaclab_teleop before isaaclab_mimic, and the deduplication guard in append_submodules_once ensures no double-install occurs when both mimic and teleop are requested. The test is updated to match. The only imperfection is the isaaclab_mimic changelog entry, which claims a config/extension.toml modification that was never made.

source/isaaclab_mimic/changelog.d/isaaclab-teleop-dep.rst — the first sentence references an extension.toml change that does not exist in this PR.

Important Files Changed

Filename Overview
source/isaaclab/isaaclab/cli/commands/install.py Adds isaaclab_teleop as the first element in the mimic install tuple; append_submodules_once already deduplicates, so concurrent mimic,teleop installs are safe.
source/isaaclab/test/cli/test_install_command_parsing.py Test assertion updated to match the new two-element tuple for mimic; covers the constant correctly.
source/isaaclab_mimic/changelog.d/isaaclab-teleop-dep.rst Changelog entry incorrectly claims isaaclab_teleop was added to config/extension.toml, but that file was not changed in this PR.
source/isaaclab/changelog.d/peterd-mimic-installs-teleop.rst Accurate changelog fragment describing the install.py behaviour change.

Flowchart

%%{init: {'theme': 'neutral'}}%%
flowchart TD
    A["./isaaclab.sh -i mimic"] --> B["split_install_items('mimic')"]
    B --> C{"name in OPTIONAL_ISAACLAB_SUBMODULES?"}
    C -- yes --> D["append_submodules_once(('isaaclab_teleop', 'isaaclab_mimic'))"]
    D --> E{"pkg_dir already in list?"}
    E -- no --> F["Append to submodules_to_install"]
    E -- yes --> G["Skip (deduplicated)"]
    F --> H["pip install -e source/isaaclab_teleop"]
    F --> I["pip install -e source/isaaclab_mimic"]
    H --> I
Loading

Reviews (1): Last reviewed commit: "make isaaclab_teleop a dep of isaaclab_m..." | Re-trigger Greptile

Comment thread source/isaaclab_mimic/changelog.d/isaaclab-teleop-dep.rst Outdated
Signed-off-by: peterd-NV <peterd@nvidia.com>
@peterd-NV peterd-NV merged commit 0f808f6 into isaac-sim:develop May 28, 2026
82 of 85 checks passed
kellyguo11 added a commit that referenced this pull request May 28, 2026
… teleop/mimic dependency (#5829)

# Description

Cherry pick bug fix PRs from develop:

- #5821
- #5820
- #5733
- #5824

---------

Signed-off-by: peterd-NV <peterd@nvidia.com>
Co-authored-by: peterd-NV <peterd@nvidia.com>
Co-authored-by: ooctipus <zhengyuz@nvidia.com>
Co-authored-by: matthewtrepte <mtrepte@nvidia.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

isaac-mimic Related to Isaac Mimic team

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants