agentMET4FOF dashboard¶

class agentMET4FOF.dashboard.Dashboard.AgentDashboard(dashboard_modules=[], dashboard_layouts=[], dashboard_update_interval=3, max_monitors=10, ip_addr='0.0.0.0', port=8050, agentNetwork='127.0.0.1', agent_ip_addr=3333, agent_port=None, network_stylesheet=[], hide_default_edge=True, **kwargs)[source]¶

Class for the web dashboard which runs with the AgentNetwork object, which by default are on the same IP. Optional to run the dashboard on a separate IP by providing the right parameters. See example for an implementation of a separate run of dashboard to connect to an existing agent network. If there is no existing agent network, error will show up. An internal _Dashboard_Control object is instantiated inside this object, which manages access to the AgentNetwork.

_show_startup_message()[source]¶

This method prints the startup message of the webserver/dashboard

init_app_layout(update_interval_seconds=3, max_monitors=10, dashboard_layouts=[], network_stylesheet=[], hide_default_edge=True, **kwargs)[source]¶

Initialises the overall dash app “layout” which has two sub-pages (Agent network and ML experiment)

Parameters:
  • update_interval_seconds (float or int) – Auto refresh rate which the app queries the states of Agent Network to update the graphs and display
  • max_monitors (int) – Due to complexity in managing and instantiating dynamic figures, a maximum number of monitors is specified first and only the each Monitor Agent will occupy one of these figures. It is not ideal, but will undergo changes for the better.
Returns:

app

Return type:

Dash app object

is_port_available(ip_addr, _port)[source]¶

Check if desired ip and port are available.

run()[source]¶

This is actually executed on calling start() and brings up the server

class agentMET4FOF.dashboard.Dashboard.AgentDashboardProcess(dashboard_modules=[], dashboard_layouts=[], dashboard_update_interval=3, max_monitors=10, ip_addr='0.0.0.0', port=8050, agentNetwork='127.0.0.1', agent_ip_addr=3333, agent_port=None, network_stylesheet=[], hide_default_edge=True, **kwargs)[source]¶

Represents an agent dashboard for the osBrain backend

terminate()[source]¶

This is shutting down the application server serving the web interface

class agentMET4FOF.dashboard.Dashboard.AgentDashboardThread(dashboard_modules=[], dashboard_layouts=[], dashboard_update_interval=3, max_monitors=10, ip_addr='127.0.0.1', port=8050, agentNetwork='127.0.0.1', agent_ip_addr=3333, agent_port=None, **kwargs)[source]¶

Represents an agent dashboard for the Mesa backend

run()[source]¶

This is actually executed on calling start() and brings up the server

terminate()[source]¶

This is shutting down the application server serving the web interface