ENH: Add documentation for galvez_davison_index

docs/_templates/overrides/metpy.calc.rst

@@ -76,6 +76,7 @@ Soundings
       critical_angle
       cross_totals
       el
+      galvez_davison_index
       k_index
       lcl
       lfc

docs/api/references.rst

@@ -76,6 +76,10 @@ References
            Services and Supporting Research, 2003.
            `FCM-R19-2003 <../_static/FCM-R19-2003-WindchillReport.pdf>`_, 75 pp.
 
+.. [Galvez2015] Galvez, J. M. and Michel Davison, 2015. “The Gálvez-Davison Index for Tropical 
+            Convection.” `GDI_Manuscript_V20161021 
+            <https://www.wpc.ncep.noaa.gov/international/gdi/GDI_Manuscript_V20161021.pdf>`_.
+
 .. [Galway1956] Galway, J. G., 1956: The Lifted Index as a Predictor of Latent Instability.
            *American Meteorology Society*,
            doi:`10.1175/1520-0477-37.10.528

examples/calculations/Sounding_Calculations.py

@@ -96,6 +96,7 @@ def effective_layer(p, t, td, h, height_layer=False):
 # Compute common sounding index parameters
 ctotals = mpcalc.cross_totals(p, T, Td)
 kindex = mpcalc.k_index(p, T, Td)
+gdi = mpcalc.galvez_davison_index(p, T, Td)
 showalter = mpcalc.showalter_index(p, T, Td)
 total_totals = mpcalc.total_totals_index(p, T, Td)
 vert_totals = mpcalc.vertical_totals(p, T)

src/metpy/calc/thermo.py

@@ -4339,7 +4339,11 @@ def galvez_davison_index(pressure, temperature, dewpoint, vertical_dim=0):
     """
     Calculate GDI from the pressure temperature and dewpoint.
 
-    GDI formula derived from [Galvez2015](https://www.wpc.ncep.noaa.gov/international/gdi/GDI_Manuscript_V20150910.pdf)_:
+    Calculation of the GDI relies on temperatures and mixing ratios at 950,
+    850, 700, and 500 hPa. These four levels define three layers: A) Boundary,
+    B) Trade Wind Inversion (TWI), C) Mid-Troposphere.
+
+    GDI formula derived from [Galvez2015]_:
 
     .. math:: GDI = CBI + MWI + II + TC
 
@@ -4350,20 +4354,24 @@ def galvez_davison_index(pressure, temperature, dewpoint, vertical_dim=0):
     * :math:`II` is the Inversion Index
     * :math:`TC` is the Terrain Correction [optional]
 
-    Calculation of the GDI relies on temperatures and mixing ratios at 950,
-     850, 700, and 500 hPa. These four levels define three layers: A) Boundary,
-     B) Trade Wind Inversion (TWI), C) Mid-Troposphere.
-
-    ----------------------------------------------------------------------------------
-    GDI Value   | Expected Convective Regime
-    ----------------------------------------------------------------------------------
-    >=45        | Scattered to widespread thunderstorms likely.
-    35 to 45    | Scattered thunderstorms and/or scattered to widespread rain showers.
-    25 to 35    | Isolated to scattered thunderstorms and/or scattered showers.
-    15 to 25    | Isolated thunderstorms and/or isolated to scattered showers.
-    5 to 10     | Isolated to scattered showers.
-    <5          | Strong TWI likely, light rain possible.
-    ----------------------------------------------------------------------------------
+    .. list-table:: GDI Values & Corresponding Convective Regimes
+        :widths: 15 75
+        :header-rows: 1
+
+        * - GDI Value
+          - Expected Convective Regime
+        * - >=45
+          - Scattered to widespread thunderstorms likely.
+        * - 35 to 45
+          - Scattered thunderstorms and/or scattered to widespread rain showers.
+        * - 25 to 35
+          - Isolated to scattered thunderstorms and/or scattered showers.
+        * - 15 to 25
+          - Isolated thunderstorms and/or isolated to scattered showers.
+        * - 5 to 10
+          - Isolated to scattered showers.
+        * - <5
+          - Strong TWI likely, light rain possible.
 
     Parameters
     ----------