E3SM UXarray and Dask Examples

docs/conf.py

@@ -207,7 +207,12 @@ def __getattr__(cls, name):
 autodoc_typehints = "none"
 
 # notebooks to exclude from run-time execution, will use rendered version
-nb_execution_excludepatterns = ["3_75km_mpas.ipynb"]
+nb_execution_excludepatterns = [
+    "3_75km_mpas.ipynb",
+    "e3sm-calc-workflow.ipynb",
+    "e3sm-load-viz.ipynb",
+    "parallel-load-ux-with-dask.ipynb",
+]
 
 
 # custom scripts for making a gallery of examples notebooks

docs/examples/template.ipynb

@@ -2,29 +2,62 @@
  "cells": [
   {
    "cell_type": "markdown",
+   "id": "26faf1b8-c7be-484b-8ca7-41da85fee2f4",
    "metadata": {},
    "source": [
-    "# Blank Template Notebook"
+    "# Template for UXarray Usage Example "
    ]
   },
   {
-   "cell_type": "code",
-   "execution_count": 1,
+   "cell_type": "markdown",
+   "id": "b7dd298f-ab54-4611-9c73-49e6b5fd92ae",
    "metadata": {},
-   "outputs": [],
-   "source": []
+   "source": [
+    "## Overview\n",
+    "\n",
+    "This usage example showcases how the template for UXarray usage examples would look like."
+   ]
   },
   {
-   "cell_type": "code",
-   "execution_count": null,
+   "cell_type": "markdown",
+   "id": "c1d30c3c-bf3b-4921-9e01-e99090286dcc",
    "metadata": {},
-   "outputs": [],
-   "source": []
+   "source": [
+    "## Imports\n",
+    "This notebook requires the following packages to be installed in the notebook environment. \n",
+    "```\n",
+    "mamba install -c conda-forge [required packages here]\n",
+    "```"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "id": "eadb8648-9036-49d8-8f0e-a62122c386cd",
+   "metadata": {},
+   "source": [
+    "## Interesting First Section Here"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "id": "ace849b1-e9b3-4b1d-818e-fdd44420ef85",
+   "metadata": {},
+   "source": [
+    "## Cool Second Section Here"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "id": "b983c6a5-636e-4641-8526-b3e242533ce8",
+   "metadata": {},
+   "source": [
+    "## Innovative Third Section Here"
+   ]
   }
  ],
  "metadata": {
   "kernelspec": {
-   "display_name": "Python 3.9.13 ('uxarray-docs')",
+   "display_name": "Python 3 (ipykernel)",
    "language": "python",
    "name": "python3"
   },
@@ -38,15 +71,9 @@
    "name": "python",
    "nbconvert_exporter": "python",
    "pygments_lexer": "ipython3",
-   "version": "3.9.13"
-  },
-  "orig_nbformat": 4,
-  "vscode": {
-   "interpreter": {
-    "hash": "5df6a94ef43b22c97c277f6a9dce3b546a324b9de41c6d8e82aecf8eafd14442"
-   }
+   "version": "3.10.13"
   }
  },
  "nbformat": 4,
- "nbformat_minor": 2
+ "nbformat_minor": 5
 }