From 1f7086f85ed563cb753dcfc2bb536391e2ceabfb Mon Sep 17 00:00:00 2001 From: orion kindel Date: Mon, 23 Feb 2026 14:17:20 -0600 Subject: [PATCH] rename and finish --- doc/Modeling.rst | 1912 +++++++++++++++++ .../XMLReference.rst | 0 src/Mujoco.MJCF.Actuator.purs | 2 +- src/Mujoco.MJCF.Asset.purs | 2 +- src/Mujoco.MJCF.Body.purs | 2 +- src/Mujoco.MJCF.Common.purs | 4 +- src/Mujoco.MJCF.Contact.purs | 2 +- src/Mujoco.MJCF.Custom.purs | 28 + src/Mujoco.MJCF.Default.purs | 34 + src/Mujoco.MJCF.Deformable.Flex.purs | 2 +- src/Mujoco.MJCF.Deformable.Skin.purs | 2 +- src/Mujoco.MJCF.Deformable.purs | 2 +- src/Mujoco.MJCF.Equality.purs | 2 +- src/Mujoco.MJCF.Extension.purs | 14 + src/Mujoco.MJCF.Geom.purs | 4 +- src/Mujoco.MJCF.Keyframe.purs | 17 + src/Mujoco.MJCF.Keyword.purs | 68 +- src/Mujoco.MJCF.Meta.purs | 2 +- ....Prelude.purs => Mujoco.MJCF.Prelude.purs} | 6 +- src/Mujoco.MJCF.Sensor.purs | 231 ++ src/Mujoco.MJCF.Tendon.purs | 2 +- src/Mujoco.MJCF.Visual.purs | 106 + ...de.Prop.purs => Mujoco.MJCF.XML.Prop.purs} | 2 +- ...oco.XML.Node.purs => Mujoco.MJCF.XML.purs} | 6 +- src/Mujoco.MJCF.purs | 6 +- test/Main.purs | 4 +- ...de.Prop.purs => Mujoco.MJCF.XML.Prop.purs} | 6 +- test/Mujoco.MJCF.purs | 4 +- test/Mujoco.Wasm.purs | 2 +- 29 files changed, 2441 insertions(+), 33 deletions(-) create mode 100644 doc/Modeling.rst rename src/Mujoco.MJCF.Reference.rst => doc/XMLReference.rst (100%) create mode 100644 src/Mujoco.MJCF.Custom.purs create mode 100644 src/Mujoco.MJCF.Default.purs create mode 100644 src/Mujoco.MJCF.Extension.purs create mode 100644 src/Mujoco.MJCF.Keyframe.purs rename src/{Mujoco.Prelude.purs => Mujoco.MJCF.Prelude.purs} (90%) create mode 100644 src/Mujoco.MJCF.Sensor.purs create mode 100644 src/Mujoco.MJCF.Visual.purs rename src/{Mujoco.XML.Node.Prop.purs => Mujoco.MJCF.XML.Prop.purs} (97%) rename src/{Mujoco.XML.Node.purs => Mujoco.MJCF.XML.purs} (95%) rename test/{Mujoco.XML.Node.Prop.purs => Mujoco.MJCF.XML.Prop.purs} (93%) diff --git a/doc/Modeling.rst b/doc/Modeling.rst new file mode 100644 index 0000000..9308122 --- /dev/null +++ b/doc/Modeling.rst @@ -0,0 +1,1912 @@ +======== +Modeling +======== + +Introduction +------------ + +MuJoCo can load XML model files in its native **MJCF** format, as well as in the popular but more limited **URDF** +format. This chapter is the MJCF modeling guide. The reference manual is available in the :doc:`XMLreference` +chapter. The URDF documentation can be found elsewhere; here we only describe +MuJoCo-specific :ref:`URDF extensions `. + +MJCF models can represent complex dynamical systems with a wide range of features and model elements. Accessing all +these features requires a rich modeling format, which can become cumbersome if it is not designed with usability in +mind. Therefore we have made an effort to design MJCF as a scalable format, allowing users to start small and build +more detailed models later. Particularly helpful in this regard is the extensive :ref:`default setting ` +mechanism inspired by the idea of Cascading Style Sheets (CSS) inlined in HTML. It enables users to rapidly create +new models and experiment with them. Experimentation is further aided by numerous :ref:`options