Regenerate example1_addons.csv when "regenerate-example.result.sh example1_addons" is run

Author: softwareengineerprogrammer

tests/example1_addons.csv

@@ -99,7 +99,7 @@ SURFACE EQUIPMENT SIMULATION RESULTS,Average Annual Net Electricity Generation,,
 SURFACE EQUIPMENT SIMULATION RESULTS,Average Pumping Power,,0.2,MW
 SURFACE EQUIPMENT SIMULATION RESULTS,Initial pumping power/net installed power,,3.82,%
 SURFACE EQUIPMENT SIMULATION RESULTS,First Law Efficiency,,10.07,%
-Simulation Metadata,GEOPHIRES Version,,3.7.0,
+Simulation Metadata,GEOPHIRES Version,,3.7.1,
 POWER GENERATION PROFILE,THERMAL DRAWDOWN,1,1.0,
 POWER GENERATION PROFILE,THERMAL DRAWDOWN,2,1.0056,
 POWER GENERATION PROFILE,THERMAL DRAWDOWN,3,1.0073,

tests/examples/example1_addons.out

@@ -4,10 +4,10 @@
 
 Simulation Metadata
 ----------------------
- GEOPHIRES Version: 3.7.0
- Simulation Date: 2025-01-20
- Simulation Time:  11:30
- Calculation Time:      0.821 sec
+ GEOPHIRES Version: 3.7.1
+ Simulation Date: 2025-01-21
+ Simulation Time:  08:07
+ Calculation Time:      0.814 sec
 
                            ***SUMMARY OF RESULTS***
 

tests/regenerate-example-result.ps1

@@ -31,3 +31,5 @@ cd ..
 #./tests/regenerate-example-result.ps1 example_SHR-2
 #./tests/regenerate-example-result.ps1 Fervo_Norbeck_Latimer_2024
 #./tests/regenerate-example-result.ps1 Wanju_Yuan_Closed-Loop_Geothermal_Energy_Recovery
+
+# TODO regenerate CSV for example1_addons as in regenerate-example-result.sh

tests/regenerate-example-result.sh

@@ -12,3 +12,9 @@
 cd "$(dirname "$0")"
 python -mgeophires_x examples/$1.txt examples/$1.out
 rm examples/$1.json
+
+if [[ $1 == "example1_addons" ]]
+then
+    echo "Updating CSV..."
+    python regenerate_example_result_csv.py
+fi

tests/regenerate_example_result_csv.py

@@ -0,0 +1,13 @@
+import os
+from pathlib import Path
+
+from geophires_x_client import GeophiresXResult
+
+
+def _get_file_path(file_name: str | Path) -> str:
+    return os.path.join(os.path.abspath(os.path.dirname(__file__)), str(file_name))
+
+
+if __name__ == '__main__':
+    with open(_get_file_path('example1_addons.csv'), 'w', encoding='utf-8') as csvfile:
+        csvfile.write(GeophiresXResult(_get_file_path('examples/example1_addons.out')).as_csv())

tests/test_geophires_x_client.py

@@ -456,12 +456,13 @@ def test_input_with_non_default_units(self):
 
     def test_csv(self):
         """
-        TODO make this less tedious to update when expected result values change
+        Note: example1_addons.csv will be updated automatically when `regenerate-example-result.sh example1_addons` is
+        run.
 
-        Current easiest method to update:
-         1. set breakpoint on line after `as_csv = result.as_csv()`
-         2. debug test, hit break point
-         3. copy-paste value of `as_csv` to example1_addons.csv
+        If needed, example1_addons.csv can also be updated manually with the following steps:
+         1. In your IDE, set a breakpoint on the line after `as_csv = result.as_csv()`
+         2. Debug this test and hit the break point
+         3. Copy-paste the value of `as_csv` (in Threads & Variables tab in PyCharm) to example1_addons.csv
         """
 
         def assertFileContentsEqual(expected_file_path, actual_file_path, tol=0.01):