Support combining input file and params object in GeophiresInputParameters

Author: softwareengineerprogrammer

src/geophires_x_client/geophires_input_parameters.py

@@ -34,25 +34,31 @@ class PowerPlantType(Enum):
 
 
 class GeophiresInputParameters:
+
     def __init__(self, params: Optional[MappingProxyType] = None, from_file_path: Optional[Path] = None):
-        assert (params is None) ^ (from_file_path is None), 'Only one of params or from_file_path may be provided'
+        """
+        Note that params will override any duplicate entries in from_file_path
+        """
+
+        assert (params is not None) or (from_file_path is not None), 'One of params or from_file_path must be provided'
+
+        if from_file_path is not None:
+            self._id = hash(from_file_path)
+            self._file_path = from_file_path
 
         if params is not None:
             self._params = dict(params)
+
+        if self._file_path is None:
             self._id = abs(hash(frozenset(self._params.items())))
+            self._file_path = Path(tempfile.gettempdir(), f'geophires-input-params_{self._id}.txt')
+
+        if params is not None:
             # TODO validate params - i.e. that all names are accepted by simulation, values don't exceed max allowed,
             #  etc.
 
-            tmp_file_path = Path(tempfile.gettempdir(), f'geophires-input-params_{self._id}.txt')
-            f = Path.open(tmp_file_path, 'w')
-
-            f.writelines([','.join([str(p) for p in param_item]) + '\n' for param_item in self._params.items()])
-            f.close()
-            self._file_path = tmp_file_path
-
-        if from_file_path is not None:
-            self._file_path = from_file_path
-            self._id = hash(from_file_path)
+            with open(self._file_path, 'a', encoding='UTF-8') as f:
+                f.writelines([', '.join([str(p) for p in param_item]) + '\n' for param_item in self._params.items()])
 
     def as_file_path(self):
         return self._file_path

tests/geophires_x_client_tests/__init__.py

