sda.dashboard.app
=================

.. py:module:: sda.dashboard.app

.. autoapi-nested-parse::

   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
---------

.. autoapisummary::

   sda.dashboard.app.is_port_in_use
   sda.dashboard.app.create_app
   sda.dashboard.app.run_dashboard


Module Contents
---------------

.. py:function:: is_port_in_use(host, port)

   Check if a TCP port is already in use.

   :param host: Host address to check
   :type host: :py:class:`str`
   :param port: Port number to check
   :type port: :py:class:`int`

   :returns: True if port is in use, False otherwise
   :rtype: :py:class:`bool`


.. py:function:: create_app(test_name, debug=False, verbose=False)

   Create and configure the Dash application.

   :param test_name: Test name(s) to load initially
   :type test_name: :py:class:`str` or :py:class:`list`
   :param debug: Whether to enable debug mode
   :type debug: :py:class:`bool`
   :param verbose: Whether to enable verbose logging
   :type verbose: :py:class:`bool`

   :returns: Configured :class:`dash.Dash` application instance.
   :rtype: :py:class:`dash.Dash`


.. py:function:: 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.

   :param test_name: The name(s) of the test(s) to load on startup, or None/empty for no preloaded test.
   :type test_name: :py:class:`str`, :py:class:`list` of :py:class:`str`, or :py:obj:`None`
   :param debug: Whether to run Dash in debug mode.
   :type debug: :py:class:`bool`
   :param port: Port to run the server on.
   :type port: :py:class:`int`
   :param host: Host address to bind the server.
   :type host: :py:class:`str`
   :param open_browser: Whether to open the browser automatically.
   :type open_browser: :py:class:`bool`
   :param verbose: Whether to print detailed callback registration information.
   :type verbose: :py:class:`bool`
   :param auto_find_port: Whether to automatically find an available port if the default is taken.
   :type auto_find_port: :py:class:`bool`
   :param xaxis: Default x-axis column name for plots.
   :type xaxis: :py:class:`str`, *optional*
   :param yaxis: Default y-axis column name for plots.
   :type yaxis: :py:class:`str`, *optional*

   .. seealso::

      :py:func:`~sda.dashboard.app.create_app`
          Create the application instance with layout and callbacks.
      
      :py:func:`~sda.dashboard.callbacks.register_all_callbacks`
          Register all dashboard callbacks.