urdf2mjcf

Name	urdf2mjcf JSON
Version	0.0.4 JSON
	download
home_page	https://github.com/kscalelabs/urdf2mjcf
Summary	The urdf2mjcf project
upload_time	2024-10-23 08:05:30
maintainer	None
docs_url	None
author	Benjamin Bolte
requires_python	>=3.8
license	None
keywords
VCS
bugtrack_url
requirements	No requirements were recorded.
Travis-CI	No Travis.
coveralls test coverage	No coveralls.

            <p align="center">
  <picture>
    <img alt="K-Scale Open Source Robotics" src="https://media.kscale.dev/kscale-open-source-header.png" style="max-width: 100%;">
  </picture>
</p>

<div align="center">

[![License](https://img.shields.io/badge/license-MIT-green)](https://github.com/kscalelabs/urdf2mjcf/blob/main/LICENSE)
[![Version](https://img.shields.io/pypi/v/urdf2mjcf)](https://pypi.org/project/urdf2mjcf/)
[![Discord](https://img.shields.io/discord/1224056091017478166)](https://discord.gg/kscale)
[![Wiki](https://img.shields.io/badge/wiki-humanoids-black)](https://humanoids.wiki)
<br />
[![python](https://img.shields.io/badge/-Python_3.11-blue?logo=python&logoColor=white)](https://github.com/pre-commit/pre-commit)
[![black](https://img.shields.io/badge/Code%20Style-Black-black.svg?labelColor=gray)](https://black.readthedocs.io/en/stable/)
[![ruff](https://img.shields.io/badge/Linter-Ruff-red.svg?labelColor=gray)](https://github.com/charliermarsh/ruff)
<br />
[![Python Checks](https://github.com/kscalelabs/urdf2mjcf/actions/workflows/test.yml/badge.svg)](https://github.com/kscalelabs/urdf2mjcf/actions/workflows/test.yml)
[![Publish Python Package](https://github.com/kscalelabs/urdf2mjcf/actions/workflows/publish.yml/badge.svg)](https://github.com/kscalelabs/urdf2mjcf/actions/workflows/publish.yml)

</div>

# urdf2mjcf

![Example](./docs/example.png)

This script converts URDF files to MJCF files, with some nice options.

## Installation

```bash
pip install urdf2mjcf
```

## Usage

### Command Line

To run the conversion script from the command line, use:

```bash
urdf2mjcf path/to/your/robot.urdf
```

This will save the MJCF file in the same directory as the URDF file.

To see all the options, use:

```bash
urdf2mjcf -h
```

### Python

To run the conversion script from Python, use:

```python
from urdf2mjcf import run

run(
    urdf_path="path/to/your/robot.urdf",
    mjcf_path="path/to/save/robot.mjcf",
    copy_meshes=True,
)
```

            

Raw data

            {
    "_id": null,
    "home_page": "https://github.com/kscalelabs/urdf2mjcf",
    "name": "urdf2mjcf",
    "maintainer": null,
    "docs_url": null,
    "requires_python": ">=3.8",
    "maintainer_email": null,
    "keywords": null,
    "author": "Benjamin Bolte",
    "author_email": null,
    "download_url": "https://files.pythonhosted.org/packages/0a/7a/0c78f1d1c212e419c10966e38f84730a8e66cb3664b58ae63e2e861a3b9c/urdf2mjcf-0.0.4.tar.gz",
    "platform": null,
    "description": "<p align=\"center\">\n  <picture>\n    <img alt=\"K-Scale Open Source Robotics\" src=\"https://media.kscale.dev/kscale-open-source-header.png\" style=\"max-width: 100%;\">\n  </picture>\n</p>\n\n<div align=\"center\">\n\n[![License](https://img.shields.io/badge/license-MIT-green)](https://github.com/kscalelabs/urdf2mjcf/blob/main/LICENSE)\n[![Version](https://img.shields.io/pypi/v/urdf2mjcf)](https://pypi.org/project/urdf2mjcf/)\n[![Discord](https://img.shields.io/discord/1224056091017478166)](https://discord.gg/kscale)\n[![Wiki](https://img.shields.io/badge/wiki-humanoids-black)](https://humanoids.wiki)\n<br />\n[![python](https://img.shields.io/badge/-Python_3.11-blue?logo=python&logoColor=white)](https://github.com/pre-commit/pre-commit)\n[![black](https://img.shields.io/badge/Code%20Style-Black-black.svg?labelColor=gray)](https://black.readthedocs.io/en/stable/)\n[![ruff](https://img.shields.io/badge/Linter-Ruff-red.svg?labelColor=gray)](https://github.com/charliermarsh/ruff)\n<br />\n[![Python Checks](https://github.com/kscalelabs/urdf2mjcf/actions/workflows/test.yml/badge.svg)](https://github.com/kscalelabs/urdf2mjcf/actions/workflows/test.yml)\n[![Publish Python Package](https://github.com/kscalelabs/urdf2mjcf/actions/workflows/publish.yml/badge.svg)](https://github.com/kscalelabs/urdf2mjcf/actions/workflows/publish.yml)\n\n</div>\n\n# urdf2mjcf\n\n![Example](./docs/example.png)\n\nThis script converts URDF files to MJCF files, with some nice options.\n\n## Installation\n\n```bash\npip install urdf2mjcf\n```\n\n## Usage\n\n### Command Line\n\nTo run the conversion script from the command line, use:\n\n```bash\nurdf2mjcf path/to/your/robot.urdf\n```\n\nThis will save the MJCF file in the same directory as the URDF file.\n\nTo see all the options, use:\n\n```bash\nurdf2mjcf -h\n```\n\n### Python\n\nTo run the conversion script from Python, use:\n\n```python\nfrom urdf2mjcf import run\n\nrun(\n    urdf_path=\"path/to/your/robot.urdf\",\n    mjcf_path=\"path/to/save/robot.mjcf\",\n    copy_meshes=True,\n)\n```\n",
    "bugtrack_url": null,
    "license": null,
    "summary": "The urdf2mjcf project",
    "version": "0.0.4",
    "project_urls": {
        "Homepage": "https://github.com/kscalelabs/urdf2mjcf"
    },
    "split_keywords": [],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "cd8aaf9e336384ef7d04667e252859cdcbe952b62da43d8b2c99fd64af340909",
                "md5": "beb869a683f065cfa0b596ae1c554612",
                "sha256": "bdfc7a91777d873b0af116af4cbb5d54440d3e244511e48ab05aa271f481f725"
            },
            "downloads": -1,
            "filename": "urdf2mjcf-0.0.4-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "beb869a683f065cfa0b596ae1c554612",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.8",
            "size": 8906,
            "upload_time": "2024-10-23T08:05:28",
            "upload_time_iso_8601": "2024-10-23T08:05:28.544161Z",
            "url": "https://files.pythonhosted.org/packages/cd/8a/af9e336384ef7d04667e252859cdcbe952b62da43d8b2c99fd64af340909/urdf2mjcf-0.0.4-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "0a7a0c78f1d1c212e419c10966e38f84730a8e66cb3664b58ae63e2e861a3b9c",
                "md5": "c0da6b9591ac6648e4b9a278c02a4939",
                "sha256": "59c7acea0031269f9332f092512d9e275b5c562bb265c9908d25ebac9985160d"
            },
            "downloads": -1,
            "filename": "urdf2mjcf-0.0.4.tar.gz",
            "has_sig": false,
            "md5_digest": "c0da6b9591ac6648e4b9a278c02a4939",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.8",
            "size": 10324,
            "upload_time": "2024-10-23T08:05:30",
            "upload_time_iso_8601": "2024-10-23T08:05:30.048150Z",
            "url": "https://files.pythonhosted.org/packages/0a/7a/0c78f1d1c212e419c10966e38f84730a8e66cb3664b58ae63e2e861a3b9c/urdf2mjcf-0.0.4.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2024-10-23 08:05:30",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "kscalelabs",
    "github_project": "urdf2mjcf",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": true,
    "lcname": "urdf2mjcf"
}