Skip to main content

robotdesigner

Programmatically generate N-DOF robot arm models and register them as simulation environments.

  • Composer — build a mujoco.MjSpec for any N-DOF arm with position or torque control
  • Gymnasium env — wrap the spec as a standard gym.Env for CPU-based RL
  • MJX env — wrap the spec as a JAX-native env for GPU/TPU-accelerated simulation (jit, vmap)

Requirements

  • Python ≥ 3.13
  • MuJoCo ≥ 3.6

Installation

pip install robotdesigner

Or with uv:

uv add robotdesigner

Build a robot arm spec

from robotdesigner.mujoco.composer import build_arm, save_arm

# 3-DOF arm, position control, default z/y alternating joint orientations
spec = build_arm(ndof=3, control="pos")

# Custom joint orientations (cycles if shorter than ndof)
spec = build_arm(ndof=3, control="torque", joint_orientation=["z", "y", "z"])

# Save to assets/ as XML
save_arm(spec, ndof=3, control="pos", joint_orientation=["z", "y", "z"])
# -> assets/three_arm_pos_zyz.xml

build_arm parameters

Parameter Type Description
ndof int Number of joints (≥ 1)
control str "pos" (PD position) or "torque"
joint_orientation list[str] Per-joint axis: "z" (yaw) or "y" (pitch). Cycles if shorter than ndof. Defaults to alternating z/y.

Assumptions: fixed base, each link has length = 1 m and mass = 1 kg.

CLI

python -m robotdesigner.mujoco.composer --ndof 3 --control pos --joint-orientation z y z
python -m robotdesigner.mujoco.composer --ndof 5 --control torque --output my_arm.xml

Gymnasium environment

import gymnasium as gym
from robotdesigner.mujoco.composer import build_arm

spec = build_arm(ndof=3, control="pos")

gym.register(
    id="AbstractArm-v0",
    entry_point="robotdesigner.envs.abstract_mujoco_env:make_env",
)

env = gym.make("AbstractArm-v0", spec=spec, render_mode="rgb_array", max_episode_steps=200)
obs, _ = env.reset()

for _ in range(100):
    action = env.action_space.sample()
    obs, reward, terminated, truncated, info = env.step(action)
    if terminated or truncated:
        break

RLlib training

import ray
from ray.rllib.algorithms.ppo import PPOConfig

ray.init()

algo = (
    PPOConfig()
    .environment(
        env="AbstractArm-v0",
        env_config={"xml": spec.to_xml(), "render_mode": "rgb_array"},
    )
    .env_runners(num_env_runners=2)
    .build()
)

result = algo.train()
print(result["env_runners"]["episode_reward_mean"])

MJX environment (JAX)

import jax
from robotdesigner.mujoco.composer import build_arm
from robotdesigner.envs import load_mjx_environment, list_mjx_environments

spec = build_arm(ndof=3, control="pos")
env = load_mjx_environment("AbstractArmMjx", spec=spec)

print(list_mjx_environments())   # ('AbstractArmMjx',)
print(env.action_size)
print(env.observation_size)

rng = jax.random.PRNGKey(0)
state = env.reset(rng)

# Single step
state = env.step(state, jax.random.uniform(rng, (env.action_size,), minval=-1, maxval=1))

# JIT-compiled rollout
jit_step = jax.jit(env.step)

# Batched rollout with vmap
batch_size = 8
rngs = jax.random.split(rng, batch_size)
states = jax.vmap(env.reset)(rngs)
states = jax.vmap(env.step)(states, jax.random.uniform(rng, (batch_size, env.action_size)))

Interactive notebooks (marimo)

The example/ directory contains marimo notebooks:

File Description
example_GenMjSpec_mo.py Build and view a spec in the MuJoCo viewer
example_env_mujoco_mo.py Gymnasium rollout + RLlib training
example_env_mjx_mo.py MJX rollout, JIT, vmap, render

Run with:

marimo run example/example_env_mujoco_mo.py

License

See LICENSE.

Metadata

Release files for robotdesigner 0.1.3

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for robotdesigner 0.1.3
File Size Uploaded Provenance Actions
robotdesigner-0.1.3.tar.gz 27.6 kB With provenance Details for robotdesigner-0.1.3.tar.gz

Built distribution (wheel)

Table of built distributions (wheels) for robotdesigner 0.1.3
File Interpreter ABI Platform Actions
robotdesigner-0.1.3-py3-none-any.whl Python 3 none any Details for robotdesigner-0.1.3-py3-none-any.whl

Total release size: 56.6 kB

Release files / robotdesigner-0.1.3.tar.gz

Download URL robotdesigner-0.1.3.tar.gz
Size 27.6 kB
Tags Source
SHA-256 checksum
How to use checksums
1987cfa770fdc1dd5faa56d0ea8fb72ac014a237001c892f3a41fa41615c49e8
BLAKE2b-256 checksum
How to use checksums
7a46eada9773b9047bf5bd496c23aa33f5042874c848cf040ffcafd23ded20d3
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/6.1.0 CPython/3.13.12

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Jun 1, 2026.

Transparency log

Release files / robotdesigner-0.1.3-py3-none-any.whl

Download URL robotdesigner-0.1.3-py3-none-any.whl
Size 29.0 kB
Tags Python 3
SHA-256 checksum
How to use checksums
a84f5cd8ac96ec3fc4a7eb414defece04cabd9063db4f3a858740c1aea4da9cd
BLAKE2b-256 checksum
How to use checksums
b9cab91c926e0fe05eb19e4608e842a367d47d6b798daef0fb87b7d448fa3fd1
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/6.1.0 CPython/3.13.12

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Jun 1, 2026.

Transparency log

Security for robotdesigner 0.1.3

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

Full provenance

All 2 files in this release have been uploaded with provenance metadata.

Select from 2 files

Attestation for robotdesigner-0.1.3.tar.gz

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Jun 1, 2026.

Transparency log

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Release history Release notifications | RSS feed

This release

0.1.3 This release

2 release files Full provenance

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page