simforge


Namesimforge JSON
Version 0.1.3 PyPI version JSON
download
home_pageNone
SummaryDiverse virtual environments through procedural generation
upload_time2025-01-29 01:18:47
maintainerNone
docs_urlNone
authorNone
requires_python>=3.10
licenseMIT OR Apache-2.0
keywords procedural simulation
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            <h1 align="center">SimForge</h1>

[![PyPi](https://img.shields.io/pypi/v/simforge.svg)](https://pypi.python.org/pypi/simforge)
[![Docs](https://img.shields.io/badge/docs-online-blue?logo=markdown)](https://AndrejOrsula.github.io/simforge)
[![Python](https://github.com/AndrejOrsula/simforge/actions/workflows/python.yml/badge.svg)](https://github.com/AndrejOrsula/simforge/actions/workflows/python.yml)
[![Docker](https://github.com/AndrejOrsula/simforge/actions/workflows/docker.yml/badge.svg)](https://github.com/AndrejOrsula/simforge/actions/workflows/docker.yml)
[![Docs](https://github.com/AndrejOrsula/simforge/actions/workflows/docs.yml/badge.svg)](https://github.com/AndrejOrsula/simforge/actions/workflows/docs.yml)
[![Codecov](https://codecov.io/gh/AndrejOrsula/simforge/graph/badge.svg)](https://codecov.io/gh/AndrejOrsula/simforge)

**SimForge** is a framework for creating diverse virtual environments through procedural generation.

## Overview

The framework implements a modular approach with three primary concepts: **Assets**, **Generators**, and **Integrations**.

### Assets

Assets are the registered building blocks that range from simple images and meshes to complex articulated models. Their definitions reside in external repositories that can be shared and reused across projects. Example: [SimForge Foundry](https://github.com/AndrejOrsula/simforge_foundry)

### Generators

Generators are responsible for automating the creation of **Assets** from their definitions in a deterministic manner. They interface with external tools and libraries to produce the desired output. Example: [Blender](https://AndrejOrsula.github.io/simforge/generators/blender.html)

### Integrations

Integrations seamlessly bridge the gap between the **Generators** and external frameworks such as game engines or physics simulators. These modules leverage domain-specific APIs to import and configure the generated **Assets**. Example: [Isaac Lab](https://AndrejOrsula.github.io/simforge/integrations/isaaclab.html)

## Documentation

The full documentation is available in its raw form inside the [docs](docs) directory. The compiled version is hosted [online](https://AndrejOrsula.github.io/simforge) in a more accessible format.

<a href="https://AndrejOrsula.github.io/simforge"> <img alt="HTML" src="https://github.com/AndrejOrsula/awesome-space-robotics/assets/22929099/3c8accf7-5acb-4bcd-9553-bf49cc622abe" width="96" height="96"></a>

## License

This project is dual-licensed under either the [MIT](LICENSE-MIT) or [Apache 2.0](LICENSE-APACHE) licenses.

            

Raw data

            {
    "_id": null,
    "home_page": null,
    "name": "simforge",
    "maintainer": null,
    "docs_url": null,
    "requires_python": ">=3.10",
    "maintainer_email": "Andrej Orsula <orsula.andrej@gmail.com>",
    "keywords": "procedural, simulation",
    "author": null,
    "author_email": "Andrej Orsula <orsula.andrej@gmail.com>",
    "download_url": "https://files.pythonhosted.org/packages/0f/81/dd96367bb1535108c4b9c831f713fa0dedd51bd6f3af19e33e87eefb339d/simforge-0.1.3.tar.gz",
    "platform": null,
    "description": "<h1 align=\"center\">SimForge</h1>\n\n[![PyPi](https://img.shields.io/pypi/v/simforge.svg)](https://pypi.python.org/pypi/simforge)\n[![Docs](https://img.shields.io/badge/docs-online-blue?logo=markdown)](https://AndrejOrsula.github.io/simforge)\n[![Python](https://github.com/AndrejOrsula/simforge/actions/workflows/python.yml/badge.svg)](https://github.com/AndrejOrsula/simforge/actions/workflows/python.yml)\n[![Docker](https://github.com/AndrejOrsula/simforge/actions/workflows/docker.yml/badge.svg)](https://github.com/AndrejOrsula/simforge/actions/workflows/docker.yml)\n[![Docs](https://github.com/AndrejOrsula/simforge/actions/workflows/docs.yml/badge.svg)](https://github.com/AndrejOrsula/simforge/actions/workflows/docs.yml)\n[![Codecov](https://codecov.io/gh/AndrejOrsula/simforge/graph/badge.svg)](https://codecov.io/gh/AndrejOrsula/simforge)\n\n**SimForge** is a framework for creating diverse virtual environments through procedural generation.\n\n## Overview\n\nThe framework implements a modular approach with three primary concepts: **Assets**, **Generators**, and **Integrations**.\n\n### Assets\n\nAssets are the registered building blocks that range from simple images and meshes to complex articulated models. Their definitions reside in external repositories that can be shared and reused across projects. Example: [SimForge Foundry](https://github.com/AndrejOrsula/simforge_foundry)\n\n### Generators\n\nGenerators are responsible for automating the creation of **Assets** from their definitions in a deterministic manner. They interface with external tools and libraries to produce the desired output. Example: [Blender](https://AndrejOrsula.github.io/simforge/generators/blender.html)\n\n### Integrations\n\nIntegrations seamlessly bridge the gap between the **Generators** and external frameworks such as game engines or physics simulators. These modules leverage domain-specific APIs to import and configure the generated **Assets**. Example: [Isaac Lab](https://AndrejOrsula.github.io/simforge/integrations/isaaclab.html)\n\n## Documentation\n\nThe full documentation is available in its raw form inside the [docs](docs) directory. The compiled version is hosted [online](https://AndrejOrsula.github.io/simforge) in a more accessible format.\n\n<a href=\"https://AndrejOrsula.github.io/simforge\"> <img alt=\"HTML\" src=\"https://github.com/AndrejOrsula/awesome-space-robotics/assets/22929099/3c8accf7-5acb-4bcd-9553-bf49cc622abe\" width=\"96\" height=\"96\"></a>\n\n## License\n\nThis project is dual-licensed under either the [MIT](LICENSE-MIT) or [Apache 2.0](LICENSE-APACHE) licenses.\n",
    "bugtrack_url": null,
    "license": "MIT OR Apache-2.0",
    "summary": "Diverse virtual environments through procedural generation",
    "version": "0.1.3",
    "project_urls": {
        "Documentation": "https://AndrejOrsula.github.io/simforge",
        "Repository": "https://github.com/AndrejOrsula/simforge"
    },
    "split_keywords": [
        "procedural",
        " simulation"
    ],
    "urls": [
        {
            "comment_text": null,
            "digests": {
                "blake2b_256": "a4bc7f5939725b78f655f6602cc832c7dc0867266a09dc69a740f5d92fd305f8",
                "md5": "cd8312e8b4ce8b11e5247fd35efd05ab",
                "sha256": "f0cf9f68444c19deb8f1d3fc0d2498fad25abda997776457669387f763c06a21"
            },
            "downloads": -1,
            "filename": "simforge-0.1.3-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "cd8312e8b4ce8b11e5247fd35efd05ab",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.10",
            "size": 63774,
            "upload_time": "2025-01-29T01:18:44",
            "upload_time_iso_8601": "2025-01-29T01:18:44.393062Z",
            "url": "https://files.pythonhosted.org/packages/a4/bc/7f5939725b78f655f6602cc832c7dc0867266a09dc69a740f5d92fd305f8/simforge-0.1.3-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": null,
            "digests": {
                "blake2b_256": "0f81dd96367bb1535108c4b9c831f713fa0dedd51bd6f3af19e33e87eefb339d",
                "md5": "03f31a796e1f8e903e89ba50e17f2305",
                "sha256": "445af327e80e418b8dde0fd475146db617316cf1a73b89a208213c2a9ff3cf31"
            },
            "downloads": -1,
            "filename": "simforge-0.1.3.tar.gz",
            "has_sig": false,
            "md5_digest": "03f31a796e1f8e903e89ba50e17f2305",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.10",
            "size": 28568925,
            "upload_time": "2025-01-29T01:18:47",
            "upload_time_iso_8601": "2025-01-29T01:18:47.935986Z",
            "url": "https://files.pythonhosted.org/packages/0f/81/dd96367bb1535108c4b9c831f713fa0dedd51bd6f3af19e33e87eefb339d/simforge-0.1.3.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2025-01-29 01:18:47",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "AndrejOrsula",
    "github_project": "simforge",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": true,
    "lcname": "simforge"
}
        
Elapsed time: 0.39469s