Skip to content

docs: nlopt wheel build for aarch64 (fixes #452)#589

Merged
jiwenc-nv merged 2 commits into
NVIDIA:mainfrom
jiwenc-nv:jiwenc/fix-nlopt-on-aarch64
Jun 3, 2026
Merged

docs: nlopt wheel build for aarch64 (fixes #452)#589
jiwenc-nv merged 2 commits into
NVIDIA:mainfrom
jiwenc-nv:jiwenc/fix-nlopt-on-aarch64

Conversation

@jiwenc-nv

@jiwenc-nv jiwenc-nv commented May 30, 2026

Copy link
Copy Markdown
Collaborator

Summary

  • PyPI has no pre-built nlopt wheels for ARM64, causing pip install 'isaacteleop[retargeters,...]' to fail on aarch64 hosts (e.g. NVIDIA DGX Spark) — reported in libnlopt-dev system dependency undocumented in Quick Start and Build from Source guides #452.
  • Adds a note to the Build from Source guide with step-by-step instructions to build an nlopt wheel from source using swig + cmake + DanielBok/nlopt-python v2.10.0 (same approach used in examples/teleop_ros2/Dockerfile).
  • Also quotes all isaacteleop[extras] package specs in shell code blocks to prevent shell glob expansion.

Test plan

  • Follow the new ARM64 note on an aarch64 host; confirm nlopt wheel builds and uv pip install succeeds.
  • Verify no change in behaviour on x86-64 (note is clearly scoped to ARM64 only).
  • Build the docs (sphinx) and check the note renders correctly in HTML.

Closes #452

🤖 Generated with Claude Code

Summary by CodeRabbit

  • Documentation
    • Updated installation instructions for ARM64 systems installing the retargeters extra, including a workaround for building nlopt from source due to missing pre-built wheels on PyPI.
    • Enhanced installation commands for both pip and uv pip to use local wheel caches.

Review Change Stack

@github-actions

Copy link
Copy Markdown
Contributor

📝 Docs preview is not auto-deployed for fork PRs.

A maintainer with write access to NVIDIA/IsaacTeleop can deploy a preview by
commenting /preview-docs on this PR. Once deployed, the preview
will live at:

https://nvidia.github.io/IsaacTeleop/preview/pr-589/

@coderabbitai

coderabbitai Bot commented May 30, 2026

Copy link
Copy Markdown
Contributor

Important

Review skipped

Auto incremental reviews are disabled on this repository.

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: 6cb118d2-c62d-473b-bf9d-056e1e8609cc

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
📝 Walkthrough

Walkthrough

This change updates the Build from Source documentation to address ARM64/aarch64 systems where pre-built nlopt wheels do not exist on PyPI. The update adds a platform-specific note and detailed instructions for building the nlopt Python wheel from source using nlopt-python. The pip and uv pip installation commands for isaacteleop[retargeters,cloudxr,ui] are then updated to reference both the locally cached project wheels and the temporary nlopt wheel directory, with quoted extra specifier strings.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~10 minutes

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Linked Issues check ✅ Passed The PR addresses issue #452 by documenting nlopt wheel building instructions for aarch64, enabling pip installs to succeed when pre-built wheels are unavailable.
Out of Scope Changes check ✅ Passed All changes are scoped to the Build from Source documentation to address the aarch64 nlopt installation issue; no unrelated modifications detected.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Title check ✅ Passed The title accurately summarizes the main change: documenting an nlopt wheel build workaround for ARM64 architecture, with a direct reference to the fixed issue #452.
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests

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

@coderabbitai coderabbitai Bot 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.

Actionable comments posted: 1

🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

Inline comments:
In `@docs/source/getting_started/build_from_source/index.rst`:
- Around line 291-293: The documentation uses an undefined shell variable
`${PYTHON_VERSION}` in the uv command, which will break the build instructions;
update the block that contains "uv venv --python=${PYTHON_VERSION}
/tmp/nlopt-wheel-venv" to either (A) add a preceding instruction that defines
PYTHON_VERSION (for example export PYTHON_VERSION=3.11) or (B) replace the
`--python=${PYTHON_VERSION}` with a concrete version (e.g., --python=3.11) or
remove the `--python` flag to use the system default, and ensure the adjacent
commands ("VIRTUAL_ENV=..." and "/tmp/nlopt-wheel-venv/bin/python setup.py
bdist_wheel -d /tmp/nlopt-wheels/") remain consistent with the chosen approach.
🪄 Autofix (Beta)

Fix all unresolved CodeRabbit comments on this PR:

  • Push a commit to this branch (recommended)
  • Create a new PR with the fixes

ℹ️ Review info
⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Enterprise

Run ID: cf6d5852-9af2-40b2-b6e6-1c573631f766

📥 Commits

Reviewing files that changed from the base of the PR and between 44c47e3 and cf65284.

📒 Files selected for processing (1)
  • docs/source/getting_started/build_from_source/index.rst

Comment thread docs/source/getting_started/build_from_source/index.rst Outdated
@jiwenc-nv jiwenc-nv changed the title docs: document nlopt wheel build for aarch64 (fixes #452) docs: nlopt wheel build for aarch64 (fixes #452) May 30, 2026
@jiwenc-nv

Copy link
Copy Markdown
Collaborator Author

/preview-docs

@github-actions

Copy link
Copy Markdown
Contributor

✅ Preview deployed: https://NVIDIA.github.io/IsaacTeleop/preview/pr-589/

PyPI has no pre-built nlopt wheels for ARM64, causing retargeters
installs to fail on aarch64 hosts (e.g. DGX Spark). Add a note to
the Build from Source guide with step-by-step instructions to build
an nlopt wheel from source (swig + cmake + DanielBok/nlopt-python
2.10.0) and use --find-links to supply it during isaacteleop install.
Also quote all isaacteleop[extras] specs to prevent shell glob expansion.

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
@jiwenc-nv jiwenc-nv force-pushed the jiwenc/fix-nlopt-on-aarch64 branch from cf65284 to 28b9558 Compare May 30, 2026 16:42
Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>
@jiwenc-nv jiwenc-nv merged commit 8309bdd into NVIDIA:main Jun 3, 2026
44 checks passed
@jiwenc-nv jiwenc-nv deleted the jiwenc/fix-nlopt-on-aarch64 branch June 3, 2026 06:08
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.

libnlopt-dev system dependency undocumented in Quick Start and Build from Source guides

2 participants