Parameterize TOUGH2 executable path NREL#291

Author: softwareengineerprogrammer

src/geophires_x/TOUGH2Reservoir.py

@@ -1,17 +1,16 @@
 import sys
-import os
 import numpy as np
 from .Parameter import floatParameter, strParameter
 from .Units import *
 import geophires_x.Model as Model
-from .Reservoir import Reservoir
+from geophires_x.Reservoir import Reservoir
 
 
 class TOUGH2Reservoir(Reservoir):
     """
     This class models the TOUGH2 Reservoir.
     """
-    def __init__(self, model:Model):
+    def __init__(self, model: Model):
         """
         The __init__ function is called automatically when a class is instantiated.
         It initializes the attributes of an object, and sets default values for certain arguments that can be overridden
@@ -33,6 +32,11 @@ def __init__(self, model:Model):
         # or used for Output
         # This also includes all Parameters that are calculated and then published using the Printouts function.
         # specific to this stype of reservoir
+        self.tough2_executable_path = self.ParameterDict[self.tough2_executable_path.Name] = strParameter(
+            "TOUGH2 Executable Path",
+            DefaultValue='xt2_eos1.exe',
+            UnitType=Units.NONE,
+        )
         self.tough2modelfilename = self.ParameterDict[self.tough2modelfilename.Name] = strParameter(
             "TOUGH2 Model/File Name",
             value='Doublet',
@@ -126,7 +130,7 @@ def Calculate(self, model:Model):
 
         # GEOPHIRES assumes TOUGH2 executable and input file are in same directory as GEOPHIRESv3.py
         # create tough2 input file
-        path_to_exe = str('xt2_eos1.exe')
+        path_to_exe = str(self.tough2_executable_path.value)
         if not os.path.exists(os.path.join(os.getcwd(), path_to_exe)):
             model.logger.critical('TOUGH2 executable file does not exist in current working directory. \
             GEOPHIRES will abort simulation.')

tests/geophires_x_tests/test_tough2_reservoir.py

@@ -0,0 +1,63 @@
+from pathlib import Path
+
+from tests.base_test_case import BaseTestCase
+
+# Ruff disabled because imports are order-dependent
+# ruff: noqa: I001
+from geophires_x.Model import Model
+from geophires_x.Parameter import ParameterEntry
+
+
+# ruff: noqa: I001
+from geophires_x.TOUGH2Reservoir import TOUGH2Reservoir
+from geophires_x.OptionList import ReservoirModel
+from geophires_x_client import GeophiresInputParameters
+
+import sys
+import os
+
+
+class Tough2ReservoirTestCase(BaseTestCase):
+    def _new_model_with_tough2_reservoir(self, input_file=None) -> Model:
+        stash_cwd = Path.cwd()
+        stash_sys_argv = sys.argv
+
+        sys.argv = ['']
+
+        if input_file is not None:
+            sys.argv.append(input_file)
+
+        m = Model(enable_geophires_logging_config=False)
+        m.InputParameters['Reservoir Model'] = ParameterEntry(
+            Name='Reservoir Model', sValue=str(ReservoirModel.TOUGH2_SIMULATOR.int_value)
+        )
+        m.reserv = TOUGH2Reservoir(m)
+
+        if input_file is not None:
+            m.read_parameters()
+
+        sys.argv = stash_sys_argv
+        os.chdir(stash_cwd)
+
+        return m
+
+    def test_read_inputs(self):
+        base_params = GeophiresInputParameters(
+            from_file_path=self._get_test_file_path('../examples/example1.txt'),
+            params={
+                'Reservoir Model': ReservoirModel.TOUGH2_SIMULATOR.int_value,
+            },
+        )
+        model = self._new_model_with_tough2_reservoir(input_file=base_params.as_file_path())
+        self.assertEqual(model.reserv.tough2_executable_path.value, 'xt2_eos1.exe')
+
+        params_custom_exe = GeophiresInputParameters(
+            from_file_path=self._get_test_file_path('../examples/example1.txt'),
+            params={
+                'Reservoir Model': ReservoirModel.TOUGH2_SIMULATOR.int_value,
+                'TOUGH2 Executable Path': 'C:\\Users\\my-geophires-project\\tough3-eos1.exe',
+            },
+        )
+        model = self._new_model_with_tough2_reservoir(input_file=params_custom_exe.as_file_path())
+        reservoir: TOUGH2Reservoir = model.reserv
+        self.assertEqual(reservoir.tough2_executable_path.value, 'C:\\Users\\my-geophires-project\\tough3-eos1.exe')