mujoco-python-viewer

0.1.4last stable release 1 year ago
Complexity Score
Low
Open Issues
N/A
Dependent Projects
3
Weekly Downloadsglobal
1,142

License

  • BSD-2-Clause
    • Yesattribution
    • Permissivelinking
    • Permissivedistribution
    • Permissivemodification
    • Nopatent grant
    • Yesprivate use
    • Permissivesublicensing
    • Notrademark grant

Downloads

Readme

Viewer for MuJoCo in Python

Interactive renderer to use with the official Python bindings for MuJoCo.

Starting with version 2.1.2, MuJoCo comes with native Python bindings officially supported by the MuJoCo devs.

If you have been a user of mujoco-py, you might be looking to migrate.
Some pointers on migration are available here.

Install

$ git clone https://github.com/rohanpsingh/mujoco-python-viewer
$ cd mujoco-python-viewer
$ pip install -e .

Or, install via Pip.

$ pip install mujoco-python-viewer

Usage

How to render in a window?

import mujoco
import mujoco_viewer

model = mujoco.MjModel.from_xml_path('humanoid.xml')
data = mujoco.MjData(model)

# create the viewer object
viewer = mujoco_viewer.MujocoViewer(model, data)

# simulate and render
for _ in range(10000):
    if viewer.is_alive:
        mujoco.mj_step(model, data)
        viewer.render()
    else:
        break

# close
viewer.close()

The render should pop up and the simulation should be running.
A more complete example script can be found here.

Double-click on a geom and hold Ctrl to apply forces (using right mouse button) and torques (using left mouse button).

Press ESC to quit.
Other key bindings are shown in the overlay menu (Press H or hold Alt).

How to render offscreen?

import mujoco
import mujoco_viewer

model = mujoco.MjModel.from_xml_path('humanoid.xml')
data = mujoco.MjData(model)

viewer = mujoco_viewer.MujocoViewer(model, data, 'offscreen')
mujoco.mj_forward(model, data)
img = viewer.read_pixels(camid=2)
## do something cool with img

Optional Parameters

  • title: set the title of the window, for example: viewer = mujoco_viewer.MujocoViewer(model, data, title='My Demo') (defaults to mujoco-python-viewer).
  • width: set the window width, for example: viewer = mujoco_viewer.MujocoViewer(model, data, width=300) (defaults to full screen’s width).
  • height: set the window height, for example: viewer = mujoco_viewer.MujocoViewer(model, data, height=300) (defaults to full screen’s height).
  • hide_menus: set whether the overlay menus should be hidden or not (defaults to False).

Dependencies

CVE IssuesActive
0
Scorecards Score
3.60
Test Coverage
No Data
Follows Semver
Yes
Github Stars
172
Dependenciestotal
4
DependenciesOutdated
0
DependenciesDeprecated
0
Threat Modelling
No Data
Repo Audits
No Data

Learn how to distribute mujoco-python-viewer in your own private PyPI registry

pip install mujoco-python-viewer
Processing...
Done

10 Releases

PyPI on Cloudsmith

Getting started with PyPI on Cloudsmith is fast and easy.