@@ -0,0 +1,73 @@
+GEOPHIRES v2.0 Input File
+Created on 2018-06-11
+Last modified on 2024-02-28
+Geothermal Electricity Problem using a Multiple Parallel Fractures Model
+
+Example 1 Description: This problem considers an EGS reservoir at 3km depth.
+Ramey's model is applied to simulate production wellbore heat losses. The heat
+is used in for electricity application with a reinjection temperature of 50deg.C.
+
+
+***Subsurface technical parameters***
+*************************************
+Reservoir Model,1,                        			---Multiple Fractures reservoir model
+Reservoir Depth,3,                     				---[km]
+Number of Segments,1,                  				---[-]
+Gradient 1,50,                          			---[deg.C/km]
+Maximum Temperature,400,                  			---[deg.C]
+Number of Production Wells,2,            			---[-]
+Number of Injection Wells,2,            			---[-]
+Production Well Diameter,7,		     			---[inch]
+Injection Well Diameter,7,					---[inch]
+Ramey Production Wellbore Model,1,       			---0 if disabled  1 if enabled
+Production Wellbore Temperature Drop,.5,			---[deg.C]
+Injection Wellbore Temperature Gain,0,   			---[deg.C]
+Production Flow Rate per Well,55,       			---[kg/s]
+Fracture Shape,3,                       			---[-] Should be 1 2 3 or 4. See manual for details
+Fracture Height,900, 						---[m]
+Reservoir Volume Option,3,              			---[-] Should be 1 2 3 or 4. See manual for details
+Number of Fractures,20,		  				---[-]
+Reservoir Volume,1000000000,		 			---[m^3]
+Water Loss Fraction,.02,					---[-]
+Productivity Index,5,						---[kg/s/bar]
+Injectivity Index,5,						---[kg/s/bar]
+Injection Temperature,50,		 			---[deg.C]
+Maximum Drawdown,1,			  			---[-] no redrilling considered
+Reservoir Heat Capacity,1000,		  			---[J/kg/K]
+Reservoir Density,2700,			  			---[kg/m^3]
+Reservoir Thermal Conductivity,2.7,	  			---[W/m/K]
+
+***SURFACE TECHNICAL PARAMETERS***
+**********************************
+End-Use Option,1,			  			---[-] Electricity
+Power Plant Type,2,			  			---[-] Supercritical ORC
+Circulation Pump Efficiency,.8,	  				---[-] between .1 and 1
+Utilization Factor,.9,			  			---[-] between .1 and 1
+Surface Temperature,20,		  				---[deg.C]
+Ambient Temperature,20,		 				---[deg.C]
+
+***FINANCIAL PARAMETERS***
+**************************
+Plant Lifetime,30,			  			---[years]
+Economic Model,1,			  			---[-] Fixed Charge Rate Model
+Fixed Charge Rate,.05,			 			---[-] between 0 and 1
+Inflation Rate During Construction,0,   			---[-]
+
+***CAPITAL AND O&M COST PARAMETERS***
+*************************************
+Well Drilling and Completion Capital Cost Adjustment Factor,1,	---[-] Use built-in correlations
+Well Drilling Cost Correlation,1,				---[-] Use built-in correlations
+Reservoir Stimulation Capital Cost Adjustment Factor,1,		---[-] Use built-in correlations
+Surface Plant Capital Cost Adjustment Factor,1,			---[-] Use built-in correlations
+Field Gathering System Capital Cost Adjustment Factor,1,	---[-] Use built-in correlations
+Exploration Capital Cost Adjustment Factor,1,			---[-] Use built-in correlations
+Wellfield O&M Cost Adjustment Factor,1,				---[-] Use built-in correlations
+Surface Plant O&M Cost Adjustment Factor,1,			---[-] Use built-in correlations
+Water Cost Adjustment Factor,1,					---[-] Use built-in correlations
+
+
+***Simulation Parameters***
+***************************
+
+Print Output to Console,1,		  			---[-] Should be 0 (don't print results) or 1 (print results)
+Time steps per year,6,		  				---[1/year]

tests/geophires_x_client_tests/example1.txt

@@ -0,0 +1,69 @@
+GEOPHIRES v2.0 Input File
+Created on 2018-06-11
+Last modified on 2018-06-11
+Geothermal Direct-Use Example Problem using a Linear Heat Sweep Model.
+
+Example 2 Description: This problem considers an EGS reservoir at 3km depth.
+Ramey's model is applied to simulate production wellbore heat losses. The heat
+is used in direct-use heat application with reinjection temperature of 70deg.C
+
+***Subsurface Technical Parameters***
+*************************************
+
+Reservoir Model,2,						---Linear Heat Sweep Model
+Reservoir Depth,3,						---[km]
+Number of Segments,1,						---[-]
+Gradient 1,55,							---[deg.C/km]
+Number of Production Wells,2,					---[-]
+Number of Injection Wells,2,					---[-]
+Production Well Diameter,8,					---[inch]
+Injection Well Diameter,8,					---[inch]
+Ramey Production Wellbore Model,1,				---Should be 0 (disable) or 1(enable)
+Injection Wellbore Temperature Gain,0,				---[deg.C]
+Production Flow Rate per Well,30,				---[kg/s]
+Fracture Shape,2,						---Should be 1 2 3 or 4. See manual for option details
+Fracture Height,300,						---[m]
+Reservoir Volume Option,2,					---Should be 1 2 3 or 4. See manual for option details
+Fracture Separation,60,						---[m]
+Reservoir Impedance,0.2,					---[GPa*s/m3]
+Injection Temperature,70,					---[deg.C]
+Maximum Drawdown,.3,						---Should be between 0 and 1 depending on redrilling
+Reservoir Heat Capacity,975,					---[J/kg/K]
+Reservoir Density,3000,						---[kg/m3]
+Reservoir Thermal Conductivity,3.2,				---[W/m/K]
+Reservoir Porosity,.1,						---[-]
+
+***Surface Technical Parameters***
+**********************************
+End-Use Option,2,						---Direct Use Heat
+Circulation Pump Efficiency,.8,					---[-]
+Utilization Factor,.9,						---[-]
+End-Use Efficiency Factor,.9,					---[-]
+Surface Temperature,15,						---[deg.C]
+
+***Financial Parameters***
+**************************
+
+Plant Lifetime,25,						---[years]
+Economic Model,2,						---Standard Levelized Cost Model
+Discount Rate,.05,						---[-]
+Inflation Rate During Construction,0,				---[-]
+
+***Capital and O&M Cost Parameters***
+*************************************
+
+Well Drilling and Completion Capital Cost Adjustment Factor,1,	---[M$/well] Use built-in correlations
+Well Drilling Cost Correlation,1,				---[-]
+Reservoir Stimulation Capital Cost Adjustment Factor,1, 	---[-] Use built-in correlations
+Surface Plant Capital Cost Adjustment Factor,1,			---[-] Use built-in correlations
+Field Gathering System Capital Cost Adjustment Factor,1,	---[-] Use built-in correlations
+Exploration Capital Cost Adjustment Factor,1,			---[-] Use built-in correlations
+Wellfield O&M Cost Adjustment Factor,1,				---[-] Use built in correlations
+Surface Plant O&M Cost Adjustment Factor,1,			---[-] Use built-in correlations
+Water Cost Adjustment Factor,1,					---[-] Use built-in correlations
+Electricity Rate,.05,						---[$/kWh]
+
+***Simulation Parameters***
+***************************
+Print Output to Console,1,					---should be either 0 (do not show) or 1 (show)
+Time steps per year,3,						---[-]

tests/geophires_x_client_tests/example2.txt

@@ -0,0 +1,38 @@
+import tempfile
+import uuid
+from pathlib import Path
+
+from base_test_case import BaseTestCase
+from geophires_x_client import GeophiresInputParameters
+
+
+class GeophiresInputParametersTestCase(BaseTestCase):
+
+    def test_id(self):
+        input_1 = GeophiresInputParameters(from_file_path=self._get_test_file_path('example1.txt'))
+        input_2 = GeophiresInputParameters(from_file_path=self._get_test_file_path('example2.txt'))
+        self.assertIsNot(input_1._id, input_2._id)
+
+    def test_init_with_input_file(self):
+        file_path = self._get_test_file_path('example1.txt')
+        input_params = GeophiresInputParameters(from_file_path=file_path)
+        self.assertEqual(file_path, input_params.as_file_path())
+
+    def test_init_with_params(self):
+        dummy_input_path = Path(tempfile.gettempdir(), f'geophires-dummy-input-params_{uuid.uuid4()!s}.txt')
+        with open(dummy_input_path, 'w', encoding='UTF-8') as f:
+            f.write('Foo, Bar\nBaz, Qux\n')
+
+        input_from_file = GeophiresInputParameters(from_file_path=dummy_input_path)
+        input_from_params = GeophiresInputParameters(params={'Foo': 'Bar', 'Baz': 'Qux'})
+        self.assertFileContentsEqual(input_from_file.as_file_path(), input_from_params.as_file_path())
+
+    def test_init_with_input_file_and_parameters(self):
+        dummy_input_path = Path(tempfile.gettempdir(), f'geophires-dummy-input-params_{uuid.uuid4()!s}.txt')
+        with open(dummy_input_path, 'w', encoding='UTF-8') as f:
+            f.write('Foo, Bar\nBaz, Qux\n')
+
+        input_params = GeophiresInputParameters(from_file_path=dummy_input_path, params={'Baz': 'Quux', 'Quuz': 2})
+
+        with open(input_params.as_file_path(), encoding='UTF-8') as f:
+            self.assertEqual('Foo, Bar\nBaz, Qux\nBaz, Quux\nQuuz, 2\n', f.read())