Public Member Functions
def	__init__ (self, is3D, port=None, debug=False)

"Viewer"	replay (self, pd.DataFrame df, float dt)

"Viewer"	live (self, dict params, list[str]\|str infos=['type', 'state'], int seed=None, bool benchmark=False, bool withTqdm=False)

pd.DataFrame	getData (self)

def	show (self, int width=None, int height=None)

def	stop (self)

Public Attributes
	port

	server

	thread

	datas

	simu

Private Member Functions
str	_repr_html_ (self)

Private Attributes
	_finalizer

Detailed Description

A live or replay 2D/3D simulation viewer embedded in Jupyter.

This class starts an HTTPServer in a background thread.

You can use it in **replay** mode—feeding it a precomputed DataFrame—or
in **live** mode—running a Simu instance step by step and streaming
results as they arrive.

The server is automatically cleaned up when the Viewer object is
garbage-collected or when you explicitly call `.stop()`.

Definition at line 321 of file viewer.py.

Constructor & Destructor Documentation

◆ init()

def viewer.Viewer.__init__	(	self,
		is3D,
		port = `None`,
		debug = `False`
	)

Instantiate and start the HTTP server.

Args:
    is3D (bool):  If True, viewer expects 3D coordinates (x,y,z),
                  otherwise only (x,y).
    port (int, optional):  TCP port to bind the server on. If None,
                  tries to find a free port in [8765, 8865].
    debug (bool): If True, enables javascript debug mode with additional logging.

Raises:
    RuntimeError: If the server thread fails to start within 5 seconds.

Definition at line 334 of file viewer.py.

Member Function Documentation

◆ _repr_html_()

str viewer.Viewer._repr_html_ ( self )

private

Jupyter HTML repr: Embed the viewer automatically when returning this object.

Definition at line 477 of file viewer.py.

◆ getData()

pd.DataFrame viewer.Viewer.getData ( self )

Returns a single concatenated DataFrame of all steps collected in live mode.
If replay mode was used, returns the original df.

Returns:
    pd.DataFrame:  Index “step”, with all columns from dataCatcher.

Definition at line 449 of file viewer.py.

◆ live()

"Viewer" viewer.Viewer.live	(		self,
		dict	params,
		list[str]\|str	infos = `['type', 'state']`,
		int	seed = `None`,
		bool	benchmark = `False`,
		bool	withTqdm = `False`
	)

Run a Simu instance live, collect data each step, and stream it.

Args:
    params (dict):      Simulation parameters (must include Scenario.maxStep & dt).
    infos (list[str]|str):  List of cell attributes to retrieve, or 'all'
    withTqdm (bool):    If True, show a tqdm progress bar.

Returns:
    self, for method chaining.

Raises:
    RuntimeError: If already in replay mode.

Definition at line 393 of file viewer.py.

◆ replay()

"Viewer" viewer.Viewer.replay	(		self,
		pd.DataFrame	df,
		float	dt
	)

Load a precomputed DataFrame for step-by-step replay.

Args:
    df (pd.DataFrame):  Must contain columns ['step','id',…,'positionx',…].
    dt (float):         Time interval between steps.

Returns:
    self, for method chaining.

Raises:
    RuntimeError: If already in live mode.
    TypeError:    If df is not a pandas DataFrame.

Definition at line 367 of file viewer.py.

◆ show()

def viewer.Viewer.show	(		self,
		int	width = `None`,
		int	height = `None`
	)

Display the viewer inline in a notebook via IFrame.

Args:
    width (int, optional):  Width of the plotting area in px; if None uses 100% width.
    height (int, optional): Height in px; if None uses a default of 800px.

Definition at line 463 of file viewer.py.

◆ stop()

def viewer.Viewer.stop ( self )

Stop the HTTP server and join its thread immediately.
Also prevents the automatic finalizer from running again.

Definition at line 485 of file viewer.py.

Member Data Documentation

◆ _finalizer

viewer.Viewer._finalizer

private

Definition at line 365 of file viewer.py.

◆ datas

viewer.Viewer.datas

Definition at line 443 of file viewer.py.

◆ port

viewer.Viewer.port

Definition at line 348 of file viewer.py.

◆ server

viewer.Viewer.server

Definition at line 349 of file viewer.py.

◆ simu

viewer.Viewer.simu

Definition at line 446 of file viewer.py.

◆ thread

viewer.Viewer.thread

Definition at line 355 of file viewer.py.

The documentation for this class was generated from the following file:

external/installer/pluginViewer/viewer.py

Public Member Functions

Public Attributes

Private Member Functions

Private Attributes