Merge pull request #215 from cecilehannay/main

NCAR HPC section improvement and reorg
NCAR · Jul 14, 2024 · 57b90b2 · 57b90b2
2 parents 813e864 + 72f8902
commit 57b90b2
Show file tree

Hide file tree

Showing 3 changed files with 67 additions and 14 deletions.
diff --git a/notebooks/prereqs/prereqs_overview.ipynb b/notebooks/prereqs/prereqs_overview.ipynb
@@ -29,6 +29,7 @@
    "id": "24e22d53-7b0b-4fb8-82ad-360e75e64ac0",
    "metadata": {},
    "source": [
+    "___\n",
     "## Terminal windows"
    ]
   },
@@ -59,6 +60,7 @@
    "id": "37406e6f-57c2-4493-86a9-52bc2d5eb3f8",
    "metadata": {},
    "source": [
+    "___\n",
     "## UNIX"
    ]
   },
@@ -87,7 +89,8 @@
    "id": "16324ba6-5c27-41c2-8e62-dc2ccc817527",
    "metadata": {},
    "source": [
-    "## NCAR High Performance Computing (HPC)"
+    "___\n",
+    "## Login to NCAR High Performance Computing (HPC)"
    ]
   },
   {
@@ -138,12 +141,46 @@
    "cell_type": "markdown",
    "id": "3c9cc169-489e-427a-865a-539468cb060d",
    "metadata": {},
-   "source": []
+   "source": [
+    "____\n",
+    "## Using JupyterHub"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "id": "4a799266-780e-4281-8955-e20e522cdb4d",
+   "metadata": {},
+   "source": [
+    "The diagnostics section of this tutorial will use JupyterHub to run Jupyter Notebooks. You will need to login to the NCAR JupyterHub system to run the notebooks successfully.\n",
+    "\n",
+    "NOTE: To run a Jupyter cell\n",
+    "- Type your command into the cell\n",
+    "- To execute the command:\n",
+    "    - Press **shift+return**\n",
+    "    <div>\n",
+    "    OR\n",
+    "    <div>\n",
+    "    - Select the cell then click the 'play' button at the top of the window\n",
+    "\n",
+    "To learn more about JupyterHub, please follow the link below."
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "id": "7db0afc5-0462-45db-ac81-1ee18c34c716",
+   "metadata": {},
+   "source": [
+    "<div class=\"alert alert-info\" style=\"text-align: center;\">\n",
+    "\n",
+    "[CISL Documentation about JupyterHub](https://arc.ucar.edu/knowledge_base/70549913)\n",
+    "    \n",
+    "</div>"
+   ]
   },
   {
    "cell_type": "code",
    "execution_count": null,
-   "id": "7a1cb820-6efd-4eda-9581-a7067ff4f27d",
+   "id": "088d2dc6-ae4f-4023-93d4-494aeaf8ba44",
    "metadata": {},
    "outputs": [],
    "source": []

diff --git a/notebooks/resources/ncar_hpc.ipynb b/notebooks/resources/ncar_hpc.ipynb
@@ -1,29 +1,30 @@
 {
  "cells": [
   {
-   "cell_type": "markdown",
-   "id": "f406f992-92bd-4b17-9bd3-b99c5c8abaf3",
+   "cell_type": "raw",
+   "id": "b631e7d7-f1d7-4253-b1b4-d01984037d37",
    "metadata": {},
    "source": [
-    "# NCAR High Performance Computing (HPC)¶"
+    "# NCAR Supercomputer¶\n",
+    "\n",
+    "Once you have an account and the necessary software, you can log in and run jobs on the NCAR supercomputer. The NCAR supercomputer is also referenced to the NCAR High Performance Computing (HPC). "
    ]
   },
   {
    "cell_type": "markdown",
    "id": "28823b60-6956-417c-a48c-3b88668b0968",
    "metadata": {},
    "source": [
-    "### X11"
+    "___\n",
+    "## Logging in on an NCAR system¶"
    ]
   },
   {
    "cell_type": "markdown",
    "id": "3b3e13f6-45e2-4dc8-bd2a-b550ddb11270",
    "metadata": {},
    "source": [
-    "X11 forwarding is an SSH protocol that enables users to run graphical applications on a remote server and interact with them using their local display and I/O devices. It is frequently used by CESM developers for securely interacting with NCAR HPC remote machines.\n",
-    "\n",
-    "When you log in to the NCAR HPC machines, we recommend you use X11 forwarding. You can do this by adding the `-XY` option when logging into the machines with `SSH`. More information about logging into the NCAR HPC follows below."
+    "To log in, start your terminal or Secure Shell client and run an `ssh` command as shown here:\n"
    ]
   },
   {
@@ -40,6 +41,17 @@
     "```"
    ]
   },
+  {
+   "cell_type": "markdown",
+   "id": "311d9679-8944-49c0-936e-8e8ddcc3ba37",
+   "metadata": {},
+   "source": [
+    "\n",
+    "When you log in to the NCAR HPC machines, we recommend you use `X11` forwarding. `X11` forwarding is an SSH protocol that enables users to run graphical applications on a remote server and interact with them using their local display and I/O devices. It is frequently used by CESM developers for securely interacting with NCAR HPC remote machines.\n",
+    "\n",
+    "You can do this by adding the `-XY` option when logging into the machines with `SSH`. More information about logging into the NCAR HPC follows below."
+   ]
+  },
   {
    "cell_type": "markdown",
    "id": "510846c7-4018-420e-a899-96e1b9e92902",
@@ -57,7 +69,8 @@
    "id": "e731c34f-4386-4869-bdb7-a6e479f07a63",
    "metadata": {},
    "source": [
-    "### Running on derecho"
+    "___\n",
+    "## Running on derecho"
    ]
   },
   {
@@ -103,7 +116,8 @@
    "id": "8a831d36-6629-4cd6-a247-2a8293aa2561",
    "metadata": {},
    "source": [
-    "### Using Casper"
+    "___\n",
+    "## Using Casper"
    ]
   },
   {
@@ -131,7 +145,8 @@
    "id": "603c963b-4d65-4cd6-94a3-ea5ae932578e",
    "metadata": {},
    "source": [
-    "### Using JupyterHub"
+    "___\n",
+    "## Using JupyterHub"
    ]
   },
   {
@@ -170,6 +185,7 @@
    "id": "144caca2-989b-40a5-b6c0-c8a0b7a470da",
    "metadata": {},
    "source": [
+    "___\n",
     "## Modules on NCAR HPC"
    ]
   },

diff --git a/notebooks/resources/profile.ipynb b/notebooks/resources/profile.ipynb
@@ -5,7 +5,7 @@
    "id": "b2cd974a-dfbb-4937-8ed0-ab87ab60f1ef",
    "metadata": {},
    "source": [
-    "# 2024 CESM Tutorial specific instructions"
+    "# Tutorial specific instructions"
    ]
   },
   {