# mujoco_menagerie **Repository Path**: king58/mujoco_menagerie ## Basic Information - **Project Name**: mujoco_menagerie - **Description**: No description available - **Primary Language**: Unknown - **License**: Apache-2.0 - **Default Branch**: main - **Homepage**: None - **GVP Project**: No ## Statistics - **Stars**: 0 - **Forks**: 0 - **Created**: 2026-05-26 - **Last Updated**: 2026-05-26 ## Categories & Tags **Categories**: Uncategorized **Tags**: None ## README

**Menagerie** is a collection of high-quality models for the [MuJoCo](https://github.com/google-deepmind/mujoco) physics engine, curated by Google DeepMind. A physics simulator is only as good as the model it is simulating, and in a powerful simulator like MuJoCo with many modeling options, it is easy to create "bad" models which do not behave as expected. The goal of this collection is to provide the community with a curated library of well-designed models that work well right out of the gate. - [Getting Started](#getting-started) - [Prerequisites](#prerequisites) - [Overview](#overview) - [Usage](#usage) - [Via `robot-descriptions`](#via-robot-descriptions) - [Via `git clone`](#via-git-clone) - [Model Quality and Contributing](#model-quality-and-contributing) - [Quick contributor setup](#quick-contributor-setup) - [Menagerie Models](#menagerie-models) - [Citing Menagerie](#citing-menagerie) - [Acknowledgments](#acknowledgments) - [Changelog](#changelog) - [License and Disclaimer](#license-and-disclaimer) ## Getting Started ### Prerequisites The minimum required MuJoCo version for each model is specified in its respective README. You can download prebuilt binaries for MuJoCo from the GitHub [releases page](https://github.com/google-deepmind/mujoco/releases/), or if you are working with Python, you can install the native bindings from [PyPI](https://pypi.org/project/mujoco/) via `pip install mujoco`. For alternative installation instructions, see [here](https://github.com/google-deepmind/mujoco#installation). ### Overview The structure of Menagerie is illustrated below. For brevity, we have only included one model directory since all others follow the exact same pattern. ```bash ├── unitree_go2 │ ├── assets │ │ ├── base_0.obj │ │ ├── ... │ ├── go2.png │ ├── go2.xml │ ├── LICENSE │ ├── README.md │ └── scene.xml │ └── go2_mjx.xml │ └── scene_mjx.xml ``` - `assets`: stores the 3D meshes (.stl or .obj) of the model used for visual and collision purposes - `LICENSE`: describes the copyright and licensing terms of the model - `README.md`: contains detailed steps describing how the model's MJCF XML file was generated - `.xml`: contains the MJCF definition of the model - `scene.xml`: includes `.xml` with a plane, a light source and potentially other objects - `.png`: a PNG image of `scene.xml` - `_mjx.xml`: contains an MJX-compatible version of the model. Not all models have an MJX variant. - `scene_mjx.xml`: same as `scene.xml` but loads the MJX variant Note that `.xml` solely describes the model, i.e., no other entity is defined in the kinematic tree. We leave additional body definitions for the `scene.xml` file, as can be seen in the Shadow Hand [`scene.xml`](shadow_hand/scene_right.xml). ### Usage #### Via `robot-descriptions` You can use the opensource [`robot_descriptions`](https://github.com/robot-descriptions/robot_descriptions.py) package to load any model in Menagerie. It is available on PyPI and can be installed via `pip install robot_descriptions`. Once installed, you can load a model of your choice as follows: ```python import mujoco # Loading a specific model description as an imported module. from robot_descriptions import panda_mj_description model = mujoco.MjModel.from_xml_path(panda_mj_description.MJCF_PATH) # Directly loading an instance of MjModel. from robot_descriptions.loaders.mujoco import load_robot_description model = load_robot_description("panda_mj_description") # Loading a variant of the model, e.g. panda without a gripper. model = load_robot_description("panda_mj_description", variant="panda_nohand") ``` #### Via `git clone` You can also directly clone this repository in the directory of your choice: ```bash git clone https://github.com/google-deepmind/mujoco_menagerie.git ``` You can then interactively explore the model using the Python viewer: ```bash python -m mujoco.viewer --mjcf mujoco_menagerie/unitree_go2/scene.xml ``` If you have further questions, please check out our [FAQ](FAQ.md). ## Model Quality and Contributing Our goal is to eventually make all Menagerie models as faithful as possible to the real system they are being modeled after. Improving model quality is an ongoing effort, and the current state of many models is not necessarily as good as it could be. However, by releasing Menagerie in its current state, we hope to consolidate and increase visibility for community contributions. To help Menagerie users set proper expectations around the quality of each model, we introduce the following grading system: | Grade | Description | |-------|-------------------------------------------------------------| | A+ | Values are the product of proper system identification | | A | Values are realistic, but have not been properly identified | | B | Stable, but some values are unrealistic | | C | Conditionally stable, can be significantly improved | The grading system will be applied to each model once a proper system identification toolbox is created. We are currently planning to release this toolbox later this year. For more information regarding contributions, for example to add a new model to Menagerie, see [CONTRIBUTING](CONTRIBUTING.md). ### Quick contributor setup Two commands and you're set up. You need [`uv`](https://docs.astral.sh/uv/) installed; that's the only prerequisite. ```bash make install # one-time: installs pre-commit + git hook make all # run every check CI runs (lint + format + license + XML + tests) ``` After `make install`, the fast checks fire automatically on every `git commit`. Run `make all` before pushing. See [CONTRIBUTING.md](CONTRIBUTING.md) for the full breakdown. ## Menagerie Models > Click any thumbnail below to open the model in an in-browser MuJoCo viewer powered by [live.mujoco.org](https://live.mujoco.org). **Humanoids.** | Preview | Name | DoFs | License | |:---:|---|---|---| |

| ToddlerBot 2XM | 44 | [MIT](toddlerbot_2xm/LICENSE) | **Quadrupeds.** | Preview | Name | DoFs | License | |:---:|---|---|---| |

| Boston Dynamics Spot | 19 | [BSD-3-Clause](boston_dynamics_spot/LICENSE) | **Bipeds.** | Preview | Name | DoFs | License | |:---:|---|---|---| |

| Agility Cassie | 28 | [MIT](agility_cassie/LICENSE) | **Biomechanical.** | Preview | Name | DoFs | License | |:---:|---|---|---| |

| MS-Human-700 | 85 | [Apache-2.0](ms_human_700/LICENSE) | **Dual Arms.** | Preview | Name | DoFs | License | |:---:|---|---|---| |

| ALOHA | 16 | [BSD-3-Clause](aloha/LICENSE) | **Mobile Manipulators.** | Preview | Name | DoFs | License | |:---:|---|---|---| |

| TIAGo++ | 25 | [Apache-2.0](pal_tiago_dual/LICENSE) | **Drones.** | Preview | Name | DoFs | License | |:---:|---|---|---| |

| Bitcraze Crazyflie 2 | 0 | [MIT](bitcraze_crazyflie_2/LICENSE) | **Arms.** | Preview | Name | DoFs | License | |:---:|---|---|---| |

| Yet Another Manipulator (YAM) | 8 | [MIT](i2rt_yam/LICENSE) | **End-effectors.** | Preview | Name | DoFs | License | |:---:|---|---|---| |

| Sharpa Wave | 22 | [Apache-2.0](sharpa_wave/LICENSE) | **Mobile Bases.** | Preview | Name | DoFs | License | |:---:|---|---|---| |

| Robot soccer kit omnidirectional | 64 | [MIT](robot_soccer_kit/LICENSE) | **Miscellaneous.** | Preview | Name | DoFs | License | |:---:|---|---|---| |

| Realsense D435i | 0 | [Apache-2.0](realsense_d435i/LICENSE) | ## Citing Menagerie If you use Menagerie in your work, please use the following citation: ```bibtex @software{menagerie2022github, author = {Zakka, Kevin and Tassa, Yuval and {MuJoCo Menagerie Contributors}}, title = {{MuJoCo Menagerie: A collection of high-quality simulation models for MuJoCo}}, url = {http://github.com/google-deepmind/mujoco_menagerie}, year = {2022}, } ``` ## Acknowledgments The models in this repository are based on third-party models designed by many talented people, and would not have been possible without their generous open-source contributions. We would like to acknowledge all the designers and engineers who made MuJoCo Menagerie possible. We'd like to thank Pedro Vergani for his help with visuals and design. The main effort required to make this repository publicly available was undertaken by [Kevin Zakka](https://kzakka.com/), with help from the Robotics Simulation team at Google DeepMind. This project has also benefited from contributions by members of the broader community — see the [CONTRIBUTORS.md](./CONTRIBUTORS.md) for a full list. ## Changelog For a summary of key updates across the repository, see the [global CHANGELOG.md](./CHANGELOG.md). Each individual model also includes its own `CHANGELOG.md` file with model-specific updates, linked directly from the corresponding README. ## License and Disclaimer XML and asset files in each individual model directory of this repository are subject to different license terms. Please consult the `LICENSE` files under each specific model subdirectory for the relevant license and copyright information. All other content is Copyright 2022 DeepMind Technologies Limited and licensed under the Apache License, Version 2.0. A copy of this license is provided in the top-level LICENSE file in this repository. You can also obtain it from https://www.apache.org/licenses/LICENSE-2.0. This is not an officially supported Google product.