Merge branch 'master' of https://github.com/academicpages/academicpages.github.io

Author: rjzupkoii

talkmap_out.ipynb

@@ -6,7 +6,21 @@
    "source": [
     "# Leaflet cluster map of talk locations\n",
     "\n",
-    "Run this from the _talks/ directory, which contains .md files of all your talks. This scrapes the location YAML field from each .md file, geolocates it with geopy/Nominatim, and uses the getorg library to output data, HTML, and Javascript for a standalone cluster map."
+    "Assuming you are working in a Linux or Windows Subsystem for Linux environment, you may need to install some dependencies. Assuming a clean installation, the following will be needed:\n",
+    "\n",
+    "```bash\n",
+    "sudo apt install jupyter\n",
+    "sudo apt install python3-pip\n",
+    "pip install getorg --upgrade\n",
+    "```\n",
+    "\n",
+    "After which you can run this from the `_talks/` directory, via:\n",
+    "\n",
+    "```bash\n",
+    " jupyter nbconvert --to notebook --execute talkmap.ipynb --output talkmap_out.ipynb\n",
+    "```\n",
+    " \n",
+    "The `_talks/` directory contains `.md` files of all your talks. This scrapes the location YAML field from each `.md` file, geolocates it with `geopy/Nominatim`, and uses the `getorg` library to output data, HTML, and Javascript for a standalone cluster map."
    ]
   },
   {
@@ -15,10 +29,10 @@
    "metadata": {
     "collapsed": false,
     "execution": {
-     "iopub.execute_input": "2025-02-22T01:09:40.748788Z",
-     "iopub.status.busy": "2025-02-22T01:09:40.748590Z",
-     "iopub.status.idle": "2025-02-22T01:09:41.820985Z",
-     "shell.execute_reply": "2025-02-22T01:09:41.820264Z"
+     "iopub.execute_input": "2025-02-22T01:30:05.703774Z",
+     "iopub.status.busy": "2025-02-22T01:30:05.703517Z",
+     "iopub.status.idle": "2025-02-22T01:30:06.843336Z",
+     "shell.execute_reply": "2025-02-22T01:30:06.842591Z"
     }
    },
    "outputs": [
@@ -43,7 +57,13 @@
       "Requirement already satisfied: typing-extensions>=4.0.0 in /opt/hostedtoolcache/Python/3.9.21/x64/lib/python3.9/site-packages (from pygithub->getorg) (4.12.2)\r\n",
       "Requirement already satisfied: urllib3>=1.26.0 in /opt/hostedtoolcache/Python/3.9.21/x64/lib/python3.9/site-packages (from pygithub->getorg) (2.3.0)\r\n",
       "Requirement already satisfied: Deprecated in /opt/hostedtoolcache/Python/3.9.21/x64/lib/python3.9/site-packages (from pygithub->getorg) (1.2.18)\r\n",
-      "Requirement already satisfied: six>=1.7.0 in /opt/hostedtoolcache/Python/3.9.21/x64/lib/python3.9/site-packages (from retrying->getorg) (1.17.0)\r\n",
+      "Requirement already satisfied: six>=1.7.0 in /opt/hostedtoolcache/Python/3.9.21/x64/lib/python3.9/site-packages (from retrying->getorg) (1.17.0)\r\n"
+     ]
+    },
+    {
+     "name": "stdout",
+     "output_type": "stream",
+     "text": [
       "Requirement already satisfied: cryptography>=3.4.0 in /opt/hostedtoolcache/Python/3.9.21/x64/lib/python3.9/site-packages (from pyjwt[crypto]>=2.4.0->pygithub->getorg) (44.0.1)\r\n",
       "Requirement already satisfied: cffi>=1.4.1 in /opt/hostedtoolcache/Python/3.9.21/x64/lib/python3.9/site-packages (from pynacl>=1.4.0->pygithub->getorg) (1.17.1)\r\n",
       "Requirement already satisfied: charset-normalizer<4,>=2 in /opt/hostedtoolcache/Python/3.9.21/x64/lib/python3.9/site-packages (from requests>=2.14.0->pygithub->getorg) (3.4.1)\r\n",
@@ -66,6 +86,7 @@
     }
    ],
    "source": [
+    "# Start by installing the dependencies\n",
     "!pip install getorg --upgrade\n",
     "import glob\n",
     "import getorg\n",
@@ -78,14 +99,15 @@
    "metadata": {
     "collapsed": false,
     "execution": {
-     "iopub.execute_input": "2025-02-22T01:09:41.823539Z",
-     "iopub.status.busy": "2025-02-22T01:09:41.823058Z",
-     "iopub.status.idle": "2025-02-22T01:09:41.826460Z",
-     "shell.execute_reply": "2025-02-22T01:09:41.825940Z"
+     "iopub.execute_input": "2025-02-22T01:30:06.845946Z",
+     "iopub.status.busy": "2025-02-22T01:30:06.845467Z",
+     "iopub.status.idle": "2025-02-22T01:30:06.849121Z",
+     "shell.execute_reply": "2025-02-22T01:30:06.848477Z"
     }
    },
    "outputs": [],
    "source": [
+    "# Collect the Markdown files\n",
     "g = glob.glob(\"*.md\")"
    ]
   },
