Skip to content

Updates installation instructions for Spark/aarch64#4884

Merged
kellyguo11 merged 3 commits intoisaac-sim:developfrom
myurasov-nv:my-docfix-1
Mar 11, 2026
Merged

Updates installation instructions for Spark/aarch64#4884
kellyguo11 merged 3 commits intoisaac-sim:developfrom
myurasov-nv:my-docfix-1

Conversation

@myurasov-nv
Copy link
Copy Markdown
Member

@myurasov-nv myurasov-nv commented Mar 9, 2026

Description

Updates installation instructions for aarch64 (Spark) to include Python 3.12 dev headers that are needed for quadprog.

Feature Type

Documentation change.

Checklist

  • I have read and understood the contribution guidelines
  • I have run the pre-commit checks with ./isaaclab.sh --format
  • [ x I have made corresponding changes to the documentation
  • My changes generate no new warnings
  • [NA] I have added tests that prove my fix is effective or that my feature works
  • [NA] 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 bug Something isn't working documentation Improvements or additions to documentation labels Mar 9, 2026
@myurasov-nv myurasov-nv changed the title Updates installation instructions for aarch64 (Spark) to include Python 3.12 dev headers Updates installation instructions for Spark/aarch64 Mar 9, 2026
@greptile-apps
Copy link
Copy Markdown
Contributor

greptile-apps Bot commented Mar 9, 2026

Greptile Summary

This PR is a documentation-only change that consistently updates four installation guide files to reflect that quadprog (in addition to the previously documented imgui-bundle) requires compilation from source on aarch64 systems (e.g., DGX Spark), and therefore that python3.12-dev must be installed as a build prerequisite alongside the existing OpenGL/X11 packages.

  • All four affected .rst files receive identical, coherent changes: quadprog is added to the prose, python3.12-dev is prepended to the apt install command, and the description is updated to mention Python dev headers.
  • Minor gap: the "Without these packages, the build will fail with a CMake error…" sentence in index.rst was not updated to describe the distinct error that occurs when python3.12-dev is missing (a C compiler error about missing Python.h, not a CMake/OpenGL error).
  • The python3.12-dev package name is version-pinned to Python 3.12; if the platform Python version ever changes, the documentation will silently point users to the wrong dev headers.

Confidence Score: 5/5

  • Documentation-only change with no code impact; safe to merge.
  • All changes are strictly documentation. The updates are consistent across every affected file and the added apt package is correct for the stated purpose. The two style-level observations (incomplete error description, hardcoded Python version) are minor and do not block correctness.
  • docs/source/setup/installation/index.rst — the "Without these packages" error description should ideally be extended to cover the Python-header failure case.

Important Files Changed

Filename Overview
docs/source/setup/installation/index.rst Adds python3.12-dev to the aarch64 apt prerequisite list and mentions quadprog alongside imgui-bundle; the "Without these packages" error description was not updated to cover the Python-header failure case.
docs/source/setup/installation/include/src_build_isaaclab.rst Consistent update: adds python3.12-dev to the apt command and mentions quadprog in the prose. Python version is hardcoded to 3.12.
docs/source/setup/installation/pip_installation.rst Consistent update mirroring the same changes as the other installation docs for the aarch64 note.
docs/source/setup/installation/isaaclab_pip_installation.rst Consistent update mirroring the same changes as the other installation docs for the aarch64 note.

Flowchart

%%{init: {'theme': 'neutral'}}%%
flowchart TD
    A[Start aarch64 / DGX Spark Installation] --> B{Are prerequisites installed?}
    B -- No --> C[sudo apt install python3.12-dev\nlibgl1-mesa-dev libx11-dev\nlibxcursor-dev libxi-dev\nlibxinerama-dev libxrandr-dev]
    C --> D[Prerequisites ready]
    B -- Yes --> D
    D --> E[pip install Isaac Lab]
    E --> F{Build from source needed?}
    F -- imgui-bundle --> G[Compile imgui-bundle\nRequires OpenGL + X11 headers]
    F -- quadprog --> H[Compile quadprog\nRequires Python 3.12 dev headers]
    G --> I[Installation Complete]
    H --> I
Loading

Last reviewed commit: b1b2d52

Comment thread docs/source/setup/installation/index.rst
Comment thread docs/source/setup/installation/include/src_build_isaaclab.rst
@github-actions github-actions Bot added isaac-lab Related to Isaac Lab team infrastructure labels Mar 9, 2026
Signed-off-by: Kelly Guo <kellyg@nvidia.com>
Comment thread docs/source/setup/installation/pip_installation.rst Outdated
Comment thread docs/source/setup/installation/pip_installation.rst Outdated
Comment thread docs/source/setup/installation/pip_installation.rst Outdated
Co-authored-by: Kelly Guo <kellyg@nvidia.com>
Signed-off-by: Kelly Guo <kellyg@nvidia.com>
@kellyguo11 kellyguo11 merged commit 6866c66 into isaac-sim:develop Mar 11, 2026
8 checks passed
daniela-hase pushed a commit to daniela-hase/IsaacLab that referenced this pull request Mar 30, 2026
# Description

Updates installation instructions for aarch64 (Spark) to include Python
3.12 dev headers that are needed for `quadprog`.

## Feature Type

Documentation change.

## Checklist

- [x] I have read and understood the [contribution
guidelines](https://isaac-sim.github.io/IsaacLab/main/source/refs/contributing.html)
- [x] I have run the [`pre-commit` checks](https://pre-commit.com/) with
`./isaaclab.sh --format`
- [ x I have made corresponding changes to the documentation
- [x] My changes generate no new warnings
- [NA] I have added tests that prove my fix is effective or that my
feature works
- [NA] I have updated the changelog and the corresponding version in the
extension's `config/extension.toml` file
- [x] I have added my name to the `CONTRIBUTORS.md` or my name already
exists there

---------

Signed-off-by: Kelly Guo <kellyg@nvidia.com>
Co-authored-by: Kelly Guo <kellyg@nvidia.com>
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 infrastructure isaac-lab Related to Isaac Lab team

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants