mujoco_mpc icon indicating copy to clipboard operation
mujoco_mpc copied to clipboard
verified publisher icon google-deepmind

Improve installation instructions

Open thowell opened this issue 1 year ago • 0 comments

This PR aims to improve installation instructions based on feedback from @vikashplus and this blog post.

Key changes:

  • Provide explicit steps for installing and running the C++ GUI application including configure, build, run, and test based on the Github actions. The VSCode instructions remain with minor clarifications.
  • Move "prerequisites" section for Ubuntu and macOS dependencies to beginning of installation instructions.
  • Specify OS versions that are tested (Ubuntu 20.04 and macOS-12).
  • Note that gRPC is a large dependency and takes time to install.
  • Instruct to use clang-12 instead of just recommending.
  • Python API instructs specify a Python version and using a conda environment.
  • Python API example is changed to the MJPC GUI.
  • Python API setup now defaults to "release" instead of "debug".
  • Python API setup now specifies Python version +3.10

I tested the new instructions on macOS-12 and Ubuntu 22.04.

thowell avatar May 19 '24 17:05 thowell