Merge pull request #24 from softwareengineerprogrammer/geophires-input-parameters-enhancement

GeophiresInputParameters enhancement + FCR sensitivity test

Author: softwareengineerprogrammer

src/geophires_x_client/geophires_input_parameters.py

@@ -1,4 +1,5 @@
 import tempfile
+import uuid
 from enum import Enum
 from pathlib import Path
 from types import MappingProxyType
@@ -34,25 +35,33 @@ 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 params is not None:
             self._params = dict(params)
-            self._id = abs(hash(frozenset(self._params.items())))
+            self._file_path = Path(tempfile.gettempdir(), f'geophires-input-params_{uuid.uuid4()!s}.txt')
+
+            if from_file_path is not None:
+                with open(from_file_path, encoding='UTF-8') as base_file:
+                    with open(self._file_path, 'a', encoding='UTF-8') as f:
+                        f.writelines(base_file.readlines())
+        else:
+            self._file_path = from_file_path
+
+        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')
+            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()])
 
-            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)
+        self._id = hash(self._file_path)
 
     def as_file_path(self):
         return self._file_path
@@ -61,4 +70,5 @@ def get_output_file_path(self):
         return Path(tempfile.gettempdir(), f'geophires-result_{self._id}.out')
 
     def __hash__(self):
+        """TODO make hashes for equivalent parameters equal"""
         return self._id

tests/geophires_x_client_tests/__init__.py

@@ -0,0 +1,63 @@
+***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/client_test_input_1.txt

@@ -0,0 +1,60 @@
+***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/client_test_input_2.txt

@@ -0,0 +1,46 @@
+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('client_test_input_1.txt'))
+        input_2 = GeophiresInputParameters(from_file_path=self._get_test_file_path('client_test_input_2.txt'))
+        self.assertIsNot(input_1._id, input_2._id)
+
+    def test_init_with_input_file(self):
+        file_path = self._get_test_file_path('client_test_input_1.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_content = 'Foo, Bar\nBaz, Qux\n'
+        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(dummy_input_content)
+
+        input_params = GeophiresInputParameters(from_file_path=dummy_input_path, params={'Baz': 'Quux', 'Quuz': 2})
+
+        # New combined input file is created when params are provided
+        self.assertIsNot(dummy_input_path.absolute(), input_params.as_file_path().absolute())
+
+        with open(dummy_input_path, encoding='UTF-8') as f:
+            # Ensure original input file is not modified
+            self.assertEqual(dummy_input_content, f.read())
+
+        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())

tests/geophires_x_client_tests/test_geophires_input_parameters.py

@@ -54,9 +54,14 @@ def test_geophires_x_end_use_direct_use_heat(self):
             )
         )
 
-        assert result == result_same_input
+        del result.result['metadata']
+        del result_same_input.result['metadata']
+        self.assertDictEqual(result.result, result_same_input.result)
 
-        # TODO assert that result was retrieved from cache instead of recomputed (somehow)
+        # See TODO in geophires_x_client.geophires_input_parameters.GeophiresInputParameters.__hash__ - if/when hashes
+        # of equivalent sets of parameters are made equal, the commented assertion below will test that caching is
+        # working as expected.
+        # assert result == result_same_input
 
     def test_geophires_x_end_use_electricity(self):
         client = GeophiresXClient()
@@ -323,3 +328,20 @@ def test_input_unit_conversion(self):
         del result_kilometers_input.result['metadata']
 
         self.assertDictEqual(result_kilometers_input.result, result_meters_input.result)
+
+    def test_fcr_sensitivity(self):
+        def input_for_fcr(fcr: float) -> GeophiresInputParameters:
+            return GeophiresInputParameters(
+                from_file_path=self._get_test_file_path('examples/example1.txt'), params={'Fixed Charge Rate': fcr}
+            )
+
+        def get_fcr_lcoe(fcr: float) -> float:
+            return (
+                GeophiresXClient()
+                .get_geophires_result(input_for_fcr(fcr))
+                .result['SUMMARY OF RESULTS']['Electricity breakeven price']['value']
+            )
+
+        self.assertEqual(9.65, get_fcr_lcoe(0.05))
+        self.assertEqual(3.33, get_fcr_lcoe(0.0001))
+        self.assertEqual(104.74, get_fcr_lcoe(0.8))

tests/test_geophires_x.py

@@ -1,4 +1,5 @@
 import tempfile
+import unittest
 import uuid
 from pathlib import Path
 
@@ -388,6 +389,10 @@ def test_ccus_profile(self):
             ccus_profile,
         )
 
+    @unittest.skip(
+        'Not currently relevant - '
+        'see TODO in geophires_x_client.geophires_input_parameters.GeophiresInputParameters.__hash__'
+    )
     def test_input_hashing(self):
         input1 = GeophiresInputParameters(
             {'End-Use Option': EndUseOption.DIRECT_USE_HEAT.value, 'Gradient 1': 50, 'Maximum Temperature': 250}