Skip to content

examples(noitom): package under isaacteleop_examples - #1041

Open
jiwenc-nv wants to merge 1 commit into
jiwenc-nv/examples-camera-vizfrom
jiwenc-nv/examples-noitom
Open

examples(noitom): package under isaacteleop_examples#1041
jiwenc-nv wants to merge 1 commit into
jiwenc-nv/examples-camera-vizfrom
jiwenc-nv/examples-noitom

Conversation

@jiwenc-nv

@jiwenc-nv jiwenc-nv commented Aug 28, 2026

Copy link
Copy Markdown
Collaborator

Description

Part of #985. Stacked on #1040.

The three modules imported each other as top-level modules, and the README documented the consequence rather than fixing it — every Isaac Lab command carried PYTHONPATH=~/IsaacTeleop/examples/noitom:$PYTHONPATH. This moves the tree to the layout in examples/README.md and deletes the prefix.

The example gains its first pyproject.toml. isaaclab and gymnasium are deliberately not dependencies: noitom_tasks.py runs inside an Isaac Lab environment that already provides them, and neither installs from PyPI. The README now says to install into that interpreter, which is what replaces the PYTHONPATH prefix:

./isaaclab.sh -p -m pip install -e ~/IsaacTeleop/examples/noitom

and the callback becomes --external_callback isaacteleop_examples.noitom.noitom_tasks.register_tasks.

One import lived inside a function body, indented, so it needed catching separately from the module-level ones — worth knowing if you review the other trees.

Type of change

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to change)
  • Documentation update

Testing

x86_64 / Ubuntu, Python 3.12. Wheel ships the four modules under isaacteleop_examples/noitom/ with no namespace __init__.py. An AST sweep of the tree confirms no sibling resolves as a top-level import any more.

Not covered, and I cannot cover it: nothing here has a Noitom mocap suit or an Isaac Lab install. The dependency list is inferred from imports, and this example never had one before — a missing runtime dep would only show on the machine with the suit attached. Please run both README paths (the MCAP recording and the Isaac Lab teleop task) before merging.

Checklist

  • I have read and understood the contribution guidelines
  • I have run the linter and formatter with SKIP=check-copyright-year pre-commit run --all-files
  • I have made corresponding changes to the documentation
  • I have added tests that prove my fix/feature works (or explained why not)
  • I have signed off all my commits (git commit -s) per the DCO

No tests: this is a move, and no CI has the hardware.

@coderabbitai

coderabbitai Bot commented Aug 28, 2026

Copy link
Copy Markdown
Contributor

Important

Review skipped

Auto reviews are disabled on base/target branches other than the default branch.

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Enterprise

Run ID: 2b9c85bc-9070-4cab-9652-708a9eabd4ff

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

Use the checkbox below for a quick retry:

  • 🔍 Trigger review

Comment @coderabbitai help to get the list of available commands.

@jiwenc-nv
jiwenc-nv force-pushed the jiwenc-nv/examples-noitom branch from c7b4bc0 to 51d8e55 Compare August 28, 2026 05:00
@jiwenc-nv
jiwenc-nv changed the base branch from jiwenc-nv/examples-deviceio-live-view to jiwenc-nv/examples-camera-viz August 28, 2026 05:01
@jiwenc-nv
jiwenc-nv requested a review from ivany-nv August 28, 2026 05:11
@jiwenc-nv
jiwenc-nv force-pushed the jiwenc-nv/examples-noitom branch from 51d8e55 to ca5b2fc Compare August 28, 2026 05:23
@jiwenc-nv
jiwenc-nv force-pushed the jiwenc-nv/examples-noitom branch from ca5b2fc to 4bd1afe Compare August 28, 2026 05:32
@jiwenc-nv
jiwenc-nv force-pushed the jiwenc-nv/examples-noitom branch from 4bd1afe to d84ed1d Compare August 28, 2026 05:44
@jiwenc-nv
jiwenc-nv force-pushed the jiwenc-nv/examples-noitom branch from d84ed1d to 14876ea Compare August 28, 2026 05:48

@ivany-nv ivany-nv left a comment

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.

Read the diff line by line: the only changes are four bare intra-example imports becoming relative, plus the new pyproject.toml and namespace __init__.py. No logic change.

Not installed by install_python_example(), so there is no install tree to check, and I have no Noitom hardware here — but the diff carries nothing runnable that the move could break.

@jiwenc-nv
jiwenc-nv force-pushed the jiwenc-nv/examples-noitom branch from 14876ea to 1f376e7 Compare August 28, 2026 14:46
The three modules imported each other as top-level modules, and the README
documented the consequence rather than fixing it: every Isaac Lab command
carried `PYTHONPATH=~/IsaacTeleop/examples/noitom:$PYTHONPATH`. Move the tree
to the layout in examples/README.md and delete the prefix.

The example gains its first pyproject.toml. isaaclab and gymnasium are
deliberately not dependencies: noitom_tasks.py runs inside an Isaac Lab
environment that already provides them and neither installs from PyPI, so the
README now says to install into that interpreter -- `./isaaclab.sh -p -m pip
install -e` -- which is what replaces the PYTHONPATH prefix. The task callback
becomes isaacteleop_examples.noitom.noitom_tasks.register_tasks.

One import was inside a function body and indented, so it needed catching
separately from the module-level ones.

Part of #985.

Signed-off-by: Jiwen Cai <jiwenc@nvidia.com>
@jiwenc-nv
jiwenc-nv force-pushed the jiwenc-nv/examples-noitom branch from 1f376e7 to d87282f Compare August 28, 2026 16:11
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants