📝 Docs: Add instructions to launch the streamlit app from colab on the two demo notebooks

Author: sayalaruano

docs/vuegen_basic_case_study.ipynb

@@ -117,21 +117,9 @@
   },
   {
    "cell_type": "code",
-   "execution_count": 2,
+   "execution_count": null,
    "metadata": {},
-   "outputs": [
-    {
-     "ename": "ModuleNotFoundError",
-     "evalue": "No module named 'vuegen'",
-     "output_type": "error",
-     "traceback": [
-      "\u001b[0;31m---------------------------------------------------------------------------\u001b[0m",
-      "\u001b[0;31mModuleNotFoundError\u001b[0m                       Traceback (most recent call last)",
-      "Cell \u001b[0;32mIn[2], line 4\u001b[0m\n\u001b[1;32m      2\u001b[0m \u001b[38;5;28;01mimport\u001b[39;00m \u001b[38;5;21;01mos\u001b[39;00m\n\u001b[1;32m      3\u001b[0m \u001b[38;5;28;01mimport\u001b[39;00m \u001b[38;5;21;01myaml\u001b[39;00m\n\u001b[0;32m----> 4\u001b[0m \u001b[38;5;28;01mfrom\u001b[39;00m \u001b[38;5;21;01mvuegen\u001b[39;00m \u001b[38;5;28;01mimport\u001b[39;00m report_generator\n\u001b[1;32m      5\u001b[0m \u001b[38;5;28;01mfrom\u001b[39;00m \u001b[38;5;21;01mvuegen\u001b[39;00m\u001b[38;5;21;01m.\u001b[39;00m\u001b[38;5;21;01mutils\u001b[39;00m \u001b[38;5;28;01mimport\u001b[39;00m get_logger, load_yaml_config\n\u001b[1;32m      7\u001b[0m \u001b[38;5;28;01mif\u001b[39;00m IN_COLAB:\n",
-      "\u001b[0;31mModuleNotFoundError\u001b[0m: No module named 'vuegen'"
-     ]
-    }
-   ],
+   "outputs": [],
    "source": [
     "# Imports\n",
     "import os\n",
@@ -163,7 +151,9 @@
    "cell_type": "markdown",
    "metadata": {},
    "source": [
-    "### 1.1. Streamlit report"
+    "### 1.1. Streamlit report\n",
+    "\n",
+    "To launch the Streamlit web application from Colab, open the generated URL and copy the localtunnel entry point IP into the corresponding field on the opened page. Once submited, you will be redirected to your Streamlit web application."
    ]
   },
   {
@@ -199,7 +189,9 @@
     "elif run_streamlit:\n",
     "   # see: https://discuss.streamlit.io/t/how-to-launch-streamlit-app-from-google-colab-notebook/42399\n",
     "   print(\"Password/Enpoint IP for localtunnel is:\",urllib.request.urlopen('https://ipv4.icanhazip.com').read().decode('utf8').strip(\"\\n\"))\n",
+    "   # Run the Streamlit app in the background\n",
     "   !streamlit run streamlit_report/sections/report_manager.py --server.address=localhost &>/content/logs.txt &\n",
+    "   # Expose the Streamlit app on port 8501\n",
     "   !npx localtunnel --port 8501 --subdomain vuegen-demo\n",
     "else:\n",
     "    print(\"Streamlit report not executed, set run_streamlit to True to run the report\")"
@@ -319,7 +311,9 @@
    "cell_type": "markdown",
    "metadata": {},
    "source": [
-    "### 2.5. Stremlit report with the extended configuration file"
+    "### 2.5. Stremlit report with the extended configuration file\n",
+    "\n",
+    "To launch the Streamlit web application from Colab, open the generated URL and copy the localtunnel entry point IP into the corresponding field on the opened page. Once submited, you will be redirected to your Streamlit web application."
    ]
   },
   {
@@ -347,7 +341,9 @@
     "elif run_streamlit:\n",
     "   # see: https://discuss.streamlit.io/t/how-to-launch-streamlit-app-from-google-colab-notebook/42399\n",
     "   print(\"Password/Enpoint IP for localtunnel is:\",urllib.request.urlopen('https://ipv4.icanhazip.com').read().decode('utf8').strip(\"\\n\"))\n",
+    "   # Run the Streamlit app in the background\n",
     "   !streamlit run streamlit_report/sections/report_manager.py --server.address=localhost &>/content/logs.txt &\n",
+    "   # Expose the Streamlit app on port 8501\n",
     "   !npx localtunnel --port 8501 --subdomain vuegen-demo\n",
     "else:\n",
     "    print(\"Streamlit report not executed, set run_streamlit to True to run the report\")"

docs/vuegen_case_study_earth_microbiome.ipynb

@@ -1369,7 +1369,9 @@
    "cell_type": "markdown",
    "metadata": {},
    "source": [
-    "### 4.1. Streamlit report"
+    "### 4.1. Streamlit report\n",
+    "\n",
+    "To launch the Streamlit web application from Colab, open the generated URL and copy the localtunnel entry point IP into the corresponding field on the opened page. Once submited, you will be redirected to your Streamlit web application."
    ]
   },
   {
@@ -1397,7 +1399,9 @@
     "elif run_streamlit:\n",
     "   # see: https://discuss.streamlit.io/t/how-to-launch-streamlit-app-from-google-colab-notebook/42399\n",
     "   print(\"Password/Enpoint IP for localtunnel is:\",urllib.request.urlopen('https://ipv4.icanhazip.com').read().decode('utf8').strip(\"\\n\"))\n",
+    "   # Run the Streamlit app in the background\n",
     "   !streamlit run streamlit_report/sections/report_manager.py --server.address=localhost &>/content/logs.txt &\n",
+    "   # Expose the Streamlit app on port 8501\n",
     "   !npx localtunnel --port 8501 --subdomain vuegen-demo\n",
     "else:\n",
     "    print(\"Streamlit report not executed, set run_streamlit to True to run the report\")"
@@ -1553,7 +1557,9 @@
    "cell_type": "markdown",
    "metadata": {},
    "source": [
-    "### 5.5. Stremlit report with the extended configuration file"
+    "### 5.5. Stremlit report with the extended configuration file\n",
+    "\n",
+    "To launch the Streamlit web application from Colab, open the generated URL and copy the localtunnel entry point IP into the corresponding field on the opened page. Once submited, you will be redirected to your Streamlit web application."
    ]
   },
   {
@@ -1581,7 +1587,9 @@
     "elif run_streamlit:\n",
     "   # see: https://discuss.streamlit.io/t/how-to-launch-streamlit-app-from-google-colab-notebook/42399\n",
     "   print(\"Password/Enpoint IP for localtunnel is:\",urllib.request.urlopen('https://ipv4.icanhazip.com').read().decode('utf8').strip(\"\\n\"))\n",
+    "   # Run the Streamlit app in the background\n",
     "   !streamlit run streamlit_report/sections/report_manager.py --server.address=localhost &>/content/logs.txt &\n",
+    "   # Expose the Streamlit app on port 8501\n",
     "   !npx localtunnel --port 8501 --subdomain vuegen-demo\n",
     "else:\n",
     "    print(\"Streamlit report not executed, set run_streamlit to True to run the report\")"