pyfebiopt.monitoring.webapp
===========================

.. py:module:: pyfebiopt.monitoring.webapp

.. autoapi-nested-parse::

   FastAPI web UI for monitoring optimization runs.



Attributes
----------

.. autoapisummary::

   pyfebiopt.monitoring.webapp.logger
   pyfebiopt.monitoring.webapp.TEMPLATE
   pyfebiopt.monitoring.webapp.STATIC_ASSETS
   pyfebiopt.monitoring.webapp.RouteHandler


Functions
---------

.. autoapisummary::

   pyfebiopt.monitoring.webapp.render_home_page
   pyfebiopt.monitoring.webapp.create_app
   pyfebiopt.monitoring.webapp.parse_args
   pyfebiopt.monitoring.webapp.main


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

.. py:data:: logger

.. py:data:: TEMPLATE

.. py:data:: STATIC_ASSETS

.. py:data:: RouteHandler

.. py:function:: render_home_page() -> str

   Render the static HTML shell for the monitor dashboard.

   :returns: Rendered HTML page.
   :rtype: str


.. py:function:: create_app(service: pyfebiopt.monitoring.monitoring_service.MonitoringService) -> fastapi.FastAPI

   Build a FastAPI application exposing the monitor endpoints.

   :returns: Configured monitoring app.
   :rtype: FastAPI


.. py:function:: parse_args(argv: collections.abc.Sequence[str] | None = None) -> argparse.Namespace

   Parse CLI arguments for the monitoring web app.

   :returns: Parsed arguments.
   :rtype: argparse.Namespace


.. py:function:: main(argv: collections.abc.Iterable[str] | None = None) -> int

   Run the monitoring web app CLI using parsed options.

   :returns: Process exit code.
   :rtype: int