Refinements to NCL and computational notebook tempaltes (#43)

Author: anissa111

templates/computational_template.ipynb

@@ -32,28 +32,21 @@
    ]
   },
   {
-   "cell_type": "markdown",
    "metadata": {},
-   "source": [
-    "## Content\n",
-    "In the content sections, provide sections on topics such as:\n",
-    "- working through a geoscience-specific problem\n",
-    "- explaining the concepts behind the functionality\n",
-    "- introducing other examples in the python ecosystem that cover similar topics\n"
-   ]
-  },
-  {
    "cell_type": "markdown",
-   "metadata": {},
-   "source": [
-    "Then link to the corresponding computational notebook that demonstrates the functionality in python. If one does not exist, create one."
-   ]
+   "source": "---"
   },
   {
    "cell_type": "markdown",
    "metadata": {},
    "source": [
-    "Include the same summary section of the computational notebook, highlighting if any altercations have been made to match the NCL functionality more closely"
+    " ## Content Sections\n",
+    "In the content sections, provide sections on topics such as:\n",
+    "- working through a geoscience-specific problem\n",
+    "- explaining the concepts behind the functionality\n",
+    "- introducing other examples in the python ecosystem that cover similar topics\n",
+    "\n",
+    "*Note that these examples can be their own ##-level headers and that your final notebook is not expected to have a section with the ## Content Sections present in this cell*"
    ]
   }
  ],

templates/ncl_template.ipynb

@@ -45,24 +45,37 @@
    "cell_type": "markdown",
    "metadata": {},
    "source": [
-    "## Content\n",
+    "## Content Sections\n",
     "In the content sections, provide relevant context to the NCL functions. For example, cover topics like:\n",
     "- Is there relevant history to the function?\n",
     "- Is there a specific use case that the function is designed for?\n",
     "- Are the methods used in the original function still relevant or outdated?\n",
     "- How closely does python replicate the functionality?\n",
-    "- What flags or inputs should be used in python to replicate the functionality?\n"
+    "- What flags or inputs should be used in python to replicate the functionality?\n",
+    "\n",
+    "*Note that these examples can be their own ##-level headers and that your final notebook is not expected to have a section with the ## Content Sections present in this cell*"
    ]
   },
   {
    "cell_type": "markdown",
    "metadata": {},
-   "source": "Then link to the corresponding computational notebook that demonstrates the functionality in python. If one does not exist, consider creating one."
+   "source": [
+    "## Python changes to approximate NCL functionality\n",
+    "As a summary to the content sections above, compare the grab and go section of any corresponding computational notebook, highlighting if any altercations have been made to match the NCL functionality more closely.\n",
+    "\n",
+    "If there is no corresponding computational notebook, it is okay to just note what sections of the grab-and-go are specific to matching the python snippet to NCL functionality."
+   ]
   },
   {
-   "cell_type": "markdown",
    "metadata": {},
-   "source": "Include the same grab and go section of the computational notebook, highlighting if any altercations have been made to match the NCL functionality more closely"
+   "cell_type": "markdown",
+   "source": [
+    "## Python Resources\n",
+    "\n",
+    "Link to the corresponding computational notebook that demonstrates the functionality in python. If one does not exist, consider creating one.\n",
+    "\n",
+    "If no corresponding computational notebook exists in geocat-applications, linking to external resources is also appropriate."
+   ]
   },
   {
    "metadata": {},