E3SM UXarray and Dask Examples (#836)

* created calc notebook * created e3sm load notebook * included plots of 3 vars from E3SM * renamed and updated load notebook * updated and renamed workflow notebook * completed load notebook * finalized load notebook * finalized e3sm_load_xmple branch structure * finalized files working on in main branch * populated content for parallel load data * populated load notebook * populated load notebook * updated parallel notebook * edited parallel load section * update ipynb checkpoints * made edits to calc notebook * merging parallel_load_input to main * updated file organization in sync with uxarray main * populated code for e3sm calc workflow notebook * updated user guide with parallel load notebook * updated gallery menus * Delete docs/examples/.ipynb_checkpoints directory * push all updates related to e3sm notebooks * include thumbnail and dask notebook * updated with reviews in UXarray #836 * edited markdown for equations * added Dask cluster to parallel load notebook in user-guide and edited formatting in e3sm_calc notebook * cleaned comments in cell * updated with Orhan's comments * Increased figure size in calc examples, included reasons for parallel loading and edited conf.py paths * updated parallel load userguide and cleaned up e3sm visualization examples * Update docs/gallery.yml Co-authored-by: Philip Chmielowiec <67855069+philipc2@users.noreply.github.com> * Update docs/userguide.rst Co-authored-by: Philip Chmielowiec <67855069+philipc2@users.noreply.github.com> * modified gallery.yml * updated files * Update docs/gallery.yml Co-authored-by: Philip Chmielowiec <67855069+philipc2@users.noreply.github.com> * udpated with PR comments * commit e3sm-load-viz notebook * cleaned up thumbnails and rendered figures * show rendered figures * updated figures * updated plotting method in e3sm workflow notebook --------- Co-authored-by: Rachel Yuen Sum Tam <rtam@derecho7.hsn.de.hpc.ucar.edu> Co-authored-by: Rachel Yuen Sum Tam <rtam@casper-login2.hpc.ucar.edu> Co-authored-by: Philip Chmielowiec <67855069+philipc2@users.noreply.github.com> Co-authored-by: Rachel Yuen Sum Tam <rtam@dec1114.hsn.de.hpc.ucar.edu> Co-authored-by: Rachel Yuen Sum Tam <rtam@dec0632.hsn.de.hpc.ucar.edu> Co-authored-by: Rachel Yuen Sum Tam <rtam@dec0634.hsn.de.hpc.ucar.edu> Co-authored-by: Rachel Yuen Sum Tam <rtam@dec0416.hsn.de.hpc.ucar.edu> Co-authored-by: Orhan Eroglu <32553057+erogluorhan@users.noreply.github.com> Co-authored-by: Rachel Yuen Sum Tam <rtam@dec2449.hsn.de.hpc.ucar.edu> Co-authored-by: Rachel Yuen Sum Tam <rtam@crhtc52.hpc.ucar.edu> Co-authored-by: Rajeev Jain <rajeeja@gmail.com> Co-authored-by: Rachel Yuen Sum Tam <rtam@dec2363.hsn.de.hpc.ucar.edu> Co-authored-by: Rachel Yuen Sum Tam <rtam@dec0192.hsn.de.hpc.ucar.edu> Co-authored-by: Rachel Yuen Sum Tam <rtam@dec0166.hsn.de.hpc.ucar.edu> Co-authored-by: Rachel Yuen Sum Tam <rtam@dec2445.hsn.de.hpc.ucar.edu> Co-authored-by: Rachel Yuen Sum Tam <rtam@dec0420.hsn.de.hpc.ucar.edu> Co-authored-by: Rachel Yuen Sum Tam <rtam@dec2452.hsn.de.hpc.ucar.edu> Co-authored-by: Rachel Yuen Sum Tam <rtam@dec1093.hsn.de.hpc.ucar.edu>
UXARRAY · Oct 23, 2024 · 933bfc5 · 933bfc5
1 parent b807976
commit 933bfc5
Show file tree

Hide file tree

Showing 10 changed files with 89,844 additions and 21 deletions.
diff --git a/docs/_static/thumbnails/qflx_e3sm.png b/docs/_static/thumbnails/qflx_e3sm.png
diff --git a/docs/_static/thumbnails/swcre_e3sm.png b/docs/_static/thumbnails/swcre_e3sm.png
diff --git a/docs/conf.py b/docs/conf.py
@@ -210,7 +210,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

diff --git a/docs/examples/e3sm-calc-workflow.ipynb b/docs/examples/e3sm-calc-workflow.ipynb
diff --git a/docs/examples/template.ipynb b/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
 }
diff --git a/docs/examples/visualization/e3sm-load-viz.ipynb b/docs/examples/visualization/e3sm-load-viz.ipynb
diff --git a/docs/gallery.rst b/docs/gallery.rst
@@ -24,6 +24,7 @@ across various interesting datasets.
 
    examples/visualization/3_75km_mpas.ipynb
    examples/visualization/mpas_topology.ipynb
+   examples/visualization/e3sm-load-viz.ipynb
 
 
 
@@ -39,6 +40,7 @@ The following notebooks showcase workflows of Uxarray in action.
    :hidden:
 
    examples/working-with-mpas-grids.ipynb
+   examples/e3sm-calc-workflow.ipynb
 
 External Examples
 -----------------

diff --git a/docs/gallery.yml b/docs/gallery.yml
@@ -7,12 +7,18 @@ visualization-examples:
     path: examples/visualization/mpas_topology.ipynb
     thumbnail: _static/thumbnails/mpas_topology.png
 
+  - title: Plotting E3SMv2 Output with UXarray
+    path: examples/visualization/e3sm-load-viz.ipynb
+    thumbnail: _static/thumbnails/qflx_e3sm.png
+
 workflow-examples:
   - title: Working with MPAS Grids
     path: examples/working-with-mpas-grids.ipynb
     thumbnail: _static/thumbnails/004-thumbnail.png
 
-
+  - title:  Radiative Feedback Analysis on E3SMv2 Model Output
+    path: examples/e3sm-calc-workflow.ipynb
+    thumbnail: _static/thumbnails/swcre_e3sm.png
 
 external-examples:
   - title: Unstructured Grid Visualization Cookbook