From 970a93732c64f3f562759df7457d63496031af54 Mon Sep 17 00:00:00 2001 From: alceops Date: Fri, 1 May 2026 17:08:38 -0400 Subject: [PATCH] docs: add nlopt system dependency prerequisite --- docs/source/getting_started/build_from_source/index.rst | 4 +++- docs/source/getting_started/quick_start.rst | 8 ++++++++ 2 files changed, 11 insertions(+), 1 deletion(-) diff --git a/docs/source/getting_started/build_from_source/index.rst b/docs/source/getting_started/build_from_source/index.rst index 6dc33bbc2..374f06485 100644 --- a/docs/source/getting_started/build_from_source/index.rst +++ b/docs/source/getting_started/build_from_source/index.rst @@ -23,6 +23,8 @@ Prerequisites - **C++20** compatible compiler - **Python** 3.10, 3.11, 3.12, or 3.13 (default 3.11; see ``ISAAC_TELEOP_PYTHON_VERSION`` in root ``CMakeLists.txt``) - **uv** for Python dependency management and managed Python +- **NLopt development headers** (``libnlopt-dev`` on Ubuntu) when Python installs ``nlopt`` + from source - **Internet connection** for downloading dependencies via CMake FetchContent .. _one-time-setup: @@ -36,7 +38,7 @@ the list of dependencies. On **Ubuntu**, install build tools and clang-format: .. code-block:: bash sudo apt-get update - sudo apt-get install -y build-essential cmake libx11-dev clang-format-14 ccache patchelf + sudo apt-get install -y build-essential cmake libx11-dev clang-format-14 ccache patchelf libnlopt-dev Runtime-only dependencies (needed to actually run teleop, not to build): diff --git a/docs/source/getting_started/quick_start.rst b/docs/source/getting_started/quick_start.rst index bd257c40b..76cb716c6 100644 --- a/docs/source/getting_started/quick_start.rst +++ b/docs/source/getting_started/quick_start.rst @@ -30,6 +30,14 @@ to clone the repository for a couple quick samples to run. In a new terminal, install the package from PyPI (or from a local wheel if you built from source): +On Ubuntu systems, install the system package needed when the ``nlopt`` Python dependency builds +from source (for example on Linux ``aarch64`` where a pre-built wheel may not be available): + +.. code-block:: bash + + sudo apt-get update + sudo apt-get install -y libnlopt-dev + .. code-block:: bash # From PyPI