Merge PR #287 (Fix dictionary key error for non-parallel plotting)

This merge brings PR # (Fix dictionary key error when benchmark plots are generated sequentially, by @yantosca) into the GCPy 1.4.2 development stream. This fixes an error where a dictionary was not being properly appended into a list in the benchmark plotting code, when parallel plotting was disabled. Signed-off-by: Bob Yantosca <[email protected]>
geoschem · Jan 26, 2024 · a8c8b7d · a8c8b7d
2 parents 1fb87e4 + 7a2c321
commit a8c8b7d
Show file tree

Hide file tree

Showing 6 changed files with 35 additions and 15 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -9,6 +9,9 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 - Example script `create_test_plot.py`, which can be used to check that GCPy has been installed properly
 - GitHub action `build-gcpy-environment` which tests installation of the mamba environment specified in in `docs/source/environment.yml`
 
+### Fixed
+- Prevent overwriting of the `results` variable when parallel plotting is deactivated (`n_cores: 1`)
+
 ## [1.4.1] - 2023-12-08
 ### Fixed
 - Now use the proper default value for the `--weightsdir` argument to `gcpy/file_regrid.py`

diff --git a/gcpy/benchmark/modules/run_1yr_fullchem_benchmark.py b/gcpy/benchmark/modules/run_1yr_fullchem_benchmark.py
@@ -694,8 +694,9 @@ def gcc_vs_gcc_mass_table(mon):
                     for mon in range(bmk_n_months)
                 )
             else:
+                results = []
                 for mon in range(bmk_n_months):
-                    results = gcc_vs_gcc_mass_table(mon)
+                    results.append(gcc_vs_gcc_mass_table(mon))
 
         # ==================================================================
         # GCC vs GCC operations budgets tables
@@ -741,8 +742,9 @@ def gcc_vs_gcc_ops_budg(mon):
                     for mon in range(bmk_n_months)
                 )
             else:
+                results = []
                 for mon in range(bmk_n_months):
-                    results = gcc_vs_gcc_ops_budg(mon)
+                    results.append(gcc_vs_gcc_ops_budg(mon))
 
         # ==================================================================
         # GCC vs GCC aerosols budgets/burdens tables
@@ -1255,8 +1257,9 @@ def gchp_vs_gcc_mass_table(mon):
                     for mon in range(bmk_n_months)
                 )
             else:
+                results = []
                 for mon in range(bmk_n_months):
-                    results = gchp_vs_gcc_mass_table(mon)
+                    results.append(gchp_vs_gcc_mass_table(mon))
 
         # ==================================================================
         # GCHP vs GCC operations budgets tables
@@ -1311,8 +1314,9 @@ def gchp_vs_gcc_ops_budg(mon):
                     for mon in range(bmk_n_months)
                 )
             else:
+                results = []
                 for mon in range(bmk_n_months):
-                    results = gchp_vs_gcc_ops_budg(mon)
+                    results.append(gchp_vs_gcc_ops_budg(mon))
 
         # ==================================================================
         # GCHP vs GCC aerosol budgets and burdens tables
@@ -1863,8 +1867,9 @@ def gchp_vs_gchp_mass_table(mon):
                     for mon in range(bmk_n_months)
                 )
             else:
+                results = []
                 for mon in range(bmk_n_months):
-                    results = gchp_vs_gchp_mass_table(mon)
+                    results.append(gchp_vs_gchp_mass_table(mon))
 
         # ==================================================================
         # GCHP vs GCHP operations budgets tables
@@ -1921,8 +1926,9 @@ def gchp_vs_gchp_ops_budg(mon):
                     for mon in range(bmk_n_months)
                 )
             else:
+                results = []
                 for mon in range(bmk_n_months):
-                    results = gchp_vs_gchp_ops_budg(mon)
+                    results.append(gchp_vs_gchp_ops_budg(mon))
 
         # ==================================================================
         # GCHP vs GCHP aerosol budgets and burdens tables

