Merge PR #398 (Generate AOD plots for DSTbin1..7 species)

This merge brings PR # (Generate AOD plots for DSTbin1..7 species,
by @yantosca) into the GCPy 1.7.0 development stream.

PR #398 does the following:

1. Restore column AOD plots for DSTbin1 .. DSTbin7 species, which had
   been previously excluded.

2. Prevents double counting of AODDust and the individual column AODs
   for DSTbin1..DSTbin7 species.

3. Updates the benchmark/modules/aod_species.yml file with metadata for
   DSTbin1..DSTbin7 species. Also added cosmetic changes (comments and
   indentation) for better readability.

Signed-off-by: Bob Yantosca <yantosca@seas.harvard.edu>

Author: yantosca

CHANGELOG.md

@@ -48,7 +48,9 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 - Updated routine `make_benchmark_aerosol_tables` to include all dust species in the aerosol burdens table
 - Optimized function `get_diff_of_diffs` (in `gcpy/util.py`) for performance
 - Optimized function `add_lumped_species_to_dataset` (in `gcpy/benchmark/modules/benchmark_utils.py`) for performance
-- Optimized the algorithm to generate `varlist` in `make_benchmark_conc_plots`.  Also truncated datasets to only contain varibales in `varlist`.
+- Optimized the algorithm to generate `varlist` in `make_benchmark_conc_plots`.  Also truncated datasets to only contain variables in `varlist`.
+- Updated `make_benchmark_aod_plots` to include column AOD plots for DSTbin1..DSTbin7 species
+- Updated `benchmark/modules/aod_species.py` with metadata for DSTbin1..DSTbin7 species
 
 ### Fixed
 - Fixed grid area calculation scripts of `grid_area` in `gcpy/gcpy/cstools.py`

gcpy/benchmark/modules/aod_species.yml

@@ -1,10 +1,20 @@
-AODDust: Column_AOD_Dust
-AODHyg550nm_BCPI: Column_AOD_BCPI
-AODHyg550nm_OCPI: Column_AOD_OCPI
-AODHyg550nm_SALA: Column_AOD_SALA
-AODHyg550nm_SALC: Column_AOD_SALC
-AODHyg550nm_SO4: Column_AOD_SO4
-AODPolarStratCloud550nm: Column_AOD_Polar_Strat_Cloud
-AODSOAfromAqIsoprene550nm: Column_AOD_SOA_from_Aqueous_ISOP
-AODStratLiquidAer550nm: Column_AOD_Strat_Liquid_Aerosol
-AODTotal: Column_AOD_Total
+#
+# Diagnostic field         Top-of-page title for column AOD plots
+#
+AODDust:                   "Column AOD Dust, Total"
+AODDust550nm_bin1:         "Column AOD DSTbin1"
+AODDust550nm_bin2:         "Column AOD DSTbin2"
+AODDust550nm_bin3:         "Column AOD DSTbin3"
+AODDust550nm_bin4:         "Column AOD DSTbin4"
+AODDust550nm_bin5:         "Column AOD DSTbin5"
+AODDust550nm_bin6:         "Column AOD DSTbin6"
+AODDust550nm_bin7:         "Column AOD DSTbin7"
+AODHyg550nm_BCPI:          "Column AOD BCPI"
+AODHyg550nm_OCPI:          "Column AOD OCPI"
+AODHyg550nm_SALA:          "Column AOD SALA"
+AODHyg550nm_SALC:          "Column AOD SALC"
+AODHyg550nm_SO4:           "Column AOD SO4"
+AODPolarStratCloud550nm:   "Column AOD Polar Strat Cloud"
+AODSOAfromAqIsoprene550nm: "Column AOD SOA from Aqueous ISOP"
+AODStratLiquidAer550nm:    "Column AOD Strat Liquid Aerosol"
+AODTotal:                  "Column AOD Total"

gcpy/benchmark/modules/benchmark_funcs.py

@@ -3360,7 +3360,7 @@ def make_benchmark_aod_plots(
     if varlist is None:
         vardict = compare_varnames(refds, devds, quiet=not verbose)
         cmn3D = vardict["commonvars3D"]
-        varlist = [v for v in cmn3D if "AOD" in v and "_bin" not in v]
+        varlist = [v for v in cmn3D if "AOD" in v]
 
     # Dictionary and list for new display names
     newvars = read_config_file(
@@ -3405,13 +3405,16 @@ def make_benchmark_aod_plots(
     devattrs = devtot.attrs
 
     # Compute the sum of all AOD variables
-    # Avoid double-counting SOA from aqueous isoprene, which is
-    # already accounted for in AODHyg550nm_OCPI.  Also see
-    # Github issue: https://github.com/geoschem/gcpy/issues/65
+    # Avoid double-counting the following:
+    # (1) Individual dust AODs, use the column AOD total instead
+    # (2) SOA from aqueous isoprene, which is already accounted
+    #     for in AODHyg550nm_OCPI.  Also see Github issue:
+    #     https://github.com/geoschem/gcpy/issues/65
     for v in varlist:
-        if "AODSOAfromAqIsoprene550nm" not in v:
-            reftot = reftot + refds[v]
-            devtot = devtot + devds[v]
+        if "_bin" in v or "AODSOAfromAqIsoprene550nm" in v:
+            continue
+        reftot = reftot + refds[v]
+        devtot = devtot + devds[v]
 
     # Reattach the variable attributes
     reftot.name = "AODTotal"