Merge remote-tracking branch 'origin/fervo-case-study' into fervo-case-study

Author: malcolm-dsider

.bumpversion.cfg

@@ -1,5 +1,5 @@
 [bumpversion]
-current_version = 3.4.25
+current_version = 3.4.28
 commit = True
 tag = True
 

.cookiecutterrc

@@ -54,7 +54,7 @@ default_context:
     sphinx_doctest: "no"
     sphinx_theme: "sphinx-py3doc-enhanced-theme"
     test_matrix_separate_coverage: "no"
-    version: 3.4.25
+    version: 3.4.28
     version_manager: "bump2version"
     website: "https://github.com/NREL"
     year_from: "2023"

LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2023, NREL
+Copyright (c) 2023-2024, NREL
 
 Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
 

README.rst

@@ -47,9 +47,9 @@ Free software: `MIT license <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.25.svg
+.. |commits-since| image:: https://img.shields.io/github/commits-since/softwareengineerprogrammer/GEOPHIRES-X/v3.4.28.svg
     :alt: Commits since latest release
-    :target: https://github.com/softwareengineerprogrammer/GEOPHIRES-X/compare/v3.4.25...main
+    :target: https://github.com/softwareengineerprogrammer/GEOPHIRES-X/compare/v3.4.28...main
 
 .. |docs| image:: https://readthedocs.org/projects/GEOPHIRES-X/badge/?style=flat
     :target: https://nrel.github.io/GEOPHIRES-X
@@ -65,7 +65,7 @@ Getting Started
 Web Interface
 -------------
 
-A web interface is available at `tinyurl.com/geophires <https://tinyurl.com/geophires>`__
+A web interface is available at `bit.ly/GEOPHIRES <https://bit.ly/GEOPHIRES>`__
 
 Installation
 ------------

References/01d-jedi-geothermal-model-rel-gt12-23-16.xlsm

@@ -18,7 +18,7 @@
 year = '2023'
 author = 'NREL'
 copyright = f'{year}, {author}'
-version = release = '3.4.25'
+version = release = '3.4.28'
 
 pygments_style = 'trac'
 templates_path = ['./templates']

References/JEDI.pdf

@@ -13,7 +13,7 @@ def read(*names, **kwargs):
 
 setup(
     name='geophires-x',
-    version='3.4.25',
+    version='3.4.28',
     license='MIT',
     description='GEOPHIRES is a free and open-source geothermal techno-economic simulator.',
     long_description='{}\n{}'.format(

docs/conf.py

@@ -218,12 +218,14 @@ def work_package(pass_list: list):
         shutil.copyfile(result.output_file_path, tmp_output_file)
     elif args.Code_File.endswith('HIP_RA.py'):
         hip_ra_client: HipRaClient = HipRaClient()
-        result: HipRaResult = hip_ra_client.get_hip_ra_result(HipRaInputParameters(from_file_path=Path(tmp_input_file)))
+        result: HipRaResult = hip_ra_client.get_hip_ra_result(
+            HipRaInputParameters(file_path_or_params_dict=Path(tmp_input_file))
+        )
         shutil.copyfile(result.output_file_path, tmp_output_file)
     elif args.Code_File.endswith('hip_ra_x.py'):
         hip_ra_x_client: HipRaXClient = HipRaXClient()
         result: HipRaResult = hip_ra_x_client.get_hip_ra_result(
-            HipRaInputParameters(from_file_path=Path(tmp_input_file))
+            HipRaInputParameters(file_path_or_params_dict=Path(tmp_input_file))
         )
         shutil.copyfile(result.output_file_path, tmp_output_file)
     else:
@@ -358,6 +360,7 @@ def main(command_line_args=None):
         if 'MC_OUTPUT_FILE' in args and args.MC_OUTPUT_FILE is not None
         else str(Path(Path(args.Input_file).parent, 'MC_Result.txt').absolute())
     )
+    code_file_name = Path(args.Code_File).name
     python_path = 'python'
     html_path = ''
 
@@ -450,6 +453,14 @@ def main(command_line_args=None):
     results_pd = pd.read_csv(output_file)
     df = pd.DataFrame(results_pd)
 
+    if len(results) < 1:
+        # TODO surface actual exceptions instead of giving this generic message
+        raise RuntimeError(
+            'No MC results generated, '
+            f'this is likely caused by {code_file_name} throwing an exception '
+            f'when run with your input file.'
+        )
+
     # Compute the stats along the specified axes.
     mins = np.nanmin(results, 0)
     maxs = np.nanmax(results, 0)