Skip to content

Commit 0438089

Browse files
thowellcopybara-github
authored andcommitted
MuJoCo Warp documentation.
PiperOrigin-RevId: 807693732 Change-Id: I6a49e195eb9f9ac2d562f1aa4745c1206e069caf
1 parent afbefc3 commit 0438089

File tree

2 files changed

+70
-1
lines changed

2 files changed

+70
-1
lines changed

doc/index.rst

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,8 @@
1414
programming/index.rst
1515
APIreference/index.rst
1616
python
17-
MJX <mjx>
17+
MuJoCo XLA <mjx>
18+
MuJoCo Warp <mjwarp/index.rst>
1819
unity
1920
OpenUSD/index.rst
2021
models

doc/mjwarp/index.rst

Lines changed: 68 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,68 @@
1+
.. _MJW:
2+
3+
====================
4+
MuJoCo Warp (MJWarp)
5+
====================
6+
7+
MuJoCo Warp (MJWarp) is an implementation of MuJoCo written in `Warp <https://nvidia.github.io/warp/>`__ and optimized
8+
for `Nvidia <https://nvidia.com>`__ GPUs. MJWarp lives in the
9+
`google-deepmind/mujoco_warp <https://github.com/google-deepmind/mujoco_warp>`__ GitHub repository and is currently in
10+
beta.
11+
12+
.. _MJW_getstarted:
13+
14+
Getting Started
15+
===============
16+
17+
.. code-block:: python
18+
19+
import mujoco
20+
import mujoco_warp as mjw
21+
22+
mjm = mujoco.MjModel.from_file("example.xml")
23+
24+
m = mjw.put_model(mjm)
25+
d = mjw.make_data(mjm)
26+
27+
mjw.step(m, d)
28+
29+
.. _MJW_install:
30+
31+
Installation
32+
============
33+
34+
The beta version of MuJoCo Warp is installed from GitHub. Please note that the beta version of MuJoCo Warp does not
35+
support all versions of MuJoCo, Warp, CUDA, Nvidia drivers, etc.
36+
37+
.. code-block:: shell
38+
39+
git clone https://github.com/google-deepmind/mujoco_warp.git
40+
cd mujoco_warp
41+
python3 -m venv env
42+
source env/bin/activate
43+
pip install --upgrade pip
44+
pip install uv
45+
uv pip install -e .[dev,cuda]
46+
47+
Test the Installation
48+
49+
.. code-block:: shell
50+
51+
pytest
52+
53+
.. _MJW_Cli:
54+
55+
Utilities
56+
=========
57+
58+
Benchmark an environment with testspeed
59+
60+
.. code-block:: shell
61+
62+
mjwarp-testspeed benchmark/humanoid/humanoid.xml
63+
64+
Interactive environment simulation with MJWarp
65+
66+
.. code-block:: shell
67+
68+
mjwarp-viewer benchmark/humanoid/humanoid.xml

0 commit comments

Comments
 (0)