mesh-to-sim-asset 0.1.5

Pipeline for converting mesh files into simulation assets

mesh-to-sim-asset

Pipeline for converting mesh files into simulation assets

Installation

This repository uses uv for dependency management.

1. Install uv:

curl -LsSf https://astral.sh/uv/install.sh | sh

2. Install the dependencies into .venv:

uv sync

3. Activate the virtual env:

source .venv/bin/activate

4. Install wine:

sudo add-apt-repository ppa:ubuntu-wine/ppa
sudo apt-get update
sudo apt-get install wine

5. Install the pre-commit hocks:

pre-commit install

6. Install git-lfs:

git-lfs install
git-lfs pull

7. Install blender:

sudo snap install blender --classic

8. Ensure that the OPENAI_API_KEY environment variable is set to your OpenAI key.

[Optional] Install usd2sdf

Only required for running make_asset_drake_compatible.py with USD inputs.

See here for installation instructions.

Installation via pip

We are hosting a pip wheel on PyPi. Please install using pip install mesh-to-sim-asset.

Note that this will only install the python package (replacing repo cloning + uv sync). You will still need to install the remaining dependencies manually.

After installing the pip wheel, the scripts can be run using python -m create_drake_asset_from_geometry and python -m make_asset_drake_compatible.

Usage

Geometry/ Mesh to Drake SDF Simulation Asset

Pipeline for converting geometry mesh files into Drake simulation assets with visual geometries, collision geometries, and physical properties. Non-specified properties are estimated with a VLM.

The pipeline entrypoint is create_drake_asset_from_geometry.py. Please see that script for argument documentation.

Example:

python main.py \
    input_dir_path \
    -o output_dir_path \
    -mck

Simulation Asset (USD, URDF, SDF, MJX) to Drake SDF Simulation Asset

Pipeline for converting existing simulation assets (e.g., articulated objects) into Drake simulation assets with visual geometries, collision geometries, and physical properties. Non-specified properties are estimated with a VLM.

The pipeline entrypoint is make_asset_drake_compatible.py. Please see that script for argument documentation.

Validate Static Equilibrium

Simulation assets should at least be statically stable. We can validate this by placing them onto a flat floor:

python scripts/test_mesh_sim.py \
    asset_name.sdf \
    --position "0, 0, 0.1" \
    --rotation "0, 0, 0"

Use the --use_ramp argument to test rolling down a ramp. We recommend --position "0, 0, 0.3" for the ramp setting.

Build a new wheel and publish it to PyPi

Build the wheel:

uv build

Publish it:

uv publish --token $PYPI_TOKEN

where PYPI_TOKEN refers to the PyPi API token.