diff --git a/.bumpversion.cfg b/.bumpversion.cfg index ec24fb64..a089d5a7 100644 --- a/.bumpversion.cfg +++ b/.bumpversion.cfg @@ -1,5 +1,5 @@ [bumpversion] -current_version = 3.4.28 +current_version = 3.4.29 commit = True tag = True diff --git a/.cookiecutterrc b/.cookiecutterrc index ca797df8..ac758797 100644 --- a/.cookiecutterrc +++ b/.cookiecutterrc @@ -54,7 +54,7 @@ default_context: sphinx_doctest: "no" sphinx_theme: "sphinx-py3doc-enhanced-theme" test_matrix_separate_coverage: "no" - version: 3.4.28 + version: 3.4.29 version_manager: "bump2version" website: "https://github.com/NREL" year_from: "2023" diff --git a/README.rst b/README.rst index d5df73b7..d11994a0 100644 --- a/README.rst +++ b/README.rst @@ -47,9 +47,9 @@ Free software: `MIT license `__ :alt: Supported implementations :target: https://pypi.org/project/geophires-x -.. |commits-since| image:: https://img.shields.io/github/commits-since/softwareengineerprogrammer/GEOPHIRES-X/v3.4.28.svg +.. |commits-since| image:: https://img.shields.io/github/commits-since/softwareengineerprogrammer/GEOPHIRES-X/v3.4.29.svg :alt: Commits since latest release - :target: https://github.com/softwareengineerprogrammer/GEOPHIRES-X/compare/v3.4.28...main + :target: https://github.com/softwareengineerprogrammer/GEOPHIRES-X/compare/v3.4.29...main .. |docs| image:: https://readthedocs.org/projects/GEOPHIRES-X/badge/?style=flat :target: https://nrel.github.io/GEOPHIRES-X @@ -65,7 +65,9 @@ Getting Started Web Interface ------------- -A web interface is available at `bit.ly/GEOPHIRES `__ +A web interface is available at `scientificwebservices.com/tools/geophires `__. + +The short URL `bit.ly/GEOPHIRES `__ redirects to the same location. Installation ------------ diff --git a/References/fervo_energy_white_paper.md b/References/fervo_energy_white_paper.md new file mode 100644 index 00000000..c4366d42 --- /dev/null +++ b/References/fervo_energy_white_paper.md @@ -0,0 +1 @@ +[fervo_energy_white_paper.pdf](https://github.com/NREL/GEOPHIRES-X/blob/703c967b0b1fe9f6d619b1e786686ba07fb0fe59/References/fervo_energy_white_paper.pdf) diff --git a/References/fervo_energy_white_paper.pdf b/References/fervo_energy_white_paper.pdf deleted file mode 100644 index 8f9f05fb..00000000 Binary files a/References/fervo_energy_white_paper.pdf and /dev/null differ diff --git a/docs/conf.py b/docs/conf.py index ec4b1748..379ddbba 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -18,7 +18,7 @@ year = '2023' author = 'NREL' copyright = f'{year}, {author}' -version = release = '3.4.28' +version = release = '3.4.29' pygments_style = 'trac' templates_path = ['./templates'] diff --git a/docs/reference/geophires_x.rst b/docs/reference/geophires_x.rst index b92022d6..116e30aa 100644 --- a/docs/reference/geophires_x.rst +++ b/docs/reference/geophires_x.rst @@ -11,6 +11,15 @@ geophires_x .. automodule:: geophires_x.TDPReservoir :members: +.. automodule:: geophires_x.LHSReservoir + :members: + +.. automodule:: geophires_x.MPFReservoir + :members: + +.. automodule:: geophires_x.SFReservoir + :members: + .. automodule:: geophires_x.CylindricalReservoir :members: diff --git a/setup.py b/setup.py index b3799ee3..49f79347 100755 --- a/setup.py +++ b/setup.py @@ -13,7 +13,7 @@ def read(*names, **kwargs): setup( name='geophires-x', - version='3.4.28', + version='3.4.29', license='MIT', description='GEOPHIRES is a free and open-source geothermal techno-economic simulator.', long_description='{}\n{}'.format( diff --git a/src/geophires_x/AGSOutputs.py b/src/geophires_x/AGSOutputs.py index 87edbd7a..6c4836a3 100644 --- a/src/geophires_x/AGSOutputs.py +++ b/src/geophires_x/AGSOutputs.py @@ -83,7 +83,6 @@ def PrintOutputs(self, model: Model): f.write("Simulation Metadata\n") f.write("----------------------\n") f.write(f' GEOPHIRES Version: {geophires_x.__version__}\n') - f.write(" GEOPHIRES Build Date: 2022-06-30\n") f.write(" Simulation Date: " + datetime.datetime.now().strftime("%Y-%m-%d\n")) f.write(" Simulation Time: " + datetime.datetime.now().strftime("%H:%M\n")) f.write(" Calculation Time: " + "{0:10.3f}".format((time.time() - model.tic)) + " sec\n") diff --git a/src/geophires_x/AGSWellBores.py b/src/geophires_x/AGSWellBores.py index a179e4c5..9d4d9552 100644 --- a/src/geophires_x/AGSWellBores.py +++ b/src/geophires_x/AGSWellBores.py @@ -578,21 +578,21 @@ def read_parameters(self, model: Model) -> None: # handle error checking and special cases: if model.reserv.numseg.value > 1: - msg = "Warning: CLGS model can only handle a single layer gradient segment. Number of Segments set to 1, \ - Gradient set to Gradient[0], and Depth set to Reservoir Depth." + msg = ('Warning: CLGS model can only handle a single layer gradient segment. ' + 'Number of Segments set to 1, Gradient set to Gradient[0], and Depth set to Reservoir Depth.') print(msg) model.logger.warning(msg) model.reserv.numseg.value = 1 if self.ninj.value > 0: - msg = "Warning: CLGS model considers the only the production wellbore parameters. Anything related to the \ - injection wellbore is ignored." + msg = ('Warning: CLGS model considers the only the production wellbore parameters. ' + 'Anything related to the injection wellbore is ignored.') print(msg) model.logger.warning(msg) if self.nprod.value != 1: - msg = "Warning: CLGS model considers the only a single production wellbore (coaxial or uloop). \ - Number of production wellboreset set 1." + msg = ('Warning: CLGS model considers the only a single production wellbore (coaxial or uloop). ' + 'Number of production wellboreset set 1.') print(msg) model.logger.warning(msg) diff --git a/src/geophires_x/Outputs.py b/src/geophires_x/Outputs.py index cc582d7c..7fbb6074 100644 --- a/src/geophires_x/Outputs.py +++ b/src/geophires_x/Outputs.py @@ -778,7 +778,6 @@ def PrintOutputs(self, model: Model): pumping_power_results = [] simulation_metadata.append(OutputTableItem('GEOPHIRES Version', geophires_x.__version__)) - simulation_metadata.append(OutputTableItem('GEOPHIRES Build Date', '2024-03-05')) simulation_metadata.append(OutputTableItem('Simulation Date', datetime.datetime.now().strftime('%Y-%m-%d'))) simulation_metadata.append(OutputTableItem('Simulation Time', datetime.datetime.now().strftime('%H:%M'))) simulation_metadata.append(OutputTableItem('Calculation Time', '{0:10.3f}'.format((time.time() - model.tic)) + ' sec')) @@ -1554,7 +1553,6 @@ def PrintOutputs(self, model: Model): f.write('Simulation Metadata\n') f.write('----------------------\n') f.write(f' GEOPHIRES Version: {geophires_x.__version__}\n') - f.write(' GEOPHIRES Build Date: 2024-03-05\n') # FIXME TODO https://github.com/NREL/GEOPHIRES-X/issues/139 f.write(' Simulation Date: '+ datetime.datetime.now().strftime('%Y-%m-%d\n')) f.write(' Simulation Time: '+ datetime.datetime.now().strftime('%H:%M\n')) f.write(' Calculation Time: '+'{0:10.3f}'.format((time.time()-model.tic)) + ' sec\n') diff --git a/src/geophires_x/SFReservoir.py b/src/geophires_x/SFReservoir.py index b5b7014d..ebd7940e 100644 --- a/src/geophires_x/SFReservoir.py +++ b/src/geophires_x/SFReservoir.py @@ -49,7 +49,7 @@ def __init__(self, model:Model): model.logger.info("Complete " + str(__class__) + ": " + sys._getframe().f_code.co_name) def __str__(self): - return "LHSReservoir" + return 'SFReservoir' def read_parameters(self, model: Model) -> None: """ diff --git a/src/geophires_x/SUTRAOutputs.py b/src/geophires_x/SUTRAOutputs.py index 1226a40d..023adea3 100644 --- a/src/geophires_x/SUTRAOutputs.py +++ b/src/geophires_x/SUTRAOutputs.py @@ -117,7 +117,6 @@ def PrintOutputs(self, model: Model): f.write("Simulation Metadata\n") f.write("----------------------\n") f.write(f' GEOPHIRES Version: {geophires_x.__version__}\n') - f.write(" GEOPHIRES Build Date: 2023-11-06\n") f.write(" Simulation Date: "+ datetime.datetime.now().strftime("%Y-%m-%d\n")) f.write(" Simulation Time: "+ datetime.datetime.now().strftime("%H:%M\n")) f.write(" Calculation Time: "+"{0:10.3f}".format((time.time()-model.tic)) + " sec\n") diff --git a/src/geophires_x/__init__.py b/src/geophires_x/__init__.py index 4cd32db5..4372d5d3 100644 --- a/src/geophires_x/__init__.py +++ b/src/geophires_x/__init__.py @@ -1 +1 @@ -__version__ = '3.4.28' +__version__ = '3.4.29' diff --git a/src/geophires_x_client/geophires_input_parameters.py b/src/geophires_x_client/geophires_input_parameters.py index d0694f3b..f4d36558 100644 --- a/src/geophires_x_client/geophires_input_parameters.py +++ b/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 diff --git a/src/geophires_x_schema_generator/__init__.py b/src/geophires_x_schema_generator/__init__.py index 2a5eb5f8..1554d7e5 100644 --- a/src/geophires_x_schema_generator/__init__.py +++ b/src/geophires_x_schema_generator/__init__.py @@ -8,6 +8,9 @@ # ruff: noqa: I001 from geophires_x.Model import Model +from geophires_x.SFReservoir import SFReservoir +from geophires_x.LHSReservoir import LHSReservoir +from geophires_x.MPFReservoir import MPFReservoir from geophires_x.AGSEconomics import AGSEconomics from geophires_x.AGSWellBores import AGSWellBores from geophires_x.CylindricalReservoir import CylindricalReservoir @@ -20,6 +23,7 @@ from geophires_x.SUTRAEconomics import SUTRAEconomics from geophires_x.SUTRAReservoir import SUTRAReservoir from geophires_x.SUTRAWellBores import SUTRAWellBores +from geophires_x.TDPReservoir import TDPReservoir class GeophiresXSchemaGenerator: @@ -49,6 +53,10 @@ def _with_cat(p: Parameter, cat: str): parameter_sources = [ (dummy_model.reserv, 'Reservoir'), + (TDPReservoir(dummy_model), 'Reservoir'), + (LHSReservoir(dummy_model), 'Reservoir'), + (MPFReservoir(dummy_model), 'Reservoir'), + (SFReservoir(dummy_model), 'Reservoir'), (CylindricalReservoir(dummy_model), 'Reservoir'), (SUTRAReservoir(dummy_model), 'Reservoir'), (dummy_model.wellbores, 'Well Bores'), diff --git a/tests/examples/Beckers_et_al_2023_Tabulated_Database_Coaxial_sCO2_heat.out b/tests/examples/Beckers_et_al_2023_Tabulated_Database_Coaxial_sCO2_heat.out index 6abe4c49..601ca766 100644 --- a/tests/examples/Beckers_et_al_2023_Tabulated_Database_Coaxial_sCO2_heat.out +++ b/tests/examples/Beckers_et_al_2023_Tabulated_Database_Coaxial_sCO2_heat.out @@ -5,7 +5,6 @@ Simulation Metadata ---------------------- GEOPHIRES Version: 3.4.4 - GEOPHIRES Build Date: 2022-06-30 Simulation Date: 2024-03-02 Simulation Time: 14:11 Calculation Time: 1.178 sec diff --git a/tests/examples/Beckers_et_al_2023_Tabulated_Database_Coaxial_water_heat.out b/tests/examples/Beckers_et_al_2023_Tabulated_Database_Coaxial_water_heat.out index fe77d540..deb133e3 100644 --- a/tests/examples/Beckers_et_al_2023_Tabulated_Database_Coaxial_water_heat.out +++ b/tests/examples/Beckers_et_al_2023_Tabulated_Database_Coaxial_water_heat.out @@ -5,7 +5,6 @@ Simulation Metadata ---------------------- GEOPHIRES Version: 3.4.4 - GEOPHIRES Build Date: 2022-06-30 Simulation Date: 2024-03-02 Simulation Time: 14:12 Calculation Time: 1.004 sec diff --git a/tests/examples/Beckers_et_al_2023_Tabulated_Database_Uloop_sCO2_elec.out b/tests/examples/Beckers_et_al_2023_Tabulated_Database_Uloop_sCO2_elec.out index 478a9fa3..a3f80275 100644 --- a/tests/examples/Beckers_et_al_2023_Tabulated_Database_Uloop_sCO2_elec.out +++ b/tests/examples/Beckers_et_al_2023_Tabulated_Database_Uloop_sCO2_elec.out @@ -5,7 +5,6 @@ Simulation Metadata ---------------------- GEOPHIRES Version: 3.4.4 - GEOPHIRES Build Date: 2022-06-30 Simulation Date: 2024-03-02 Simulation Time: 14:13 Calculation Time: 1.085 sec diff --git a/tests/examples/Beckers_et_al_2023_Tabulated_Database_Uloop_sCO2_heat.out b/tests/examples/Beckers_et_al_2023_Tabulated_Database_Uloop_sCO2_heat.out index 83151137..9f8b837f 100644 --- a/tests/examples/Beckers_et_al_2023_Tabulated_Database_Uloop_sCO2_heat.out +++ b/tests/examples/Beckers_et_al_2023_Tabulated_Database_Uloop_sCO2_heat.out @@ -5,7 +5,6 @@ Simulation Metadata ---------------------- GEOPHIRES Version: 3.4.4 - GEOPHIRES Build Date: 2022-06-30 Simulation Date: 2024-03-02 Simulation Time: 14:13 Calculation Time: 1.093 sec diff --git a/tests/examples/Beckers_et_al_2023_Tabulated_Database_Uloop_water_elec.out b/tests/examples/Beckers_et_al_2023_Tabulated_Database_Uloop_water_elec.out index 54cb219f..337917d6 100644 --- a/tests/examples/Beckers_et_al_2023_Tabulated_Database_Uloop_water_elec.out +++ b/tests/examples/Beckers_et_al_2023_Tabulated_Database_Uloop_water_elec.out @@ -5,7 +5,6 @@ Simulation Metadata ---------------------- GEOPHIRES Version: 3.4.4 - GEOPHIRES Build Date: 2022-06-30 Simulation Date: 2024-03-02 Simulation Time: 14:14 Calculation Time: 1.073 sec diff --git a/tests/examples/Beckers_et_al_2023_Tabulated_Database_Uloop_water_heat.out b/tests/examples/Beckers_et_al_2023_Tabulated_Database_Uloop_water_heat.out index 55df5059..48deb5ee 100644 --- a/tests/examples/Beckers_et_al_2023_Tabulated_Database_Uloop_water_heat.out +++ b/tests/examples/Beckers_et_al_2023_Tabulated_Database_Uloop_water_heat.out @@ -5,7 +5,6 @@ Simulation Metadata ---------------------- GEOPHIRES Version: 3.4.4 - GEOPHIRES Build Date: 2022-06-30 Simulation Date: 2024-03-02 Simulation Time: 14:14 Calculation Time: 1.026 sec diff --git a/tests/examples/FIXME_example1_outputunits.out b/tests/examples/FIXME_example1_outputunits.out index 3410e8f2..7df4de12 100644 --- a/tests/examples/FIXME_example1_outputunits.out +++ b/tests/examples/FIXME_example1_outputunits.out @@ -5,7 +5,6 @@ Simulation Metadata ---------------------- GEOPHIRES Version: 3.0 - GEOPHIRES Build Date: 2022-06-30 Simulation Date: 2023-09-29 Simulation Time: 21:03 Calculation Time: 13.691 sec diff --git a/tests/examples/Fervo_Norbeck_Latimer_2024.out b/tests/examples/Fervo_Norbeck_Latimer_2024.out index eb0133c3..7b6c25bb 100644 --- a/tests/examples/Fervo_Norbeck_Latimer_2024.out +++ b/tests/examples/Fervo_Norbeck_Latimer_2024.out @@ -5,7 +5,6 @@ Simulation Metadata ---------------------- GEOPHIRES Version: 3.4.28 - GEOPHIRES Build Date: 2024-03-05 Simulation Date: 2024-05-08 Simulation Time: 09:44 Calculation Time: 2.671 sec diff --git a/tests/examples/S-DAC-GT.out b/tests/examples/S-DAC-GT.out index 4798eff2..c7ef68b8 100644 --- a/tests/examples/S-DAC-GT.out +++ b/tests/examples/S-DAC-GT.out @@ -5,7 +5,6 @@ Simulation Metadata ---------------------- GEOPHIRES Version: 3.4.22 -GEOPHIRES Build Date: 2024-03-05 Simulation Date: 2024-03-20 Simulation Time: 17:51 Calculation Time: 0.433 sec diff --git a/tests/examples/SUTRAExample1.out b/tests/examples/SUTRAExample1.out index 2b251f33..848a42c6 100644 --- a/tests/examples/SUTRAExample1.out +++ b/tests/examples/SUTRAExample1.out @@ -5,7 +5,6 @@ Simulation Metadata ---------------------- GEOPHIRES Version: 3.0 - GEOPHIRES Build Date: 2023-11-06 Simulation Date: 2023-11-06 Simulation Time: 17:26 Calculation Time: 1.566 sec diff --git a/tests/examples/Wanju_Yuan_Closed-Loop_Geothermal_Energy_Recovery.out b/tests/examples/Wanju_Yuan_Closed-Loop_Geothermal_Energy_Recovery.out index cf070d8e..efc08d5a 100644 --- a/tests/examples/Wanju_Yuan_Closed-Loop_Geothermal_Energy_Recovery.out +++ b/tests/examples/Wanju_Yuan_Closed-Loop_Geothermal_Energy_Recovery.out @@ -5,7 +5,6 @@ Simulation Metadata ---------------------- GEOPHIRES Version: 3.4.25 - GEOPHIRES Build Date: 2024-03-05 Simulation Date: 2024-04-30 Simulation Time: 08:43 Calculation Time: 1.706 sec diff --git a/tests/examples/example1.out b/tests/examples/example1.out index 7a8b05fb..0a41e19e 100644 --- a/tests/examples/example1.out +++ b/tests/examples/example1.out @@ -5,7 +5,6 @@ Simulation Metadata ---------------------- GEOPHIRES Version: 3.4.25 - GEOPHIRES Build Date: 2024-03-05 Simulation Date: 2024-04-16 Simulation Time: 10:32 Calculation Time: 0.962 sec diff --git a/tests/examples/example10_HP.out b/tests/examples/example10_HP.out index 591b5b27..f408faa6 100644 --- a/tests/examples/example10_HP.out +++ b/tests/examples/example10_HP.out @@ -5,7 +5,6 @@ Simulation Metadata ---------------------- GEOPHIRES Version: 3.4.25 - GEOPHIRES Build Date: 2024-03-05 Simulation Date: 2024-04-16 Simulation Time: 10:37 Calculation Time: 0.275 sec diff --git a/tests/examples/example11_AC.out b/tests/examples/example11_AC.out index 4aa65a5e..62581d5e 100644 --- a/tests/examples/example11_AC.out +++ b/tests/examples/example11_AC.out @@ -5,7 +5,6 @@ Simulation Metadata ---------------------- GEOPHIRES Version: 3.4.25 - GEOPHIRES Build Date: 2024-03-05 Simulation Date: 2024-04-16 Simulation Time: 10:36 Calculation Time: 0.274 sec diff --git a/tests/examples/example12_DH.out b/tests/examples/example12_DH.out index 8143e650..b06a134c 100644 --- a/tests/examples/example12_DH.out +++ b/tests/examples/example12_DH.out @@ -5,7 +5,6 @@ Simulation Metadata ---------------------- GEOPHIRES Version: 3.4.25 - GEOPHIRES Build Date: 2024-03-05 Simulation Date: 2024-04-16 Simulation Time: 10:46 Calculation Time: 0.257 sec diff --git a/tests/examples/example13.out b/tests/examples/example13.out index b228bc39..a6426ace 100644 --- a/tests/examples/example13.out +++ b/tests/examples/example13.out @@ -5,7 +5,6 @@ Simulation Metadata ---------------------- GEOPHIRES Version: 3.4.25 - GEOPHIRES Build Date: 2024-03-05 Simulation Date: 2024-04-16 Simulation Time: 10:29 Calculation Time: 0.088 sec diff --git a/tests/examples/example1_addons.out b/tests/examples/example1_addons.out index 1a8a9d90..4d76179b 100644 --- a/tests/examples/example1_addons.out +++ b/tests/examples/example1_addons.out @@ -5,7 +5,6 @@ Simulation Metadata ---------------------- GEOPHIRES Version: 3.4.25 - GEOPHIRES Build Date: 2024-03-05 Simulation Date: 2024-04-16 Simulation Time: 10:26 Calculation Time: 0.937 sec diff --git a/tests/examples/example2.out b/tests/examples/example2.out index 6040223a..72dfee10 100644 --- a/tests/examples/example2.out +++ b/tests/examples/example2.out @@ -5,7 +5,6 @@ Simulation Metadata ---------------------- GEOPHIRES Version: 3.4.25 - GEOPHIRES Build Date: 2024-03-05 Simulation Date: 2024-04-16 Simulation Time: 10:33 Calculation Time: 0.365 sec diff --git a/tests/examples/example3.out b/tests/examples/example3.out index 4a3b1a8b..be17ae2c 100644 --- a/tests/examples/example3.out +++ b/tests/examples/example3.out @@ -5,7 +5,6 @@ Simulation Metadata ---------------------- GEOPHIRES Version: 3.4.25 - GEOPHIRES Build Date: 2024-03-05 Simulation Date: 2024-04-16 Simulation Time: 10:34 Calculation Time: 0.333 sec diff --git a/tests/examples/example4.out b/tests/examples/example4.out index 44c3b90c..bca8d7c0 100644 --- a/tests/examples/example4.out +++ b/tests/examples/example4.out @@ -5,7 +5,6 @@ Simulation Metadata ---------------------- GEOPHIRES Version: 3.4.25 - GEOPHIRES Build Date: 2024-03-05 Simulation Date: 2024-04-16 Simulation Time: 10:30 Calculation Time: 0.127 sec diff --git a/tests/examples/example5.out b/tests/examples/example5.out index 745d1288..86f54cba 100644 --- a/tests/examples/example5.out +++ b/tests/examples/example5.out @@ -5,7 +5,6 @@ Simulation Metadata ---------------------- GEOPHIRES Version: 3.4.25 - GEOPHIRES Build Date: 2024-03-05 Simulation Date: 2024-04-16 Simulation Time: 10:31 Calculation Time: 0.124 sec diff --git a/tests/examples/example8.out b/tests/examples/example8.out index 9d940954..a8e02b45 100644 --- a/tests/examples/example8.out +++ b/tests/examples/example8.out @@ -5,7 +5,6 @@ Simulation Metadata ---------------------- GEOPHIRES Version: 3.4.15 - GEOPHIRES Build Date: 2024-03-05 Simulation Date: 2024-03-05 Simulation Time: 09:59 Calculation Time: 0.617 sec diff --git a/tests/examples/example9.out b/tests/examples/example9.out index fd793375..3ded2edd 100644 --- a/tests/examples/example9.out +++ b/tests/examples/example9.out @@ -5,7 +5,6 @@ Simulation Metadata ---------------------- GEOPHIRES Version: 3.4.25 - GEOPHIRES Build Date: 2024-03-05 Simulation Date: 2024-04-16 Simulation Time: 10:49 Calculation Time: 0.949 sec diff --git a/tests/examples/example_ITC.out b/tests/examples/example_ITC.out index cbd36d13..6af617a4 100644 --- a/tests/examples/example_ITC.out +++ b/tests/examples/example_ITC.out @@ -5,7 +5,6 @@ Simulation Metadata ---------------------- GEOPHIRES Version: 3.4.25 - GEOPHIRES Build Date: 2024-03-05 Simulation Date: 2024-04-16 Simulation Time: 10:38 Calculation Time: 0.929 sec diff --git a/tests/examples/example_PTC.out b/tests/examples/example_PTC.out index 5952e80c..254884e3 100644 --- a/tests/examples/example_PTC.out +++ b/tests/examples/example_PTC.out @@ -5,7 +5,6 @@ Simulation Metadata ---------------------- GEOPHIRES Version: 3.4.25 - GEOPHIRES Build Date: 2024-03-05 Simulation Date: 2024-04-16 Simulation Time: 10:36 Calculation Time: 0.971 sec diff --git a/tests/examples/example_SHR-1.out b/tests/examples/example_SHR-1.out index 6218480d..e32f6d13 100644 --- a/tests/examples/example_SHR-1.out +++ b/tests/examples/example_SHR-1.out @@ -5,7 +5,6 @@ Simulation Metadata ---------------------- GEOPHIRES Version: 3.4.22 - GEOPHIRES Build Date: 2024-03-05 Simulation Date: 2024-04-10 Simulation Time: 14:58 Calculation Time: 1.538 sec diff --git a/tests/examples/example_SHR-1.txt b/tests/examples/example_SHR-1.txt index 6f666b4e..d76ddd24 100644 --- a/tests/examples/example_SHR-1.txt +++ b/tests/examples/example_SHR-1.txt @@ -1,3 +1,6 @@ +--- Superhot Rock (SHR) Example 1 +--- See relevant discussion regarding thermosiphoning: https://github.com/NREL/GEOPHIRES-X/issues/188?#issuecomment-2102937796 + Starting Electricity Sale Price, 0.06 Ending Electricity Sale Price, 0.10 Electricity Escalation Start Year, 1 diff --git a/tests/examples/example_SHR-2.out b/tests/examples/example_SHR-2.out index 9e79fdfa..0a315d50 100644 --- a/tests/examples/example_SHR-2.out +++ b/tests/examples/example_SHR-2.out @@ -5,7 +5,6 @@ Simulation Metadata ---------------------- GEOPHIRES Version: 3.4.25 - GEOPHIRES Build Date: 2024-03-05 Simulation Date: 2024-04-16 Simulation Time: 10:45 Calculation Time: 0.957 sec diff --git a/tests/examples/example_SHR-2.txt b/tests/examples/example_SHR-2.txt index 3fe5fb58..c1a43362 100644 --- a/tests/examples/example_SHR-2.txt +++ b/tests/examples/example_SHR-2.txt @@ -1,3 +1,5 @@ +--- Superhot Rock (SHR) Example 2 + Starting Electricity Sale Price, 0.06 Ending Electricity Sale Price, 0.10 Electricity Escalation Start Year, 1 diff --git a/tests/examples/example_multiple_gradients.out b/tests/examples/example_multiple_gradients.out index 4bcb2e00..6177df23 100644 --- a/tests/examples/example_multiple_gradients.out +++ b/tests/examples/example_multiple_gradients.out @@ -5,7 +5,6 @@ Simulation Metadata ---------------------- GEOPHIRES Version: 3.4.25 - GEOPHIRES Build Date: 2024-03-05 Simulation Date: 2024-04-16 Simulation Time: 10:47 Calculation Time: 0.953 sec diff --git a/tests/examples/example_overpressure.out b/tests/examples/example_overpressure.out index 02d8723d..d9e4a3aa 100644 --- a/tests/examples/example_overpressure.out +++ b/tests/examples/example_overpressure.out @@ -5,7 +5,6 @@ Simulation Metadata ---------------------- GEOPHIRES Version: 3.4.25 - GEOPHIRES Build Date: 2024-03-05 Simulation Date: 2024-04-21 Simulation Time: 20:27 Calculation Time: 1.553 sec diff --git a/tests/examples/example_overpressure2.out b/tests/examples/example_overpressure2.out index 5b8febf8..fa76a194 100644 --- a/tests/examples/example_overpressure2.out +++ b/tests/examples/example_overpressure2.out @@ -6,7 +6,6 @@ Simulation Metadata ---------------------- GEOPHIRES Version: 3.4.26 - GEOPHIRES Build Date: 2024-03-05 Simulation Date: 2024-05-02 Simulation Time: 11:44 Calculation Time: 1.647 sec diff --git a/tests/geophires-result_example-1.out b/tests/geophires-result_example-1.out index f0d25efb..78223891 100644 --- a/tests/geophires-result_example-1.out +++ b/tests/geophires-result_example-1.out @@ -5,7 +5,6 @@ Simulation Metadata ---------------------- GEOPHIRES Version: 3.0 - GEOPHIRES Build Date: 2022-06-30 Simulation Date: 2023-09-30 Simulation Time: 11:10 Calculation Time: 1.065 sec diff --git a/tests/geophires-result_example-2.out b/tests/geophires-result_example-2.out index a7008fb4..1162daf7 100644 --- a/tests/geophires-result_example-2.out +++ b/tests/geophires-result_example-2.out @@ -5,7 +5,6 @@ Simulation Metadata ---------------------- GEOPHIRES Version: 3.0 - GEOPHIRES Build Date: 2022-06-30 Simulation Date: 2023-09-30 Simulation Time: 11:08 Calculation Time: 2.897 sec diff --git a/tests/geophires-result_example-3.out b/tests/geophires-result_example-3.out index 6eaf891a..d20191bd 100644 --- a/tests/geophires-result_example-3.out +++ b/tests/geophires-result_example-3.out @@ -5,7 +5,6 @@ Simulation Metadata ---------------------- GEOPHIRES Version: 3.0 - GEOPHIRES Build Date: 2022-06-30 Simulation Date: 2023-09-30 Simulation Time: 11:11 Calculation Time: 0.057 sec diff --git a/tests/geophires-result_example-4.out b/tests/geophires-result_example-4.out index 6234ec30..e696f0a4 100644 --- a/tests/geophires-result_example-4.out +++ b/tests/geophires-result_example-4.out @@ -5,7 +5,6 @@ Simulation Metadata ---------------------- GEOPHIRES Version: 3.0 - GEOPHIRES Build Date: 2022-06-30 Simulation Date: 2023-09-30 Simulation Time: 17:51 Calculation Time: 0.117 sec diff --git a/tests/geophires-result_example-5.out b/tests/geophires-result_example-5.out index 7c908346..4a5ba9c2 100644 --- a/tests/geophires-result_example-5.out +++ b/tests/geophires-result_example-5.out @@ -5,7 +5,6 @@ Simulation Metadata ---------------------- GEOPHIRES Version: 3.0 - GEOPHIRES Build Date: 2022-06-30 Simulation Date: 2023-09-28 Simulation Time: 17:14 Calculation Time: 7.460 sec diff --git a/tests/geophires_x_client_tests/__init__.py b/tests/geophires_x_client_tests/__init__.py new file mode 100644 index 00000000..e69de29b diff --git a/tests/geophires_x_client_tests/client_test_input_1.txt b/tests/geophires_x_client_tests/client_test_input_1.txt new file mode 100644 index 00000000..80685a1f --- /dev/null +++ b/tests/geophires_x_client_tests/client_test_input_1.txt @@ -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] diff --git a/tests/geophires_x_client_tests/client_test_input_2.txt b/tests/geophires_x_client_tests/client_test_input_2.txt new file mode 100644 index 00000000..83a17e87 --- /dev/null +++ b/tests/geophires_x_client_tests/client_test_input_2.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, ---[-] diff --git a/tests/geophires_x_client_tests/test_geophires_input_parameters.py b/tests/geophires_x_client_tests/test_geophires_input_parameters.py new file mode 100644 index 00000000..ec807129 --- /dev/null +++ b/tests/geophires_x_client_tests/test_geophires_input_parameters.py @@ -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()) diff --git a/tests/result_with_ccus_profile.out b/tests/result_with_ccus_profile.out index 84308491..5fa96333 100644 --- a/tests/result_with_ccus_profile.out +++ b/tests/result_with_ccus_profile.out @@ -5,7 +5,6 @@ Simulation Metadata ---------------------- GEOPHIRES Version: 3.4.11 - GEOPHIRES Build Date: 2022-06-30 Simulation Date: 2024-03-01 Simulation Time: 12:31 Calculation Time: 0.616 sec diff --git a/tests/result_with_revenue_and_cashflow_profile.out b/tests/result_with_revenue_and_cashflow_profile.out index 4dcaeade..7b9ecd5c 100644 --- a/tests/result_with_revenue_and_cashflow_profile.out +++ b/tests/result_with_revenue_and_cashflow_profile.out @@ -5,7 +5,6 @@ Simulation Metadata ---------------------- GEOPHIRES Version: 3.4.12 - GEOPHIRES Build Date: 2022-06-30 Simulation Date: 2024-03-04 Simulation Time: 07:46 Calculation Time: 0.611 sec diff --git a/tests/test_geophires_x.py b/tests/test_geophires_x.py index 3ebea944..16cf2354 100644 --- a/tests/test_geophires_x.py +++ b/tests/test_geophires_x.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)) diff --git a/tests/test_geophires_x_client.py b/tests/test_geophires_x_client.py index 22326d36..35f230b5 100644 --- a/tests/test_geophires_x_client.py +++ b/tests/test_geophires_x_client.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}