Skip to main content

No project description provided

Project description

Mujaco Gym Lite (Jaco2 + MuJoCo)

Build PyPI version License Python 3.10 Lint: flake8 Code style: black Imports: isort

mujaco-gym-lite is a lightweight task suite for robotic manipulation with the Kinova Jaco2 arm in MuJoCo.

It includes:

  • MuJoCo-based manipulation tasks (drawer, button, door, assembly ring, hinged box, lever, soccer, lidded box)
  • Example scripts for scripted demos and environment debugging

Prerequisites

  • Linux (this repository is developed and tested on Linux)
  • Python 3.10
  • MuJoCo Python bindings (mujoco) available in your environment
  • OpenGL/GLFW runtime libraries for rendering

If you run with local rendering and miss system libraries, install them on Ubuntu/Debian:

sudo apt update
sudo apt install -y libglfw3 libgl1 libosmesa6 libopenblas0

Installation

Install from PyPI (recommended)

python3 -m venv .venv
source .venv/bin/activate

pip install --upgrade pip setuptools wheel
pip install mujaco-gym-lite

# Required for MuJoCo tasks
pip install mujoco "gymnasium[mujoco]"

Install from source (development)

git clone <your-fork-or-this-repo-url>
cd mujaco-gym-lite

python3 -m venv .venv
source .venv/bin/activate

pip install --upgrade pip setuptools wheel
pip install -e .

# Required for MuJoCo tasks
pip install mujoco "gymnasium[mujoco]"

Docker (optional)

CUDA 12.6 Docker scripts are included in dockerfiles/cuda126.

cd dockerfiles/cuda126
./build.sh
./launch.sh

Quick Start

Run any demo from the repository root.

python examples/run_drawer_open_demo.py
python examples/run_assembly_ring_demo.py
python examples/run_soccer_demo.py

Some demos support options such as recording:

python examples/run_drawer_open_demo.py --render_mode rgb_array --record

Demo GIF Gallery

Recorded demos converted from examples/demo_result and stored in docs/demo_gifs.

Assembly Ring

Assembly Ring Demo

Button

Button Demo

Drawer

Drawer Demo

Hinged Box Open

Hinged Box Open Demo

Lever Pull

Lever Pull Demo

Lidded Box Reach

Lidded Box Reach Demo

Sliding Door

Sliding Door Demo

Soccer

Soccer Demo

Available Environments

Registered Gymnasium IDs:

  • DrawerRobot-v0
  • ButtonRobot-v0
  • SlidingDoorRobot-v0
  • AssemblyRingRobot-v0
  • HingedBoxRobot-v0
  • LeverRobot-v0
  • SoccerRobot-v0
  • LiddedBoxRobot-v0

Actions, States, and Rewards

Actions

MuJoCo robot environments use gymnasium.spaces.Dict action spaces. Typical keys include:

  • robot/end_effector/position (3D target position)
  • robot/end_effector/rotation (quaternion)
  • robot/home (home command flag)
  • camera/<name>/position, camera/<name>/rotation (for mocap camera control)

Exact keys can vary by task and wrappers.

States (Observations)

Observations are also dictionaries and usually include:

  • Robot state (end-effector pose, joint angles, contacts)
  • Task/object state (for example object pose, handle position, joint positions)
  • Camera outputs when enabled (color/depth/segmentation and camera parameters)
  • Low-level simulator state (qpos, qvel)

Rewards

Rewards are task-specific and generally dense/shaped to support learning. For many manipulation tasks, reward terms combine:

  • Progress toward the task goal (for example object alignment or opening distance)
  • Control/interaction quality (for example grasp or caging quality)
  • A success-related bonus when the task condition is met

Additional reward diagnostics are exposed through the info dictionary (for example reward/* keys and task/success).

Repository Layout

  • mujaco_gym_lite/: main package (environments, builders, wrappers, tools)
  • examples/: runnable demo scripts
  • assets/: object meshes, robot files, textures
  • dockerfiles/: Docker build/run scripts

License

Source code in this repository (excluding asset content) is licensed under the MIT License.

Asset licensing and attribution may differ by source. Please check the files inside the asset directories:

  • assets/objects/metaworld/README.md
  • assets/robots/README.md
  • assets/textures/README.md

Use those asset files as the primary reference for origin and license/usage terms.

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

mujaco_gym_lite-1.0.2.tar.gz (36.2 MB view details)

Uploaded Source

Built Distribution

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

mujaco_gym_lite-1.0.2-py3-none-any.whl (70.7 MB view details)

Uploaded Python 3

File details

Details for the file mujaco_gym_lite-1.0.2.tar.gz.

File metadata

  • Download URL: mujaco_gym_lite-1.0.2.tar.gz
  • Upload date:
  • Size: 36.2 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for mujaco_gym_lite-1.0.2.tar.gz
Algorithm Hash digest
SHA256 68e38a81f9f000c1f94ef36361106b3226aac0293c1eb7ece1e285f6e6104f84
MD5 eb07b2778d6ec6a17ae66438bb7fbc01
BLAKE2b-256 49e157b57c48719ba6dcad14eb76c2df6855a8f7776d41d01cd58dfdd1f4338b

See more details on using hashes here.

Provenance

The following attestation bundles were made for mujaco_gym_lite-1.0.2.tar.gz:

Publisher: deploy.yml on Shunichi09/mujaco-gym-lite

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file mujaco_gym_lite-1.0.2-py3-none-any.whl.

File metadata

File hashes

Hashes for mujaco_gym_lite-1.0.2-py3-none-any.whl
Algorithm Hash digest
SHA256 d84d48716762b120b7e8c45caad6c5bd89c95c5c3d782aa8f78787bb291e56f4
MD5 aa9b90304165131d2f736983026387e8
BLAKE2b-256 f10aa1a4219f9e6b3186260b93e4d659a8edf6c9e4c9189c8e3e147cd6ac68dd

See more details on using hashes here.

Provenance

The following attestation bundles were made for mujaco_gym_lite-1.0.2-py3-none-any.whl:

Publisher: deploy.yml on Shunichi09/mujaco-gym-lite

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

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