Metadata-Version: 2.4
Name: magma_gen
Version: 2.0.0b2
Summary: MAGMA-GEN is a pipeline which allows to generate interaction-grounded data without human annotation for robotic tasks.
Project-URL: Documentation, https://magma-rob.github.io/docs/intro
Project-URL: Repository, https://github.com/MAGMA-rob/magma-gen
Project-URL: Issues, https://github.com/MAGMA-rob/magma-gen/issues
Classifier: Development Status :: 4 - Beta
Requires-Python: <3.13,>=3.12
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: magma_core[simulation]<3.0.0,>=2.0.0b3
Requires-Dist: magma_scenarios<3.0.0,>=2.0.0
Requires-Dist: PyYAML
Requires-Dist: requests
Requires-Dist: torch
Provides-Extra: dev
Requires-Dist: pytest; extra == "dev"
Provides-Extra: gui
Requires-Dist: fastapi>=0.110; extra == "gui"
Requires-Dist: uvicorn>=0.27; extra == "gui"
Dynamic: license-file

# MAGMA-GEN

Generate robotic interaction data through simulation with MAGMA. MAGMA-GEN
coordinates an HTTP agent, task scenarios, and a motion planner, saves generation
graphs, and provides an optional web viewer for live and saved runs.

**Version 2.0.0b2 is the second beta of v2.** APIs, configuration, and output formats
may change before the stable release. End-to-end validation is still in progress.

[Official documentation](https://magma-rob.github.io/docs/intro) ·
[Report an issue](https://github.com/MAGMA-rob/magma-gen/issues)

## Installation

Python 3.12 is required. Simulation installation has been checked on Linux x86_64.
GPU rendering also requires compatible system drivers.

Install the beta with the web viewer:

```bash
python -m pip install "magma_gen[gui]==2.0.0b2"
```

For generation without the viewer dependencies:

```bash
python -m pip install "magma_gen==2.0.0b2"
```

Both install `magma_core[simulation]>=2.0.0b3,<3.0.0` and
`magma_scenarios>=2.0.0,<3.0.0`, along with their Python dependencies. The viewer
is included in the package; users do not need Node.js to run it.

The version is pinned explicitly because this is a prerelease. To request the
latest available version, including prereleases, use
`python -m pip install --upgrade --pre "magma_gen[gui]"`.

## Usage

Start a compatible agent and motion planner separately, then configure their
addresses and any required language-model backends. Installing MAGMA-GEN does
not start these services or install model weights.

```bash
magma-gen run --help
magma-gen batch --help
magma-gen export --help
```

To browse live or saved generations:

```bash
magma-gen viewer --output-dir ./output
```

Open `http://127.0.0.1:8900`. Dataset export requires the selected agent's export
plugin to be installed in the same Python environment as MAGMA-GEN.

See the [official documentation](https://magma-rob.github.io/docs/intro) for
configuration, generation examples, agent setup, and custom scenario packages.

## Install from source

Install this release from GitHub, with the viewer:

```bash
python -m pip install "magma_gen[gui] @ git+https://github.com/MAGMA-rob/magma-gen.git@v2.0.0b2"
```

This uses the tagged source and resolves its dependencies from PyPI. For local
Python development, clone the repository and run `python -m pip install -e ".[gui]"`.

## License

[BSD 2-Clause](https://github.com/MAGMA-rob/magma-gen/blob/main/LICENSE).
