pyrobosim.gui.main.start_gui

pyrobosim.gui.main.start_gui(world: World, options: WorldCanvasOptions = WorldCanvasOptions(dpi=100, animation_dt=0.1, show_collision_polygons=False, show_room_names=True, show_object_names=True, show_location_names=True, show_robot_names=True), web: bool = False, web_host: str = '127.0.0.1', web_port: int = 8050) → None

Helper function to start a PyRoboSim GUI for a world model.

Parameters:

  • world – World object to attach to the GUI.

  • options – A world canvas options dataclass instance.

  • web – If True, serves the browser-based web UI (which requires the web extra to be installed) instead of starting the Qt GUI.

  • web_host – The host interface to bind to (used only for web).

  • web_port – The port to serve on (used only for web).