Skip to content

Launcher

SimViewLauncher is the blocking launch for save-then-view workflows, as opposed to LiveViewer's streaming launch or SimulationScene.show()'s non-blocking one.

simview.launcher.SimViewLauncher

SimViewLauncher(source: SimulationScene | str | Path)

Serve a scene in the foreground until interrupted, then free it.

The blocking counterpart to SimulationScene.show()'s background viewer.

Validate source, a SimulationScene or a path to a scene file.

A scene is handed to the server in memory (no temporary file) and its internal data is cleared once the server stops; a path is served as is.

cleanup

cleanup() -> None

Clear the in-memory scene's data. Safe to call multiple times.

launch

launch(
    host: str = "127.0.0.1", preferred_port: int = 5420
) -> None

Run the server until it stops, then clear the in-memory scene (if any).