Merge pull request #106 from bangxiangyong/introduce_dashboard_into_docs

Introduce existing dashboard documentation into docs
Met4FoF · Jul 3, 2020 · ba2a2b3 · ba2a2b3
2 parents 1884401 + de740c0
commit ba2a2b3
Show file tree

Hide file tree

Showing 4 changed files with 79 additions and 12 deletions.
diff --git a/agentMET4FOF_tutorials/tutorial_2_math_agent.ipynb b/agentMET4FOF_tutorials/tutorial_2_math_agent.ipynb
@@ -34,11 +34,42 @@
    "execution_count": null,
    "metadata": {
     "pycharm": {
-     "is_executing": false,
-     "name": "#%%\n"
+     "name": "#%%\n",
+     "is_executing": true
     }
    },
-   "outputs": [],
+   "outputs": [
+    {
+     "name": "stdout",
+     "output_type": "stream",
+     "text": [
+      "Starting NameServer...\n",
+      "Broadcast server running on 0.0.0.0:9091\n",
+      "NS running on 127.0.0.1:3333 (127.0.0.1)\n",
+      "URI = PYRO:Pyro.NameServer@127.0.0.1:3333\n",
+      "INFO [2020-07-03 10:31:04.994115] (AgentController): INITIALIZED\n",
+      "INFO [2020-07-03 10:31:05.139466] (SineGeneratorAgent_1): INITIALIZED\n",
+      " * Serving Flask app \"agentMET4FOF.dashboard.Dashboard\" (lazy loading)\n",
+      " * Environment: production\n",
+      "\u001B[31m   WARNING: This is a development server. Do not use it in a production deployment.\u001B[0m\n",
+      "\u001B[2m   Use a production WSGI server instead.\u001B[0m\n",
+      " * Debug mode: off\n",
+      "INFO [2020-07-03 10:31:05.228778] (MathAgent_1): INITIALIZED\n",
+      "INFO [2020-07-03 10:31:05.331405] (MultiMathAgent_1): INITIALIZED\n",
+      "INFO [2020-07-03 10:31:05.404812] (MonitorAgent_1): INITIALIZED\n",
+      "[2020-07-03 10:31:05.463064] (SineGeneratorAgent_1): Connected output module: MathAgent_1\n",
+      "[2020-07-03 10:31:05.468906] (SineGeneratorAgent_1): Connected output module: MultiMathAgent_1\n",
+      "[2020-07-03 10:31:05.474625] (SineGeneratorAgent_1): Connected output module: MonitorAgent_1\n"
+     ]
+    },
+    {
+     "name": "stderr",
+     "output_type": "stream",
+     "text": [
+      " * Running on http://127.0.0.1:8050/ (Press CTRL+C to quit)\n"
+     ]
+    }
+   ],
    "source": [
     "# %load tutorial_2_math_agent.py\n",
     "from agentMET4FOF.agents import AgentMET4FOF, AgentNetwork, MonitorAgent\n",
@@ -115,9 +146,9 @@
  ],
  "metadata": {
   "kernelspec": {
-   "display_name": "Python 3",
+   "name": "python37764bitmet4fofcodevenv9b51785e48894dacb6143cff0cf0c2df",
    "language": "python",
-   "name": "python3"
+   "display_name": "Python 3.7.7 64-bit ('Met4FoF_Code': venv)"
   },
   "language_info": {
    "codemirror_mode": {
@@ -143,4 +174,4 @@
  },
  "nbformat": 4,
  "nbformat_minor": 1
-}
+}
diff --git a/agentMET4FOF_tutorials/tutorial_3_multi_channel.ipynb b/agentMET4FOF_tutorials/tutorial_3_multi_channel.ipynb
@@ -28,14 +28,44 @@
   },
   {
    "cell_type": "code",
-   "execution_count": null,
+   "execution_count": 1,
    "metadata": {
     "pycharm": {
-     "is_executing": false,
      "name": "#%%\n"
     }
    },
-   "outputs": [],
+   "outputs": [
+    {
+     "name": "stdout",
+     "output_type": "stream",
+     "text": [
+      "Starting NameServer...\n",
+      "Broadcast server running on 0.0.0.0:9091\n",
+      "NS running on 127.0.0.1:3333 (127.0.0.1)\n",
+      "URI = PYRO:Pyro.NameServer@127.0.0.1:3333\n",
+      "INFO [2020-07-03 10:31:35.657368] (AgentController): INITIALIZED\n",
+      "INFO [2020-07-03 10:31:35.837487] (MultiGeneratorAgent_1): INITIALIZED\n",
+      " * Serving Flask app \"agentMET4FOF.dashboard.Dashboard\" (lazy loading)\n",
+      " * Environment: production\n",
+      "\u001B[31m   WARNING: This is a development server. Do not use it in a production deployment.\u001B[0m\n",
+      "\u001B[2m   Use a production WSGI server instead.\u001B[0m\n",
+      " * Debug mode: off\n",
+      "INFO [2020-07-03 10:31:35.921903] (MultiOutputMathAgent_1): INITIALIZED\n",
+      "INFO [2020-07-03 10:31:35.993695] (MonitorAgent_1): INITIALIZED\n",
+      "[2020-07-03 10:31:36.051394] (MultiGeneratorAgent_1): Connected output module: MultiOutputMathAgent_1\n",
+      "[2020-07-03 10:31:36.057693] (MultiGeneratorAgent_1): Connected output module: MonitorAgent_1\n",
+      "[2020-07-03 10:31:36.066761] (MultiOutputMathAgent_1): Connected output module: MonitorAgent_1\n",
+      "SET STATE:   Running\n"
+     ]
+    },
+    {
+     "name": "stderr",
+     "output_type": "stream",
+     "text": [
+      " * Running on http://127.0.0.1:8050/ (Press CTRL+C to quit)\n"
+     ]
+    }
+   ],
    "source": [
     "# %load tutorial_3_multi_channel.py\n",
     "from agentMET4FOF.agents import AgentMET4FOF, AgentNetwork, MonitorAgent\n",
@@ -110,9 +140,9 @@
  ],
  "metadata": {
   "kernelspec": {
-   "display_name": "Python 3",
+   "name": "python37764bitmet4fofcodevenv9b51785e48894dacb6143cff0cf0c2df",
    "language": "python",
-   "name": "python3"
+   "display_name": "Python 3.7.7 64-bit ('Met4FoF_Code': venv)"
   },
   "language_info": {
    "codemirror_mode": {
@@ -138,4 +168,4 @@
  },
  "nbformat": 4,
  "nbformat_minor": 1
-}
+}
diff --git a/docs/agentMET4FOF_dashboard.rst b/docs/agentMET4FOF_dashboard.rst
@@ -0,0 +1,5 @@
+agentMET4FOF dashboard
+===================
+
+.. automodule:: agentMET4FOF.dashboard.Dashboard
+    :members:
diff --git a/docs/index.rst b/docs/index.rst
@@ -38,6 +38,7 @@ For the *agentMET4FOF* homepage go to
 
    agentMET4FOF_agents
    agentMET4FOF_streams
+   agentMET4FOF_dashboard
 
 
 Indices and tables