mitsuba-scene-description 0.1.0

Generated, typed, autocompletable Python API for composing Mitsuba scenes.

Mitsuba Scene Description (MSD)

Disclaimer: Expect rough edges and frequent changes to the API.

This package contains:

1. A core runtime API (mitsuba_scene_description) with typed dataclasses, a recursive serializer, and a small sample of common plugins (BSDFs, shapes, sensors, emitters, integrators, textures). You can use this immediately to build scenes programmatically and call mi.load_dict(scene.to_dict()).

2. A generator script (generator/generate_mitsuba_api.py) that scrapes the official Mitsuba plugin reference and generates modules per category with conservative typing. Run it locally (with internet access) to create a complete API for all plugins.

Quick start (core API sample)

from pprint import pprint
import mitsuba as mi
mi.set_variant("llvm_ad_rgb")

import mitsuba_scene_description as msd

red = msd.SmoothDiffuseMaterial(reflectance=msd.RGB([0.8, 0.2, 0.2]))
ball = msd.Sphere(
    radius=1.0,
    bsdf=red,
    to_world=msd.Transform().translate(0, 0, 3).scale(1.0, 1.0, 1.0),
)

cam = msd.PerspectivePinholeCamera(
    fov=45,
    to_world=msd.Transform().look_at(origin=[0, 1, -6], target=[0, 0, 0], up=[0, 1, 0]),
)
integrator = msd.PathTracer()
sun = msd.PointLightSource(
    to_world=msd.Transform().translate(3, 4, 2), intensity=msd.RGB([3, 3, 3])
)

scene = msd.Scene(
    integrator=integrator,
    sensor=cam,
    shapes={"ball": ball},
    emitters={"sun": sun},
)


pprint(scene.to_dict())
mi_scene = mi.load_dict(scene.to_dict())
rndr = mi.render(mi_scene)
mi.util.write_bitmap("test.png", rndr)

Generate the full API from docs

1. Install requirements: pip install requests beautifulsoup4
2. Run the generator:

   python generator/generate_mitsuba_api.py --out gen --overview https://mitsuba.readthedocs.io/en/latest/src/plugin_reference.html
   

Notes

• The generator uses conservative typing by default (Optional[Plugin] for unknown or nested plugin params).
• You can tweak typing, categories, and output via CLI flags (--aggressive, --single-file, --categories).

Roadmap

• Post-processing of generation using the tree-sitter API to remove artifacts
• Versioning