API Referenceplotter

stanza.plotter

Live plotting for data logging.

Two backends available:

  • server: Plots in browser window (works everywhere)
  • inline: Plots in notebook cells (requires jupyter_bokeh)

Subpackages

  • backends - Bokeh backend protocols and base classes.

Module Contents

Functions

NameDescription
enable_live_plottingEnable live plotting for a data logger.

Data

logger _active_servers __all__

API

1stanza.plotter.logger

Value: getLogger(...)

1stanza.plotter._active_servers: dict[int, stanza.plotter.backends.server.ServerBackend]

Value: None

1stanza.plotter.enable_live_plotting(
2    data_logger: stanza.logger.data_logger.DataLogger,
3    backend: typing.Literal[server, inline] = 'server',
4    port: int = 5006,
5    session_token_expiration: int = sys.maxsize
6) -> stanza.plotter.backends.server.ServerBackend | stanza.plotter.backends.inline.InlineBackend

Enable live plotting for a data logger.

Parameters:

data_logger
stanza.logger.data_logger.DataLogger

DataLogger instance

backend
typing.Literal[server, inline]Defaults to 'server'

“server” (browser) or “inline” (notebook)

port
intDefaults to 5006

Server port (server backend only)

session_token_expiration
intDefaults to sys.maxsize

Duration in seconds that a session token is valid

Returns:

Backend instance Example (server):

backend = enable_live_plotting(logger, backend=“server”, port=5006)

Open http://localhost:5006 in browser

Example (inline):

backend = enable_live_plotting(logger, backend=“inline”)

Plots appear in notebook cells

1stanza.plotter.__all__

Value: ['enable_live_plotting']