Workaround for NREL#365 with show_plot utility method

Author: softwareengineerprogrammer

src/geophires_x/GeoPHIRESUtils.py

@@ -1,19 +1,22 @@
 from __future__ import annotations
 
 import logging
+import os
 import sys
 from enum import Enum
 from os.path import exists
 import dataclasses
 import json
 import numbers
 from functools import lru_cache
+from tkinter import TclError
 from typing import Optional, Any
 
 import scipy
 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
 
@@ -621,3 +624,20 @@ def static_pressure_MPa(rho_kg_per_m3: float, depth_m: float) -> float:
 
     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/SBTReservoir.py

@@ -150,7 +150,7 @@ def generate_wireframe_model(lateral_endpoint_depth: float, number_of_laterals:
 
         az, el = 71.5676, 10.4739
         ax.view_init(az, el)
-        plt.show()
+        show_plot(block=False)
 
     return xinj, yinj, zinj, xprod, yprod, zprod, xlat, ylat, zlat
 

src/geophires_x/SUTRAReservoir.py

@@ -1,4 +1,6 @@
 import sys
+
+from .GeoPHIRESUtils import show_plot
 from .Parameter import strParameter, OutputParameter
 from .Units import *
 import geophires_x.Model as Model
@@ -218,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')
-        plt.show(block=False)
+        show_plot(block=False)
 
         plt.figure(2)
         plt.plot(self.TimeProfile.value[0:-1:2], self.TargetHeat.value[0:-1:2], label='Target Heat')
@@ -228,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')
-        plt.show(block=False)
+        show_plot(block=False)
 
         plt.figure(3)
         plt.plot(self.TimeProfile.value[0:-1:2], self.StorageWellFlowRate.value[0:-1:2], label='Storage Well Flow Rate')
@@ -238,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')
-        plt.show(block=False)
+        show_plot(block=False)
 
         plt.figure(4)
         plt.plot(self.TimeProfile.value[0:-1:2], self.StorageWellTemperature.value[0:-1:2], label='Storage Well Temperature')
@@ -248,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')
-        plt.show(block=False)
+        show_plot(block=False)
 
         model.logger.info("Complete " + str(__class__) + ": " + sys._getframe().f_code.co_name)