@@ -95,14 +117,15 @@
    "metadata": {
     "collapsed": true,
     "execution": {
-     "iopub.execute_input": "2025-02-22T01:09:41.828648Z",
-     "iopub.status.busy": "2025-02-22T01:09:41.828276Z",
-     "iopub.status.idle": "2025-02-22T01:09:41.853054Z",
-     "shell.execute_reply": "2025-02-22T01:09:41.852554Z"
+     "iopub.execute_input": "2025-02-22T01:30:06.851364Z",
+     "iopub.status.busy": "2025-02-22T01:30:06.850962Z",
+     "iopub.status.idle": "2025-02-22T01:30:06.876444Z",
+     "shell.execute_reply": "2025-02-22T01:30:06.875850Z"
     }
    },
    "outputs": [],
    "source": [
+    "# Prepare to geolocate\n",
     "geocoder = Nominatim(user_agent=\"academicpages.github.io\")\n",
     "location_dict = {}\n",
     "location = \"\"\n",
@@ -116,10 +139,10 @@
    "metadata": {
     "collapsed": false,
     "execution": {
-     "iopub.execute_input": "2025-02-22T01:09:41.855227Z",
-     "iopub.status.busy": "2025-02-22T01:09:41.854845Z",
-     "iopub.status.idle": "2025-02-22T01:09:44.188915Z",
-     "shell.execute_reply": "2025-02-22T01:09:44.188226Z"
+     "iopub.execute_input": "2025-02-22T01:30:06.878925Z",
+     "iopub.status.busy": "2025-02-22T01:30:06.878494Z",
+     "iopub.status.idle": "2025-02-22T01:30:09.224074Z",
+     "shell.execute_reply": "2025-02-22T01:30:09.223402Z"
     }
    },
    "outputs": [
@@ -141,7 +164,7 @@
     }
    ],
    "source": [
-    "\n",
+    "# Perform geolocation\n",
     "for file in g:\n",
     "    with open(file, 'r') as f:\n",
     "        lines = f.read()\n",
@@ -162,10 +185,10 @@
    "metadata": {
     "collapsed": false,
     "execution": {
-     "iopub.execute_input": "2025-02-22T01:09:44.191211Z",
-     "iopub.status.busy": "2025-02-22T01:09:44.190804Z",
-     "iopub.status.idle": "2025-02-22T01:09:44.198598Z",
-     "shell.execute_reply": "2025-02-22T01:09:44.197939Z"
+     "iopub.execute_input": "2025-02-22T01:30:09.226429Z",
+     "iopub.status.busy": "2025-02-22T01:30:09.225951Z",
+     "iopub.status.idle": "2025-02-22T01:30:09.233806Z",
+     "shell.execute_reply": "2025-02-22T01:30:09.233240Z"
     }
    },
    "outputs": [
@@ -181,6 +204,7 @@
     }
    ],
    "source": [
+    "# Save the map\n",
     "m = getorg.orgmap.create_map_obj()\n",
     "getorg.orgmap.output_html_cluster_map(location_dict, folder_name=\"../talkmap\", hashed_usernames=False)"
    ]