From 15145c0098d2d38ba2d9336263464533425c4b2c Mon Sep 17 00:00:00 2001 From: Taylor Howell Date: Mon, 8 Dec 2025 07:49:19 -0800 Subject: [PATCH] MuJoCo Warp documentation: Compilation. PiperOrigin-RevId: 841761913 Change-Id: Ic1b1942a47299db48c424ad1f9e3709b05acc55e --- doc/mjwarp/index.rst | 27 +++++++++++++++++++++++++++ 1 file changed, 27 insertions(+) diff --git a/doc/mjwarp/index.rst b/doc/mjwarp/index.rst index 11a45c92..ba0dd380 100644 --- a/doc/mjwarp/index.rst +++ b/doc/mjwarp/index.rst @@ -440,3 +440,30 @@ Orientations are represented as unit quaternions and follow :ref:`MuJoCo's conve operations and instead implements quaternion routines that follow MuJoCo's conventions. Please see `math.py `__ for the implementations. + +Compilation +----------- + +**How can compilation time be improved?** + +Limit the number of unique colliders that require the general convex collision pipeline. These colliders are listed as +``_CONVEX_COLLISION_PAIRS`` in +`collision_convex.py `__. +Improvements to the compilation time for the pipeline are tracked in this +`GitHub issue `__. + +**Why are the physics not working as expected after upgrading MJWarp?** + +The Warp cache may be incompatible with the current code and should be cleared as part of the debugging process. This +can be accomplished by deleting the directory ``~/.cache/warp`` or via Python + +.. code-block:: python + + import warp as wp + wp.clear_kernel_cache() + +**Is it possible to compile MJWarp ahead of time instead of at runtime?** + +Yes. Please see Warp's +`Ahead-of-Time Compilation Workflows `__ +documentation for details.