Skip to content

Launcher

SimViewLauncher is the blocking launch used by the CLI and 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)

Initializes the visualizer. - If source is a SimulationScene: it is handed to the server in memory (no temporary file), and its internal data is cleared after the server stops. - If source is a path: it is used directly.

cleanup

cleanup() -> None

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

launch

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

Launches the SimViewServer, then clears the in-memory scene (if any).