diff --git a/gcpy/benchmark/modules/run_1yr_tt_benchmark.py b/gcpy/benchmark/modules/run_1yr_tt_benchmark.py
@@ -540,8 +540,9 @@ def gcc_vs_gcc_mass_table(mon):
                     for mon in range(bmk_n_months)
                 )
             else:
+                results = []
                 for mon in range(bmk_n_months):
-                    results = gcc_vs_gcc_mass_table(mon)
+                    results.append(gcc_vs_gcc_mass_table(mon))
 
         # ==================================================================
         # GCC vs GCC operations budgets tables
@@ -837,8 +838,9 @@ def gchp_vs_gcc_mass_table(mon):
                     for mon in range(bmk_n_months)
                 )
             else:
+                results = []
                 for mon in range(bmk_n_months):
-                    results = gchp_vs_gcc_mass_table(mon)
+                    results.append(gchp_vs_gcc_mass_table(mon))
 
         # ==================================================================
         # GCHP vs GCC operations budgets tables
@@ -1149,8 +1151,9 @@ def gchp_vs_gchp_mass_table(mon):
                     for mon in range(bmk_n_months)
                 )
             else:
+                results = []
                 for mon in range(bmk_n_months):
-                    results = gchp_vs_gchp_mass_table(mon)
+                    results.append(gchp_vs_gchp_mass_table(mon))
 
         # ==================================================================
         # GCHP vs GCHP operations budgets tables

diff --git a/gcpy/benchmark_funcs.py b/gcpy/benchmark_funcs.py
@@ -1503,17 +1503,21 @@ def createplots(filecat):
             for _, filecat in enumerate(catdict)
         )
     else:
+        results = []
         for _, filecat in enumerate(catdict):
-            results = createplots(filecat)
+            results.append(createplots(filecat))
     # --------------------------------------------
-
+    
     dict_sfc = {list(result.keys())[0]: result[list(
         result.keys())[0]]['sfc'] for result in results}
     dict_500 = {list(result.keys())[0]: result[list(
         result.keys())[0]]['500'] for result in results}
     dict_zm = {list(result.keys())[0]: result[list(
         result.keys())[0]]['zm'] for result in results}
 
+    print("stop here")
+    quit()
+
     # ==============================================================
     # Write the list of species having significant differences,
     # which we need to fill out the benchmark approval forms.
@@ -1868,8 +1872,9 @@ def createfile_hco_cat(c):
                 for c in emis_cats
             )
         else:
+            results = []
             for c in emis_cats:
-                results = createfile_hco_cat(c)
+                results.append(createfile_hco_cat(c))
         # ---------------------------------------
 
         dict_emis = {list(result.keys())[0]: result[list(result.keys())[0]]
@@ -1981,8 +1986,9 @@ def createfile_bench_cat(filecat):
                 for _, filecat in enumerate(catdict)
             )
         else:
+            results = []
             for _, filecat in enumerate(catdict):
-                results = createfile_bench_cat(filecat)
+                results.append(createfile_bench_cat(filecat))
         #------------------------------------------------
 
         allcatspc = [spc for result in results for spc in result]

diff --git a/gcpy/plot/compare_single_level.py b/gcpy/plot/compare_single_level.py
@@ -1152,8 +1152,9 @@ def get_extent_for_colors(dset, minlon, maxlon, minlat, maxlat):
                     for i in range(n_var)
                 )
             else:
+                results = []
                 for i in range(n_var):
-                    results = createfig(i, temp_dir)
+                    results.append(createfig(i, temp_dir))
             # ---------------------------------------
 
             # update sig diffs after parallel calls

diff --git a/gcpy/plot/compare_zonal_mean.py b/gcpy/plot/compare_zonal_mean.py
@@ -1046,8 +1046,9 @@ def createfig(ivar, temp_dir=''):
                     for i in range(n_var)
                 )
             else:
+                results = []
                 for i in range(n_var):
-                    results = createfig(i, temp_dir)
+                    results.append(createfig(i, temp_dir))
             # ---------------------------------------
 
             # update sig diffs after parallel calls