sda.dashboard.app#

SDA Dashboard Application.

Main application entry point for the SDA Dashboard. This module sets up the Dash application with Spark branding and registers callbacks.

Functions#

is_port_in_use(host, port)

Check if a TCP port is already in use.

create_app(test_name[, debug, verbose])

Create and configure the Dash application.

run_dashboard([test_name, debug, port, host, ...])

Run the SDA Dashboard.

Module Contents#

sda.dashboard.app.is_port_in_use(host, port)#

Check if a TCP port is already in use.

Parameters:

  • host (str) – Host address to check

  • port (int) – Port number to check

Returns:

True if port is in use, False otherwise

Return type:

bool

sda.dashboard.app.create_app(test_name, debug=False, verbose=False)#

Create and configure the Dash application.

Parameters:

  • test_name (str or list) – Test name(s) to load initially

  • debug (bool) – Whether to enable debug mode

  • verbose (bool) – Whether to enable verbose logging

Returns:

Configured dash.Dash application instance.

Return type:

dash.Dash

sda.dashboard.app.run_dashboard(test_name=None, debug=False, port=8051, host='127.0.0.1', open_browser=True, verbose=False, auto_find_port=True, xaxis=None, yaxis=None)#

Run the SDA Dashboard.

This function sets up and runs the dash application.

Parameters:

  • test_name (str, list of str, or None) – The name(s) of the test(s) to load on startup, or None/empty for no preloaded test.

  • debug (bool) – Whether to run Dash in debug mode.

  • port (int) – Port to run the server on.

  • host (str) – Host address to bind the server.

  • open_browser (bool) – Whether to open the browser automatically.

  • verbose (bool) – Whether to print detailed callback registration information.

  • auto_find_port (bool) – Whether to automatically find an available port if the default is taken.

  • xaxis (str, optional) – Default x-axis column name for plots.

  • yaxis (str, optional) – Default y-axis column name for plots.

See also

create_app()

Create the application instance with layout and callbacks.

register_all_callbacks()

Register all dashboard callbacks.