mujoco README

The project's README from github.com/google-deepmind/mujoco. As one markdown file: README.md.

MuJoCo

MuJoCo stands for Multi-Joint dynamics with Contact. It is a general purpose physics engine that aims to facilitate research and development in robotics, biomechanics, graphics and animation, machine learning, and other areas which demand fast and accurate simulation of articulated structures interacting with their environment.

This repository is maintained by Google DeepMind.

MuJoCo has a C API and is intended for researchers and developers. The runtime simulation module is tuned to maximize performance and operates on low-level data structures that are preallocated by the built-in XML compiler. The library includes interactive visualization with a native GUI, rendered in OpenGL. MuJoCo further exposes a large number of utility functions for computing physics-related quantities.

We also provide Python bindings and a plug-in for the Unity game engine.

Documentation

MuJoCo's documentation can be found at mujoco.readthedocs.io. Upcoming features due for the next release can be found in the changelog in the "latest" branch.

Getting Started

There are two easy ways to get started with MuJoCo:

  1. Run simulate on your machine. This video shows a screen capture of simulate, MuJoCo's native interactive viewer. Follow the steps described in the Getting Started section of the documentation to get simulate running on your machine.

  2. Explore our online IPython notebooks. If you are a Python user, you might want to start with our tutorial notebooks running on Google Colab:

Installation

Prebuilt binaries

Versioned releases are available as precompiled binaries from the GitHub releases page, built for Linux (x86-64 and AArch64), Windows (x86-64 only), and macOS (universal). This is the recommended way to use the software.

Building from source

Users who wish to build MuJoCo from source should consult the build from source section of the documentation. However, note that the commit at the tip of the main branch may be unstable.

Python (>= 3.10)

The native Python bindings, which come pre-packaged with a copy of MuJoCo, can be installed from PyPI via:

pip install mujoco

Note that Pre-built Linux wheels target manylinux2014, see here for compatible distributions. For more information such as building the bindings from source, see the Python bindings section of the documentation.

Versioning

We aim to release MuJoCo in the first week of each month. Our versioning standards changed to modified Semantic Versioning in 3.5.0, see versioning for details.

Contributing

We welcome community engagement: questions, requests for help, bug reports and feature requests. To read more about bug reports, feature requests and more ambitious contributions, please see our contributors guide and style guide.

Asking Questions

Questions and requests for help are welcome as a GitHub "Asking for Help" Discussion and should focus on a specific problem or question.

Bug reports and feature requests

GitHub Issues are reserved for bug reports, feature requests and other development-related subjects.

MuJoCo is the backbone for numerous environment packages. Below we list several bindings and converters.

Bindings

These packages give users of various languages access to MuJoCo functionality:

First-party bindings:

Third-party bindings:

Converters

Citation

If you use MuJoCo for published research, please cite:

@inproceedings{todorov2012mujoco,
  title={MuJoCo: A physics engine for model-based control},
  author={Todorov, Emanuel and Erez, Tom and Tassa, Yuval},
  booktitle={2012 IEEE/RSJ International Conference on Intelligent Robots and Systems},
  pages={5026--5033},
  year={2012},
  organization={IEEE},
  doi={10.1109/IROS.2012.6386109}
}

License and Disclaimer

Copyright 2021 DeepMind Technologies Limited.

Box collision code (engine_collision_box.c) is Copyright 2016 Svetoslav Kolev.

ReStructuredText documents, images, and videos in the doc directory are made available under the terms of the Creative Commons Attribution 4.0 (CC BY 4.0) license. You may obtain a copy of the License at https://creativecommons.org/licenses/by/4.0/legalcode.

Source code is licensed under the Apache License, Version 2.0. You may obtain a copy of the License at https://www.apache.org/licenses/LICENSE-2.0.

This is not an officially supported Google product.

mujoco (google-deepmind/mujoco)

Searching Database…

15.8K ·GitHub
Mujoco
Что это такое?MuJoCo — физический движок общего назначения для моделирования сочленённых конструкций, которые взаимодействуют с окружением. Поддерживается Google DeepMind. Применяется в робототехнике, биомеханике, компьютерной графике и анимации, а также в исследованиях машинного обучения.
Это самостоятельное приложение или библиотека, которую я вызываю из кода?Это библиотека на C с нативным интерактивным графическим просмотрщиком simulate, а также официальными привязками для Python, JavaScript/WebAssembly и C#/Unity для программного использования.
Как это запустить?Скачайте готовый бинарный файл со страницы релизов на GitHub и запустите просмотрщик 'simulate' или установите Python-привязки из PyPI через pip для программного использования.
Нужен ли мне Python, чтобы этим пользоваться?Нет, ядро движка и просмотрщик simulate работают самостоятельно из готовых сборок. Python (>=3.10) нужен только в том случае, если вы хотите использовать нативные Python-привязки из PyPI.
Стабильна ли сборка из основной ветки main?Нет, актуальное состояние основной ветки main может быть нестабильным, поэтому для надёжной сборки лучше использовать готовые релизы.
Для кого это предназначено?Для исследователей и разработчиков в робототехнике, биомеханике, компьютерной графике и анимации, а также в машинном обучении, которым нужно быстрое и точное моделирование физики сочленённых тел.
Какие операционные системы официально поддерживаются?Готовые бинарные файлы выпускаются для Linux (x86-64 и AArch64), Windows (x86-64) и macOS (universal binary).
Можно ли использовать MuJoCo вне C и Python?Да, официальные привязки есть для JavaScript/WebAssembly и C#/Unity, а сторонние привязки существуют для MATLAB Simulink, Swift, Java, Julia и Rust.
Можно ли конвертировать модели в MuJoCo из других форматов?Да, сообщество создало инструменты для конвертации моделей OpenSim (MyoConverter), файлов SDFormat (gz-mujoco), файлов OBJ (obj2mjcf) и сборок из Onshape CAD в MJCF — собственный формат моделей MuJoCo.
Что такое MJX?MJX (MuJoCo XLA) — ветка MuJoCo, написанная на JAX. Для неё есть отдельное руководство. Она обеспечивает дифференцируемую физику с аппаратным ускорением для рабочих процессов машинного обучения.
Как часто выходят новые версии?Проект стремится выпускать новую версию в первую неделю каждого месяца, используя модифицированную схему Semantic Versioning, начиная с версии 3.5.0.
What are similar projects?AirSim, project_superdex, kimodo, genesis-world, carla, bullet3, ml-agents, quackd
Which topics is it in?mujoco, unity, physics, opengl, robotics, simulation, reinforcement-learning, wasm, c, c++, deep-learning, research
Creator
google-deepmind
Size
143.8 MB
Stars
15.8K
Updated
CommitOct 19Release3.16.0Oct 14
Age
5y
Commits · 90 Days