Skip to content

Fixes nvbug#5760

Open
myurasov-nv wants to merge 2 commits into
isaac-sim:developfrom
myurasov-nv:my-nvbugs-5
Open

Fixes nvbug#5760
myurasov-nv wants to merge 2 commits into
isaac-sim:developfrom
myurasov-nv:my-nvbugs-5

Conversation

@myurasov-nv
Copy link
Copy Markdown
Member

@myurasov-nv myurasov-nv commented May 23, 2026

Description

Fixes NVBug 5984996.

Type of change

  • Documentation update

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 added a changelog fragment under source/<pkg>/changelog.d/ for every touched package (do not edit CHANGELOG.rst or bump extension.toml since CI handles that)
  • I have added my name to the CONTRIBUTORS.md or my name already exists there

@github-actions github-actions Bot added bug Something isn't working documentation Improvements or additions to documentation isaac-lab Related to Isaac Lab team labels May 23, 2026
Copy link
Copy Markdown

@isaaclab-review-bot isaaclab-review-bot Bot left a comment

Choose a reason for hiding this comment

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

🤖 Isaac Lab Review Bot

Summary

This PR adds a helpful documentation note explaining Windows-specific behavior when _isaac_sim\\setup_conda_env.bat is missing from Isaac Sim binary installations. The change is straightforward: a 10-line .. note:: block in the RST docs and an empty changelog skip file.

Design Assessment

Correct approach - Adding a note directly in the conda environment setup section where users will encounter the issue is the right place.

Appropriate placement - The note is positioned inside the Windows tab-item, right after the conda activate command, which is contextually correct since this is when users would encounter the error.

Findings

RST Syntax Review:

  • ✅ The .. note:: directive is properly formatted
  • ✅ Indentation aligns correctly with the parent Windows tab-item (15 spaces for directive, 18 spaces for content)
  • ✅ Blank line after directive before content body
  • ✅ Inline code formatting with double backticks is correct

Content Review:

  • ✅ Accurately describes the behavior (non-fatal warning → PYTHONPATH error later)
  • ✅ Identifies the root cause (missing setup_conda_env.bat in some binary zips)
  • ✅ Provides actionable solutions (re-extract build or set env vars manually)

Minor observation: The note uses backslash in _isaac_sim\\setup_conda_env.bat which is Windows-appropriate for this context.

Test Coverage

  • Documentation-only change: no tests needed.
  • Changelog skip file correctly added.

CI Status

⏳ CI checks still in progress. One failure observed in isaaclab_tasks [1/3] - appears unrelated to this docs-only PR.

Verdict

No issues found

Clean documentation addition that will help Windows users diagnose a confusing error. Ready to merge once CI passes.


Update (b424ad2): New commit updates ThreeDWorld URL in ecosystem.rst from www.threedworld.org to the GitHub repo github.com/threedworld-mit/tdw. ✅ No issues — valid URL fix for external reference.


Update (6bca1df): Major CI/infrastructure commit with several improvements:

  • Added exclude-pattern input to run-tests and run-package-tests actions for flexible test filtering
  • Replaced Python-level TESTS_TO_SKIP rendering test exclusions with CI-level exclude-pattern: "test_rendering_" on task shard jobs (dedicated rendering-correctness jobs still run them ✅)
  • Folded standalone verify-base-non-root and verify-curobo-non-root jobs into test-isaaclab-ov and test-curobo respectively (saves runner slots while preserving the regression check)
  • Added JUnit XML upload steps across CI workflows for better test reporting
  • Added libgmp-dev to arm64 Dockerfile deps for pytetwild build

No issues found. Parameter position shifts in run-tests shell function are correctly propagated. Legacy "not " merge logic properly combines with explicit exclude-pattern. All changes are consistent and well-commented.

@myurasov-nv myurasov-nv changed the title Document Windows setup_conda_env.bat missing-file behavior Fixes few nvbugs May 23, 2026
@myurasov-nv myurasov-nv marked this pull request as ready for review May 23, 2026 09:52
@greptile-apps
Copy link
Copy Markdown
Contributor

greptile-apps Bot commented May 23, 2026

Greptile Summary

This is a documentation-only closeout PR for a batch of NVBugs, where the runtime fixes were already merged in earlier PRs. The only new content here is a Windows conda install note and a broken-link fix.

  • src_python_virtual_env.rst: Adds a Windows-specific .. note:: block under the Conda tab explaining that some Isaac Sim binary zips omit setup_conda_env.bat, how the silent warning escalates to a visible PYTHONPATH error, and two remediation paths for users.
  • ecosystem.rst: Updates the ThreeDWorld RST link target from the threedworld.org domain (apparently defunct/unreliable) to the canonical GitHub repository at github.com/threedworld-mit/tdw.
  • my-nvbugs-5.skip: Empty towncrier sentinel file that suppresses changelog generation for this doc-only patch.

Confidence Score: 5/5

Documentation-only changes with no runtime code modifications; safe to merge.

Both changed .rst files contain small, targeted edits — a broken external link update and a well-scoped Windows install note — with no logic, configuration, or dependency changes. The .skip file is an empty sentinel that only affects towncrier changelog generation.

No files require special attention.

Important Files Changed

Filename Overview
docs/source/setup/installation/include/src_python_virtual_env.rst Adds a Windows-specific note under the Conda tab explaining what happens when setup_conda_env.bat is missing, with clear remediation steps; well-placed and accurate.
docs/source/setup/ecosystem.rst Updates the ThreeDWorld hyperlink target from the defunct threedworld.org domain to the canonical GitHub repository URL.
source/isaaclab/changelog.d/my-nvbugs-5.skip Empty .skip sentinel file instructs towncrier to skip auto-generating a changelog fragment for this PR; consistent with how the rest of the repo handles doc-only patches.

Flowchart

%%{init: {'theme': 'neutral'}}%%
flowchart TD
    A[User runs isaaclab.bat --conda on Windows] --> B{setup_conda_env.bat present?}
    B -- Yes --> C[Isaac Sim env vars exported successfully]
    B -- No --> D[Non-fatal warning printed]
    D --> E[Isaac Sim env vars NOT exported]
    E --> F["Error: Isaac Sim is not installed or not found on PYTHONPATH"]
    F --> G{Resolution}
    G --> H[Re-extract a build that includes setup_conda_env.bat]
    G --> I[Manually set Isaac Sim env vars before running isaaclab.bat]
Loading

Reviews (2): Last reviewed commit: "Fix broken ThreeDWorld doc link (threedw..." | Re-trigger Greptile

@myurasov-nv
Copy link
Copy Markdown
Member Author

@greptileai review

@myurasov-nv myurasov-nv changed the title Fixes few nvbugs Fixe nvbug May 23, 2026
@myurasov-nv myurasov-nv changed the title Fixe nvbug Fixes nvbug May 23, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

bug Something isn't working documentation Improvements or additions to documentation isaac-lab Related to Isaac Lab team

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant