diff --git a/python/README.md b/python/README.md index fe9c9685..4cc33b64 100644 --- a/python/README.md +++ b/python/README.md @@ -25,8 +25,6 @@ most users who access MuJoCo through Python. For example, the `egl`, `glfw`, and ## Installation -### PyPI (Recommended) - The recommended way to install this package is via [PyPI](https://pypi.org/project/mujoco/): ```sh @@ -43,58 +41,8 @@ Python bindings (or are trying to run on exceptionally old Linux systems). If that's not the case, then we recommend installing the prebuilt binaries from PyPI. -1. Make sure you have CMake and a C++17 compiler installed. - -1. Download the [latest binary release](https://github.com/deepmind/mujoco/releases) - from GitHub. On macOS, the download corresponds to a DMG file from which you - can drag `MuJoCo.app` into your `/Applications` folder. - -1. Clone the entire `mujoco` repository from GitHub and `cd` into the python - directory. - - ```bash - git clone https://github.com/deepmind/mujoco.git - cd mujoco/python - ``` - -1. Create a virtual environment: - - ```bash - python3 -m venv /tmp/mujoco - source /tmp/mujoco/bin/activate - ``` - -1. Generate a [source distribution](https://packaging.python.org/en/latest/glossary/#term-Source-Distribution-or-sdist) - tarball with the `make_sdist.sh` script. - - ```bash - cd python - bash make_sdist.sh - ``` - - The `make_sdist.sh` script generates additional C++ header files that are - needed to build the bindings, and also pulls in required files from elsewhere - in the repository outside the `python` directory into the sdist. Upon - completion, the script will create a `dist` directory with a - `mujoco-x.y.z.tar.gz` file (where `x.y.z` is the version number). - -1. 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 - in the `MUJOCO_PATH` environment variable. - - **Note**: For macOS, this can be the path to a directory that contains the - `mujoco.framework`. In particular, you can set - `MUJOCO_PATH=/Applications/MuJoCo.app` if you installed MuJoCo as suggested - in step 1. - - ```bash - cd dist - MUJOCO_PATH=/PATH/TO/MUJOCO pip install mujoco-x.y.z.tar.gz - ``` - -The Python bindings should now be installed! To check that they've been -successfully installed, `cd` outside of the `mujoco` directory and run -`python -c "import mujoco"`. +If you need to build the Python bindings from source, please consult +[the documentation](https://mujoco.readthedocs.io/en/latest/python.html#building-from-source). ## Usage