Skip to content
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

Add docs for building Python bindings with built-from-source library #1774

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Add docs for building Python bindings with built-from-source library #1774

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 doc/python.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -482,6 +482,8 @@ Building from source
from GitHub. On macOS, the download corresponds to a DMG file from which you
can drag ``MuJoCo.app`` into your ``/Applications`` folder.

3. Or :ref:`build the library from source<inBuild>`. When configuring the build, use ``cmake $PATH_TO_CLONED_REPO -DCMAKE_INSTALL_PREFIX=<absolute_path_to_my_install_dir>`` to set up an installation directory, and after the build, use ``cmake --install .`` to populate it. Additionally, make a ``<my_install_dir>/plugins`` directory and copy ``libactuator.so, libelasticity.so, libsdf.so, libsensor.so`` from ``<build_dir>/lib`` into it. In the later steps, ``<my_install_dir>`` and ``<my_install_dir>/plugins`` will be ``MUJOCO_PATH`` and ``MUJOCO_PLUGIN_PATH`` respectively.

3. Clone the entire ``mujoco`` repository from GitHub and ``cd`` into the python
directory:

Expand Down Expand Up @@ -512,7 +514,7 @@ Building from source
``mujoco-x.y.z.tar.gz`` file (where ``x.y.z`` is the version number).

6. Use the generated source distribution to build and install the bindings.
You'll need to specify the path to the MuJoCo library you downloaded earlier
You'll need to specify the path to the MuJoCo library you downloaded or built earlier
in the ``MUJOCO_PATH`` environment variable.

.. note::
Expand Down