utili-fy additional calls relevant to NREL#365

Author: softwareengineerprogrammer

src/geophires_monte_carlo/MC_GeoPHIRES3.py

@@ -29,6 +29,7 @@
 from geophires_monte_carlo.common import _get_logger
 from geophires_x.GeoPHIRESUtils import InsertImagesIntoHTML
 from geophires_x.GeoPHIRESUtils import render_default
+from geophires_x.MatplotlibUtils import plt_subplot
 from geophires_x_client import GeophiresInputParameters
 from geophires_x_client import GeophiresXClient
 from geophires_x_client import GeophiresXResult
@@ -519,7 +520,7 @@ def main(command_line_args=None):
         for i in range(len(inputs)):
             input = inputs[i][0]
             plt.figure(figsize=(8, 6))
-            ax = plt.subplot()
+            ax = plt_subplot()
             ax.set_title(input)
             ax.set_xlabel('Random Values')
             ax.set_ylabel('Probability')
@@ -553,7 +554,7 @@ def main(command_line_args=None):
                 annotations += display
 
             plt.figure(figsize=(8, 6))
-            ax = plt.subplot()
+            ax = plt_subplot()
             ax.set_title(output)
             ax.set_xlabel('Output units')
             ax.set_ylabel('Probability')

src/geophires_x/GeoPHIRESUtils.py

@@ -1,7 +1,6 @@
 from __future__ import annotations
 
 import logging
-import os
 import sys
 from enum import Enum
 from os.path import exists
@@ -15,7 +14,6 @@
 from pint.facets.plain import PlainQuantity
 from scipy.interpolate import interp1d
 import numpy as np
-import matplotlib.pyplot as plt
 
 import CoolProp.CoolProp as CP
 
@@ -622,21 +620,3 @@ def static_pressure_MPa(rho_kg_per_m3: float, depth_m: float) -> float:
     pressure_mpa = quantity(pressure_Pa, 'Pa').to('MPa').magnitude
 
     return pressure_mpa
-
-
-def show_plot(**kw_args):
-    """
-    Workaround for intermittent Windows GitHub Actions failures - see https://github.com/NREL/GEOPHIRES-X/issues/365
-    """
-    try:
-        plt.show(**kw_args)
-    except Exception as e:
-        # Can't import TclError directly since Python is not configured for Tk on all systems
-        is_tcl_error = e.__class__.__name__ == 'TclError'
-
-        is_windows_on_github_actions = os.name == 'nt' and 'TOXPYTHON' in os.environ
-        if is_tcl_error and is_windows_on_github_actions:
-            _logger.warning(f'Ignoring TclError when attempting to show plot '
-                            f'since we appear to be running on Windows in GitHub Actions ({str(e)})')
-        else:
-            raise e

src/geophires_x/MatplotlibUtils.py

@@ -0,0 +1,45 @@
+"""
+Workarounds for intermittent Windows GitHub Actions failures - see https://github.com/NREL/GEOPHIRES-X/issues/365
+"""
+
+from __future__ import annotations
+
+import logging
+import os
+from typing import Any
+
+from matplotlib import pyplot as plt
+
+_logger = logging.getLogger(__name__)
+
+
+def plt_show(**kw_args):
+    try:
+        plt.show(**kw_args)
+    except Exception as e:
+        _handle_tcl_error_on_windows_github_actions(e)
+
+
+def plt_subplot() -> Any:
+    try:
+        return plt.subplot()
+    except Exception as e:
+        _handle_tcl_error_on_windows_github_actions(e)
+
+
+def plt_subplots(**kw_args) -> Any:
+    try:
+        return plt.subplots(**kw_args)
+    except Exception as e:
+        _handle_tcl_error_on_windows_github_actions(e)
+
+
+def _handle_tcl_error_on_windows_github_actions(e) -> None:
+    # Can't import TclError directly since Python is not configured for Tk on all systems
+    is_tcl_error = e.__class__.__name__ == 'TclError'
+
+    if os.name == 'nt' and 'TOXPYTHON' in os.environ:
+        _logger.warning(f'Ignoring TclError when attempting to show plot '
+                        f'since we appear to be running on Windows in GitHub Actions ({str(e)})')
+    else:
+        raise e

