Merge pull request #13 from dopplershift/cleanup

Clean up and reorganize
ProjectPythia · Jun 14, 2024 · 02d6a93 · 02d6a93
2 parents 8674d6f + 1a0af4a
commit 02d6a93
Show file tree

Hide file tree

Showing 46 changed files with 86 additions and 44 deletions.
diff --git a/README.md b/README.md
@@ -1,14 +1,12 @@
 <div class="row">
    <div class="column">
-      <img src="pythia.png" alt="Project Pythia Logo" width="35%"/>
+      <img src="_static/NSF-Unidata_lockup_horizontal_2023_light.png" alt="NSF-Unidata Logo" width="35%"/>
    </div>
    <div class="column">
-      <img src="unidata.png" alt="Unidata Logo" width="35%"/>
+      <img src="_static/metpy_150x150.png" alt="MetPy Logo" width="35%"/>
    </div>
 </div>
 
-**:warning: THIS COOKBOOK IS UNDER CONSTRUCTION :warning:**
-
 # MetPy Cookbook
 
 [![nightly-build](https://github.com/ProjectPythia/metpy-cookbook/actions/workflows/nightly-build.yaml/badge.svg)](https://github.com/ProjectPythia/metpy-cookbook/actions/workflows/nightly-build.yaml)

diff --git a/_config.yml b/_config.yml
@@ -3,7 +3,7 @@
 
 title: The MetPy Cookbook
 author: MetPy Maintainers
-logo: pythia.png
+logo: _static/metpy_150x150.png
 email: [email protected]
 copyright: "2024"
 

diff --git a/_static/NSF-Unidata_lockup_horizontal_2023_light.png b/_static/NSF-Unidata_lockup_horizontal_2023_light.png
diff --git a/_static/metpy_150x150.png b/_static/metpy_150x150.png
diff --git a/_toc.yml b/_toc.yml
@@ -6,21 +6,23 @@ parts:
       - file: notebooks/how-to-cite
   - caption: The MetPy Gallery
     chapters:
-      - file: notebooks/notebook-template
-        title: What organization
+      - file: notebooks/synoptic/index
+        title: Synoptic Analysis
         sections:
-          - glob: notebooks/gallery/*
-      - file: notebooks/gallery/index1
-        title: do we want
-      - file: notebooks/gallery/index2
-        title: for these "chapters"? 
-  - caption: Skew-T Notebooks
-    chapters:
-      - file: notebooks/Foundational_Sounding
-      - file: notebooks/Advanced_Sounding
-      - file: notebooks/Skew-T_Hodograph_Inset
-      - file: notebooks/Skew-T_Layout_Hodograph
-      - file: notebooks/Skew-T_Analysis
-      - file: notebooks/Sounding_LCL_Dataset
-      - file: notebooks/Sounding_Plotter
-      - file: notebooks/Sounding_Calculations
+          - glob: notebooks/synoptic/*
+      - file: notebooks/skewt/index
+        title: Skew-T Analysis
+        sections:
+          - glob: notebooks/skewt/*
+      - file: notebooks/convective/index
+        title: Convective Calculations
+        sections:
+          - glob: notebooks/convective/*
+      - file: notebooks/specialty/index
+        title: Specialty Plotting
+        sections:
+          - glob: notebooks/specialty/*
+      - file: notebooks/declarative/index
+        title: Simplified Plotting
+        sections:
+          - glob: notebooks/declarative/*
diff --git a/notebooks/MUCAPE.ipynb → notebooks/convective/MUCAPE.ipynb b/notebooks/MUCAPE.ipynb → notebooks/convective/MUCAPE.ipynb
@@ -1,5 +1,17 @@
 {
  "cells": [
+  {
+   "cell_type": "markdown",
+   "metadata": {
+    "cell_marker": "\"\"\"",
+    "lines_to_next_cell": 0
+   },
+   "source": [
+    "Most-Unstable Convective Available Potential Energy (MUCAPE)\n",
+    "======================\n",
+    "Calculate MUCAPE on a grid of netCDF data using MetPy."
+   ]
+  },
   {
    "cell_type": "code",
    "execution_count": 10,
@@ -35,7 +47,7 @@
    "source": [
     "## opening NetCDF file using xarray \n",
     "\n",
-    "ds = xr.open_mfdataset(\"/home/jovyan/metpy-cookbook/NETCDF_FILE.nc\",combine = \"nested\", concat_dim=\"time\",decode_times=True)"
+    "ds = xr.open_dataset(\"NETCDF_FILE.nc\", decode_times=True)"
    ]
   },
   {

diff --git a/NETCDF_FILE.nc → notebooks/convective/NETCDF_FILE.nc b/NETCDF_FILE.nc → notebooks/convective/NETCDF_FILE.nc
diff --git a/notebooks/TCPW.ipynb → notebooks/convective/TCPW.ipynb b/notebooks/TCPW.ipynb → notebooks/convective/TCPW.ipynb
@@ -1,5 +1,17 @@
 {
  "cells": [
+  {
+   "cell_type": "markdown",
+   "metadata": {
+    "cell_marker": "\"\"\"",
+    "lines_to_next_cell": 0
+   },
+   "source": [
+    "Total Column Precipitable Water (TCPW)\n",
+    "======================\n",
+    "Calculate TCPW on a grid of netCDF data using MetPy."
+   ]
+  },
   {
    "cell_type": "code",
    "execution_count": 10,
@@ -26,7 +38,7 @@
    "source": [
     "## opening NetCDF file using xarray \n",
     "\n",
-    "ds = xr.open_mfdataset(\"/home/jovyan/metpy-cookbook/NETCDF_FILE.nc\",combine = \"nested\", concat_dim=\"time\",decode_times=True)"
+    "ds = xr.open_dataset(\"NETCDF_FILE.nc\", decode_times=True)"
    ]
   },
   {

diff --git a/notebooks/convective/index.md b/notebooks/convective/index.md
@@ -0,0 +1,3 @@
+# Convective Calculations
+
+This section covers how to perform a variety of calculations around analyzing convection and severe weather.
diff --git a/notebooks/gallery/miller_composite.ipynb → notebooks/convective/miller_composite.ipynb b/notebooks/gallery/miller_composite.ipynb → notebooks/convective/miller_composite.ipynb
diff --git a/notebooks/gallery/Declarative_300hPa.ipynb → ...ooks/declarative/Declarative_300hPa.ipynb b/notebooks/gallery/Declarative_300hPa.ipynb → ...ooks/declarative/Declarative_300hPa.ipynb
diff --git a/notebooks/gallery/declarative_500_hPa.ipynb → ...oks/declarative/declarative_500_hPa.ipynb b/notebooks/gallery/declarative_500_hPa.ipynb → ...oks/declarative/declarative_500_hPa.ipynb
diff --git a/notebooks/declarative/index.md b/notebooks/declarative/index.md
@@ -0,0 +1,3 @@
+# MetPy's Simplified Plotting Interface
+
+TBD
diff --git a/notebooks/gallery/index1.md b/notebooks/gallery/index1.md
diff --git a/notebooks/gallery/index2.md b/notebooks/gallery/index2.md
diff --git a/notebooks/Advanced_Sounding.ipynb → notebooks/skewt/Advanced_Sounding.ipynb b/notebooks/Advanced_Sounding.ipynb → notebooks/skewt/Advanced_Sounding.ipynb
diff --git a/notebooks/Foundational_Sounding.ipynb → notebooks/skewt/Foundational_Sounding.ipynb b/notebooks/Foundational_Sounding.ipynb → notebooks/skewt/Foundational_Sounding.ipynb
@@ -1,26 +1,12 @@
 {
  "cells": [
-  {
-   "cell_type": "markdown",
-   "metadata": {},
-   "source": [
-    "<img src=\"images/ProjectPythia_Logo_Final-01-Blue.svg\" width=250 alt=\"Project Pythia Logo\"></img>"
-   ]
-  },
   {
    "cell_type": "markdown",
    "metadata": {},
    "source": [
     "# MetPy Skew-T Cookbook"
    ]
   },
-  {
-   "cell_type": "markdown",
-   "metadata": {},
-   "source": [
-    "---"
-   ]
-  },
   {
    "cell_type": "markdown",
    "metadata": {},
@@ -45,7 +31,7 @@
     "| Concepts | Importance | Notes |\n",
     "| --- | --- | --- |\n",
     "| [Intermediate NumPy](https://foundations.projectpythia.org/core/numpy/intermediate-numpy.html)| Necessary | |\n",
-    "| [Matplotlib Basis](https://foundations.projectpythia.org/core/matplotlib/matplotlib-basics.html) | Necessary |\n",
+    "| [Matplotlib Basics](https://foundations.projectpythia.org/core/matplotlib/matplotlib-basics.html) | Necessary |\n",
     "\n",
     "- **Time to learn**: 30 minutes\n"
    ]
@@ -609,8 +595,7 @@
     "> [Unidata Main Website](https://www.unidata.ucar.edu) <br>\n",
     "> [Unidata GitHub](https://github.com/Unidata) <br>\n",
     "> [Unidata YouTube Channel](https://www.youtube.com/user/unidatanews) <br>\n",
-    "> [Matplotlib Documentation](https://matplotlib.org) <br>\n",
-    "> [Unidata Python Training](https://unidata.github.io/python-training/) <br>\n"
+    "> [Matplotlib Documentation](https://matplotlib.org) <br>\n"
    ]
   }
  ],

diff --git a/notebooks/Skew-T_Analysis.ipynb → notebooks/skewt/Skew-T_Analysis.ipynb b/notebooks/Skew-T_Analysis.ipynb → notebooks/skewt/Skew-T_Analysis.ipynb
diff --git a/notebooks/Skew-T_Hodograph_Inset.ipynb → notebooks/skewt/Skew-T_Hodograph_Inset.ipynb b/notebooks/Skew-T_Hodograph_Inset.ipynb → notebooks/skewt/Skew-T_Hodograph_Inset.ipynb
diff --git a/notebooks/Skew-T_Layout_Hodograph.ipynb → ...books/skewt/Skew-T_Layout_Hodograph.ipynb b/notebooks/Skew-T_Layout_Hodograph.ipynb → ...books/skewt/Skew-T_Layout_Hodograph.ipynb
diff --git a/notebooks/Sounding_Calculations.ipynb → notebooks/skewt/Sounding_Calculations.ipynb b/notebooks/Sounding_Calculations.ipynb → notebooks/skewt/Sounding_Calculations.ipynb
diff --git a/notebooks/Sounding_LCL_Dataset.ipynb → notebooks/skewt/Sounding_LCL_Dataset.ipynb b/notebooks/Sounding_LCL_Dataset.ipynb → notebooks/skewt/Sounding_LCL_Dataset.ipynb
diff --git a/notebooks/Sounding_Plotter.ipynb → notebooks/skewt/Sounding_Plotter.ipynb b/notebooks/Sounding_Plotter.ipynb → notebooks/skewt/Sounding_Plotter.ipynb
diff --git a/notebooks/skewt/index.md b/notebooks/skewt/index.md
@@ -0,0 +1,10 @@
+# Skew-T Analysis
+
+The Skew-T Log-P diagram, or "Skew-T\" for short, is a type of plot specific
+to meteorology that is frequently used in the analysis of vertical profiles of
+temperature and humidity. For instance, the data collected by weather balloons
+in 12-hourly soundings are often shown with such plots, as they foster an
+understanding of e.g. the stability of the atmosphere above a location.
+
+The units in this chapter show ways to use MetPy to generate skew-T plots and
+customize them with various pieces of information.
diff --git a/notebooks/gallery/Hovmoller_Diagram.ipynb → notebooks/specialty/Hovmoller_Diagram.ipynb b/notebooks/gallery/Hovmoller_Diagram.ipynb → notebooks/specialty/Hovmoller_Diagram.ipynb
diff --git a/...ry/Observational_Data_Cross_Section.ipynb → ...ty/Observational_Data_Cross_Section.ipynb b/...ry/Observational_Data_Cross_Section.ipynb → ...ty/Observational_Data_Cross_Section.ipynb
diff --git a/notebooks/gallery/Smoothing_Contours.ipynb → notebooks/specialty/Smoothing_Contours.ipynb b/notebooks/gallery/Smoothing_Contours.ipynb → notebooks/specialty/Smoothing_Contours.ipynb
diff --git a/notebooks/specialty/index.md b/notebooks/specialty/index.md
@@ -0,0 +1,3 @@
+# Specialty Plotting
+
+This section shows how to accomplish some specialty plotting, such as cross-sections and smoothing, using MetPy.
diff --git a/...oks/gallery/250hPa_Hemispheric_Plot.ipynb → ...ks/synoptic/250hPa_Hemispheric_Plot.ipynb b/...oks/gallery/250hPa_Hemispheric_Plot.ipynb → ...ks/synoptic/250hPa_Hemispheric_Plot.ipynb
diff --git a/...ery/500hPa_Absolute_Vorticity_winds.ipynb → ...tic/500hPa_Absolute_Vorticity_winds.ipynb b/...ery/500hPa_Absolute_Vorticity_winds.ipynb → ...tic/500hPa_Absolute_Vorticity_winds.ipynb
diff --git a/.../gallery/500hPa_Vorticity_Advection.ipynb → ...synoptic/500hPa_Vorticity_Advection.ipynb b/.../gallery/500hPa_Vorticity_Advection.ipynb → ...synoptic/500hPa_Vorticity_Advection.ipynb
diff --git a/notebooks/gallery/850hPa_Frontogenesis.ipynb → ...books/synoptic/850hPa_Frontogenesis.ipynb b/notebooks/gallery/850hPa_Frontogenesis.ipynb → ...books/synoptic/850hPa_Frontogenesis.ipynb
diff --git a/notebooks/gallery/850hPa_QVectors.ipynb → notebooks/synoptic/850hPa_QVectors.ipynb b/notebooks/gallery/850hPa_QVectors.ipynb → notebooks/synoptic/850hPa_QVectors.ipynb
diff --git a/...allery/850hPa_Temperature_Advection.ipynb → ...noptic/850hPa_Temperature_Advection.ipynb b/...allery/850hPa_Temperature_Advection.ipynb → ...noptic/850hPa_Temperature_Advection.ipynb
diff --git a/...s/gallery/Ageostrophic_Wind_Example.ipynb → .../synoptic/Ageostrophic_Wind_Example.ipynb b/...s/gallery/Ageostrophic_Wind_Example.ipynb → .../synoptic/Ageostrophic_Wind_Example.ipynb
diff --git a/...ooks/gallery/Analytic_300hPa_Trough.ipynb → ...oks/synoptic/Analytic_300hPa_Trough.ipynb b/...ooks/gallery/Analytic_300hPa_Trough.ipynb → ...oks/synoptic/Analytic_300hPa_Trough.ipynb
diff --git a/.../Differential_Temperature_Advection.ipynb → .../Differential_Temperature_Advection.ipynb b/.../Differential_Temperature_Advection.ipynb → .../Differential_Temperature_Advection.ipynb
diff --git a/...books/Geostrophic_Wind_And_Few_More.ipynb → ...optic/Geostrophic_Wind_And_Few_More.ipynb b/...books/Geostrophic_Wind_And_Few_More.ipynb → ...optic/Geostrophic_Wind_And_Few_More.ipynb
@@ -1,5 +1,18 @@
 {
  "cells": [
+  {
+   "cell_type": "markdown",
+   "metadata": {
+    "cell_marker": "\"\"\"",
+    "lines_to_next_cell": 0
+   },
+   "source": [
+    "Geostrophic Wind and Other Calcuations\n",
+    "======================================\n",
+    "\n",
+    "Demonstrate a variety of calculations in MetPy."
+   ]
+  },
   {
    "cell_type": "code",
    "execution_count": 1,
@@ -37,7 +50,7 @@
    "source": [
     "## opening NetCDF file using xarray \n",
     "\n",
-    "ds = xr.open_mfdataset(\"/home/jovyan/metpy-cookbook/NETCDF_FILE.nc\",combine = \"nested\", concat_dim=\"time\",decode_times=True)"
+    "ds = xr.open_dataset(\"../convective/NETCDF_FILE.nc\", decode_times=True)"
    ]
   },
   {

diff --git a/...ks/gallery/Isentropic_Interpolation.ipynb → ...s/synoptic/Isentropic_Interpolation.ipynb b/...ks/gallery/Isentropic_Interpolation.ipynb → ...s/synoptic/Isentropic_Interpolation.ipynb
diff --git a/...ooks/gallery/PV_baroclinic_isobaric.ipynb → ...oks/synoptic/PV_baroclinic_isobaric.ipynb b/...ooks/gallery/PV_baroclinic_isobaric.ipynb → ...oks/synoptic/PV_baroclinic_isobaric.ipynb
diff --git a/notebooks/gallery/Upperair_Obs.ipynb → notebooks/synoptic/Upperair_Obs.ipynb b/notebooks/gallery/Upperair_Obs.ipynb → notebooks/synoptic/Upperair_Obs.ipynb
diff --git a/.../gallery/Wind_Shear_Vectors_Example.ipynb → ...synoptic/Wind_Shear_Vectors_Example.ipynb b/.../gallery/Wind_Shear_Vectors_Example.ipynb → ...synoptic/Wind_Shear_Vectors_Example.ipynb
diff --git a/notebooks/synoptic/index.md b/notebooks/synoptic/index.md
@@ -0,0 +1,3 @@
+# Synoptic Analysis
+
+This section covers how to perform a variety of analyses traditionally used in synoptic meteorolgy, ranging from basic plots on isobaric surfaces to Q-vectors and frontogenesis.
diff --git a/notebooks/gallery/xarray_500hPa_map.ipynb → notebooks/synoptic/xarray_500hPa_map.ipynb b/notebooks/gallery/xarray_500hPa_map.ipynb → notebooks/synoptic/xarray_500hPa_map.ipynb
diff --git a/pythia.png b/pythia.png
diff --git a/unidata.png b/unidata.png
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1,3 @@
		# Convective Calculations

		This section covers how to perform a variety of calculations around analyzing convection and severe weather.
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1,3 @@
		# Specialty Plotting

		This section shows how to accomplish some specialty plotting, such as cross-sections and smoothing, using MetPy.
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1,3 @@
		# Synoptic Analysis

		This section covers how to perform a variety of analyses traditionally used in synoptic meteorolgy, ranging from basic plots on isobaric surfaces to Q-vectors and frontogenesis.