Skip to main content

A unified framework for implementing and interfacing with MuJoCo and MuJoCo-XLA simulation environments.

Project description

moojoco-banner

MooJoCo provides a unified framework for implementing and interfacing with MuJoCo and MuJoCo-XLA simulation environments. The main goal of this framework is to unify the development and interfaces of environments implemented in native MuJoCo (MJC) and MuJoCo-XLA (MJX).

MJCFMorphology and MJCFArena

  • Both are parameterized/reconfigurable MJCF (MuJoCo-XML) generators that serve as input to an environment.
  • MJCFMorphology defines the robot morphology.
  • MJCFArena defines the arena in which the robot is places (i.e. all non-morphological structures).
    • MJCFArena are reconfigurable via a ArenaConfiguration

Unified MJC and MJX environment interface

  • Reconfigurable through an environment configuration
  • Functional programming
    • MJX requires the functional programming paradigm. To unify MJC and MJX, we thus apply this stronger coding constraint to the MJC side as well.
    • Simply said: functions are pure, and should not have side effects.
    • Environments expect states and return states.
  • Gymnasium-like interface
    • Environments provide an observation and action space (automatically)
    • Outside code interacts with the environment using the typical step, reset, render and close functions.
    • Main difference with the original gymnasium interface: here the environment returns and expects states, which encapsulates the original observations, rewards, info, etc. in a datastructure, together with the underlying physics state.
  • Differences between MJCEnv (i.e. a native MuJoCo environment) and MJXEnv (i.e. an MJX environment):
    • development: MJXEnv's should be implemented in JAX, MJCEnv's do not necessarily require JAX.
    • usage: MJXEnvState contains JAX arrays (and the additional mjx.Model and mjx.Data structures), the MJCEnvState uses numpy arrays.
  • Observations are implemented using Observables; these define retriever functions that extract the observation based on the state datastructure and provide an easy way to implement observations.
  • DualMuJocoEnvironment provides the unification of MJC and MJX, and allows conditional environment creation based on a backend string.
  • Both MJC and MJX support human-mode and rgb_array rendering modes.
    • Note: MJX rendering is slow due to the offloading of datastructures of the GPU

Examples

For practical applications and demonstrations of MooJoCo, please refer to the Bio-inspired Robotics Testbed, which employs this framework extensively.

Installation

pip install moojoco

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

moojoco-1.0.3.tar.gz (21.7 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

moojoco-1.0.3-py3-none-any.whl (24.7 kB view details)

Uploaded Python 3

File details

Details for the file moojoco-1.0.3.tar.gz.

File metadata

  • Download URL: moojoco-1.0.3.tar.gz
  • Upload date:
  • Size: 21.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.0.0 CPython/3.12.2

File hashes

Hashes for moojoco-1.0.3.tar.gz
Algorithm Hash digest
SHA256 1a1123de32ed2edc183bdacccf2fb204f5ddb6769f394f26849158b039e33778
MD5 77b9a4dee2f8f7fc8a592ee529754d04
BLAKE2b-256 45003af0529e427d6ff823d0c2b355bc94883634cc832cc86e2fe0b5a87d23fd

See more details on using hashes here.

File details

Details for the file moojoco-1.0.3-py3-none-any.whl.

File metadata

  • Download URL: moojoco-1.0.3-py3-none-any.whl
  • Upload date:
  • Size: 24.7 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.0.0 CPython/3.12.2

File hashes

Hashes for moojoco-1.0.3-py3-none-any.whl
Algorithm Hash digest
SHA256 238619ab24f202b3ba8f75ffed4d671bfff95879a0f47db87251d1e1810193be
MD5 f3598a0510446621faec1ca986a82e42
BLAKE2b-256 82f51894619f3e7f083529301618d0c9668784afceb810dd4637da2012bf2425

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page