mujoco-scenes

Name	mujoco-scenes JSON
Version	0.0.17 JSON
	download
home_page	https://github.com/kscalelabs/mujoco-scenes
Summary	The mujoco-scenes project
upload_time	2025-10-28 07:39:24
maintainer	None
docs_url	None
author	Benjamin Bolte
requires_python	>=3.11
license	None
keywords
VCS
bugtrack_url
requirements	No requirements were recorded.
Travis-CI	No Travis.
coveralls test coverage	No coveralls.

            # mujoco-scenes

This package contains a collection of utility functions for generating different types of scenes in Mujoco.

This is a programmatic way to compose scene files, inspired by [Mujoco Menagerie](https://github.com/google-deepmind/mujoco_menagerie).

## Usage

To load a robot into a particular scene, you can use the following code:

```python
from mujoco_scenes.mjcf import load_mjmodel

model = load_mjmodel("path/to/robot.xml", "smooth")

# To view the model, you can use:
mujoco.viewer.launch(model)
```


### Command to create scene `patch`
```bash
python generate.py --freq-hill 0 --freq-valley 0 --patch-size 64  --rows 5 --freq-hill-valley 2 --freq-rough 2  --rough-amplitude 1.0 --hill-amplitude 1.0 --valley-amplitude 1.0 --output templates/assets/patch_hfield.png
```

            

Raw data

            {
    "_id": null,
    "home_page": "https://github.com/kscalelabs/mujoco-scenes",
    "name": "mujoco-scenes",
    "maintainer": null,
    "docs_url": null,
    "requires_python": ">=3.11",
    "maintainer_email": null,
    "keywords": null,
    "author": "Benjamin Bolte",
    "author_email": null,
    "download_url": "https://files.pythonhosted.org/packages/d6/1b/75f6586186a0fe065b24fd368ccb1366c9f18a8053d3159451cf0ac3cbac/mujoco_scenes-0.0.17.tar.gz",
    "platform": null,
    "description": "# mujoco-scenes\n\nThis package contains a collection of utility functions for generating different types of scenes in Mujoco.\n\nThis is a programmatic way to compose scene files, inspired by [Mujoco Menagerie](https://github.com/google-deepmind/mujoco_menagerie).\n\n## Usage\n\nTo load a robot into a particular scene, you can use the following code:\n\n```python\nfrom mujoco_scenes.mjcf import load_mjmodel\n\nmodel = load_mjmodel(\"path/to/robot.xml\", \"smooth\")\n\n# To view the model, you can use:\nmujoco.viewer.launch(model)\n```\n\n\n### Command to create scene `patch`\n```bash\npython generate.py --freq-hill 0 --freq-valley 0 --patch-size 64  --rows 5 --freq-hill-valley 2 --freq-rough 2  --rough-amplitude 1.0 --hill-amplitude 1.0 --valley-amplitude 1.0 --output templates/assets/patch_hfield.png\n```\n",
    "bugtrack_url": null,
    "license": null,
    "summary": "The mujoco-scenes project",
    "version": "0.0.17",
    "project_urls": {
        "Homepage": "https://github.com/kscalelabs/mujoco-scenes"
    },
    "split_keywords": [],
    "urls": [
        {
            "comment_text": null,
            "digests": {
                "blake2b_256": "6f3a0b7d287d25046405d75efe65e94ef53dd70db1a2d4b6df1feefa1d9aaaf9",
                "md5": "c75801dd1a4ee112fd4ebeec7a2534ac",
                "sha256": "1c36dcc5d05b9776808f844507ea036399df7309aa1e1999691ddbb329228fba"
            },
            "downloads": -1,
            "filename": "mujoco_scenes-0.0.17-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "c75801dd1a4ee112fd4ebeec7a2534ac",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.11",
            "size": 6647033,
            "upload_time": "2025-10-28T07:39:22",
            "upload_time_iso_8601": "2025-10-28T07:39:22.673016Z",
            "url": "https://files.pythonhosted.org/packages/6f/3a/0b7d287d25046405d75efe65e94ef53dd70db1a2d4b6df1feefa1d9aaaf9/mujoco_scenes-0.0.17-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": null,
            "digests": {
                "blake2b_256": "d61b75f6586186a0fe065b24fd368ccb1366c9f18a8053d3159451cf0ac3cbac",
                "md5": "81f2260a4212008a731438bb8c29a2e2",
                "sha256": "1491e48b55cccd46182084a397d8c15bc4a5b09c9aa71f82f692de3cbcf184e2"
            },
            "downloads": -1,
            "filename": "mujoco_scenes-0.0.17.tar.gz",
            "has_sig": false,
            "md5_digest": "81f2260a4212008a731438bb8c29a2e2",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.11",
            "size": 6645481,
            "upload_time": "2025-10-28T07:39:24",
            "upload_time_iso_8601": "2025-10-28T07:39:24.185867Z",
            "url": "https://files.pythonhosted.org/packages/d6/1b/75f6586186a0fe065b24fd368ccb1366c9f18a8053d3159451cf0ac3cbac/mujoco_scenes-0.0.17.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2025-10-28 07:39:24",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "kscalelabs",
    "github_project": "mujoco-scenes",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": true,
    "lcname": "mujoco-scenes"
}