Skip to content

docs: add nlopt system dependency prerequisite #456

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
alceops wants to merge 1 commit into from
Closed

docs: add nlopt system dependency prerequisite #456

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 3 additions & 1 deletion docs/source/getting_started/build_from_source/index.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand All @@ -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):

Expand Down
8 changes: 8 additions & 0 deletions docs/source/getting_started/quick_start.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down