MuJoCo Warp documentation.

PiperOrigin-RevId: 807693732
Change-Id: I6a49e195eb9f9ac2d562f1aa4745c1206e069caf
This commit is contained in:
Taylor Howell
2025-09-16 07:55:46 -07:00
committed by Copybara-Service
parent afbefc38a6
commit 04380890d5
2 changed files with 70 additions and 1 deletions
+2 -1
View File
@@ -14,7 +14,8 @@
programming/index.rst
APIreference/index.rst
python
MJX <mjx>
MuJoCo XLA <mjx>
MuJoCo Warp <mjwarp/index.rst>
unity
OpenUSD/index.rst
models
+68
View File
@@ -0,0 +1,68 @@
.. _MJW:
====================
MuJoCo Warp (MJWarp)
====================
MuJoCo Warp (MJWarp) is an implementation of MuJoCo written in `Warp <https://nvidia.github.io/warp/>`__ and optimized
for `Nvidia <https://nvidia.com>`__ GPUs. MJWarp lives in the
`google-deepmind/mujoco_warp <https://github.com/google-deepmind/mujoco_warp>`__ GitHub repository and is currently in
beta.
.. _MJW_getstarted:
Getting Started
===============
.. code-block:: python
import mujoco
import mujoco_warp as mjw
mjm = mujoco.MjModel.from_file("example.xml")
m = mjw.put_model(mjm)
d = mjw.make_data(mjm)
mjw.step(m, d)
.. _MJW_install:
Installation
============
The beta version of MuJoCo Warp is installed from GitHub. Please note that the beta version of MuJoCo Warp does not
support all versions of MuJoCo, Warp, CUDA, Nvidia drivers, etc.
.. code-block:: shell
git clone https://github.com/google-deepmind/mujoco_warp.git
cd mujoco_warp
python3 -m venv env
source env/bin/activate
pip install --upgrade pip
pip install uv
uv pip install -e .[dev,cuda]
Test the Installation
.. code-block:: shell
pytest
.. _MJW_Cli:
Utilities
=========
Benchmark an environment with testspeed
.. code-block:: shell
mjwarp-testspeed benchmark/humanoid/humanoid.xml
Interactive environment simulation with MJWarp
.. code-block:: shell
mjwarp-viewer benchmark/humanoid/humanoid.xml