Update global time series plotting (#301)

Author: forsyth2

docs/source/dev_guide/index.rst

@@ -10,4 +10,5 @@ Developer Guide
    release
    testing_e3sm_unified
    new_diags_set
+   new_glb_plot
    new_task

docs/source/dev_guide/new_glb_plot.rst

@@ -0,0 +1,11 @@
+***************************************
+Adding a new plot to Global Time Series
+***************************************
+
+This guide gives a general list of things to consider when adding a new
+Global Time Series plot. The exact code changes required will differ amongst plots.
+
+- Add the code for your new plot under "Plotting functions" in `coupled_global.py <https://github.com/E3SM-Project/zppy/blob/main/zppy/templates/coupled_global.py>`_. The name of your function should start with ``plot_``.
+- In ``PLOT_DICT``, add ``"function name without plot_" : function name``.
+- If this plot should be added to the defaults, complete this step: for ``plot_names`` under ``[global_time_series]`` in `default.ini <https://github.com/E3SM-Project/zppy/blob/main/zppy/templates/default.ini>`_, add the function name without plot to the string.
+- Run the `integration tests <https://e3sm-project.github.io/zppy/_build/html/main/dev_guide/testing.html#integration-tests>`_ and examine the differences from the expected files. If they match what you expect, update the expected files following "Commands to run to replace outdated expected files" on the machine-specific directions.

zppy/templates/coupled_global.py

@@ -5,6 +5,7 @@
 from typing import Any, List, Tuple
 
 import matplotlib as mpl
+import matplotlib.backends.backend_pdf
 import matplotlib.pyplot as plt
 import numpy as np
 from netCDF4 import Dataset
@@ -529,22 +530,34 @@ def run(parameters):
 
     xlim = [float(year1), float(year2)]
 
-    fig = plt.figure(figsize=[13.5, 16.5])
     num_plots = len(plot_list)
-    nrows = math.ceil(num_plots / 2)
+    nrows = 4
     ncols = 2
-
-    for i in range(num_plots):
-        ax = plt.subplot(nrows, ncols, i + 1)
-        try:
-            PLOT_DICT[plot_list[i]](ax, xlim, exps)
-        except KeyError:
-            raise KeyError(f"Invalid plot name: {plot_list[i]}")
-
-    fig.tight_layout()
-    fig.savefig(figstr + ".pdf")
-    fig.savefig(figstr + ".png", dpi=150)
-    plt.clf()
+    plots_per_page = nrows * ncols
+    num_pages = math.ceil(num_plots / plots_per_page)
+
+    i = 0
+    # https://stackoverflow.com/questions/58738992/save-multiple-figures-with-subplots-into-a-pdf-with-multiple-pages
+    pdf = matplotlib.backends.backend_pdf.PdfPages(f"{figstr}.pdf")
+    for page in range(num_pages):
+        fig = plt.figure(1, figsize=[13.5, 16.5])
+        for j in range(plots_per_page):
+            if i < num_plots:
+                ax = plt.subplot(nrows, ncols, j + 1)
+                try:
+                    PLOT_DICT[plot_list[i]](ax, xlim, exps)
+                except KeyError:
+                    raise KeyError(f"Invalid plot name: {plot_list[i]}")
+                i += 1
+
+        fig.tight_layout()
+        pdf.savefig(1)
+        if num_pages > 1:
+            fig.savefig(figstr + f"_{page}.png", dpi=150)
+        else:
+            fig.savefig(figstr + ".png", dpi=150)
+        plt.clf()
+    pdf.close()
 
 
 if __name__ == "__main__":

zppy/templates/global_time_series.bash

@@ -100,7 +100,7 @@ results_dir={{ prefix }}_results
 results_dir_absolute_path={{ scriptDir }}/${results_dir}
 mkdir -p ${results_dir_absolute_path}
 cp ${figstr}.pdf ${results_dir_absolute_path}/${figstr}.pdf
-cp ${figstr}.png ${results_dir_absolute_path}/${figstr}.png
+cp *.png ${results_dir_absolute_path}
 
 ################################################################################
 # Copy output to web server