src/geophires_x/OutputsRich.py

@@ -17,6 +17,7 @@
 from geophires_x.Economics import Economics
 
 from geophires_x.GeoPHIRESUtils import UpgradeSymbologyOfUnits, render_default, InsertImagesIntoHTML
+from geophires_x.MatplotlibUtils import plt_subplots
 from geophires_x.OptionList import EndUseOptions, PlantType, EconomicModel, ReservoirModel, FractureShape, \
     ReservoirVolume
 
@@ -1258,7 +1259,7 @@ def Plot_Twin_Graph(title: str, html_path: str, x: pd.array, y1: pd.array, y2: p
     COLOR_TEMPERATURE = "#69b3a2"
     COLOR_PRICE = "#3399e6"
 
-    fig, ax1 = plt.subplots(figsize=(40, 4))
+    fig, ax1 = plt_subplots(figsize=(40, 4))
 
     ax1.plot(x, y1, label=UpgradeSymbologyOfUnits(y1_label), color=COLOR_PRICE, lw=3)
     ax1.set_xlabel(UpgradeSymbologyOfUnits(x_label), color = COLOR_PRICE, fontsize=14)
@@ -1305,7 +1306,7 @@ def Plot_Single_Graph(title: str, html_path: str, x: pd.array, y: pd.array, x_la
     COLOR_PRICE = "#3399e6"
 
 #    plt.plot(x, y, color=COLOR_PRICE)
-    fig, ax = plt.subplots(figsize=(40, 4))
+    fig, ax = plt_subplots(figsize=(40, 4))
     ax.plot(x, y, label=UpgradeSymbologyOfUnits(y_label), color=COLOR_PRICE)
     ax.set_xlabel(UpgradeSymbologyOfUnits(x_label), color = COLOR_PRICE, fontsize=14)
     ax.set_ylabel(UpgradeSymbologyOfUnits(y_label), color=COLOR_PRICE, fontsize=14)

src/geophires_x/SUTRAReservoir.py

@@ -1,6 +1,6 @@
 import sys
 
-from .GeoPHIRESUtils import show_plot
+from .MatplotlibUtils import plt_show
 from .Parameter import strParameter, OutputParameter
 from .Units import *
 import geophires_x.Model as Model
@@ -220,7 +220,7 @@ def Calculate(self, model: Model):
         #plt.ylim([0, max(model.surfaceplant.daily_heating_demand.value) * 1.05])
         plt.legend()
         plt.title('SUTRA Heat Balance')
-        show_plot(block=False)
+        plt_show(block=False)
 
         plt.figure(2)
         plt.plot(self.TimeProfile.value[0:-1:2], self.TargetHeat.value[0:-1:2], label='Target Heat')
@@ -230,7 +230,7 @@ def Calculate(self, model: Model):
         #plt.ylim([0, max(model.surfaceplant.daily_heating_demand.value) * 1.05])
         plt.legend()
         plt.title('SUTRA Target and Simulated Heat')
-        show_plot(block=False)
+        plt_show(block=False)
 
         plt.figure(3)
         plt.plot(self.TimeProfile.value[0:-1:2], self.StorageWellFlowRate.value[0:-1:2], label='Storage Well Flow Rate')
@@ -240,7 +240,7 @@ def Calculate(self, model: Model):
         #plt.ylim([0, max(model.surfaceplant.daily_heating_demand.value) * 1.05])
         plt.legend()
         plt.title('SUTRA Well Flow Rates')
-        show_plot(block=False)
+        plt_show(block=False)
 
         plt.figure(4)
         plt.plot(self.TimeProfile.value[0:-1:2], self.StorageWellTemperature.value[0:-1:2], label='Storage Well Temperature')
@@ -250,6 +250,6 @@ def Calculate(self, model: Model):
         # plt.ylim([0, max(model.surfaceplant.daily_heating_demand.value) * 1.05])
         plt.legend()
         plt.title('SUTRA Well Temperatures')
-        show_plot(block=False)
+        plt_show(block=False)
 
         model.logger.info("Complete " + str(__class__) + ": " + sys._getframe().f_code.co_name)