Notebook helpers

module:

navground.sim.notebook

Helpers to display simulations in Jupyter notebooks.

display_in_notebook(world: World, **kwargs: Any) → SVG

Displays a world in the notebook, either as HTML or SVG

Parameters:

• world – The world to display

• kwargs – Arguments forwarded to navground.sim.ui.svg_for_world()

notebook_view(width: int = 600, **kwargs: Any) → HTML

Display an empty world view in a jupyter notebook ready for a a navground.sim.ui.WebUI to keep it up-to-date.

Parameters:

• width – The width in pixels

• kwargs – Additional keywords passed to navground.sim.ui.html_for_world()

Returns:

A HTML view

async run_in_notebook(world: World, time_step: float, duration: float, factor: float = 1.0, width: int = 600, port: int = 8002, bounds: tuple[Vector2, Vector2] | ndarray[Any, dtype[floating[Any]]] | None = None, **kwargs: Any) → Any

Perform a simulation and displays the recorded video in a notebook

Parameters:

• world – The world to simulate

• time_step – The time step

• duration – The simulation duration

• factor – The real-time factor

• width – The size of the view

• port – The websocket port

• kwargs – Arguments forwarded to navground.sim.ui.html_for_world()