break singh et al. simulation out in preparation to more fully document it

Author: softwareengineerprogrammer

src/geophires_docs/__init__.py

@@ -0,0 +1,5 @@
+from __future__ import annotations
+
+from pathlib import Path
+
+_PROJECT_ROOT = Path(__file__).parent.parent.parent

src/geophires_docs/__main__.py

@@ -1,4 +1,4 @@
 if __name__ == '__main__':
-    from geophires_docs import generate_fervo_project_cape_4_md
+    from geophires_docs import generate_fervo_project_cape_4_docs
 
-    generate_fervo_project_cape_4_md.main()
+    generate_fervo_project_cape_4_docs.generate_fervo_project_cape_4_docs()

src/geophires_docs/generate_fervo_project_cape_4_docs.py

@@ -0,0 +1,50 @@
+from __future__ import annotations
+
+from geophires_docs import _PROJECT_ROOT
+from geophires_docs import generate_fervo_project_cape_4_md
+from geophires_docs.generate_fervo_project_cape_4_graphs import generate_fervo_project_cape_4_graphs
+from geophires_x_client import GeophiresInputParameters
+from geophires_x_client import GeophiresXClient
+from geophires_x_client import GeophiresXResult
+from geophires_x_client import ImmutableGeophiresInputParameters
+
+
+# fmt:off
+def get_singh_et_al_base_simulation_result(base_input_params: GeophiresInputParameters) \
+        -> tuple[GeophiresInputParameters,GeophiresXResult]:
+    singh_et_al_base_simulation_input_params = ImmutableGeophiresInputParameters(
+        from_file_path=base_input_params.as_file_path(),
+        params={
+            'Number of Production Wells': 4,
+            'Maximum Drawdown': 1,
+            'Plant Lifetime': 15,
+        },
+    )
+    # fmt:on
+
+    singh_et_al_base_simulation_result = GeophiresXClient().get_geophires_result(
+        singh_et_al_base_simulation_input_params
+    )
+
+    return singh_et_al_base_simulation_input_params, singh_et_al_base_simulation_result
+
+
+def generate_fervo_project_cape_4_docs():
+    input_params: GeophiresInputParameters = ImmutableGeophiresInputParameters(
+        from_file_path=_PROJECT_ROOT / 'tests/examples/Fervo_Project_Cape-4.txt'
+    )
+    result = GeophiresXResult(_PROJECT_ROOT / 'tests/examples/Fervo_Project_Cape-4.out')
+
+    singh_et_al_base_simulation:tuple[GeophiresInputParameters,GeophiresXResult] = get_singh_et_al_base_simulation_result(input_params)
+
+    generate_fervo_project_cape_4_graphs(
+        (input_params, result),
+        singh_et_al_base_simulation,
+        _PROJECT_ROOT / 'docs/_images'
+    )
+
+    generate_fervo_project_cape_4_md.generate_fervo_project_cape_4_md(input_params,result)
+
+
+if __name__ == '__main__':
+    generate_fervo_project_cape_4_docs()

src/geophires_docs/generate_fervo_project_cape_4_graphs.py

@@ -5,8 +5,8 @@
 import numpy as np
 from matplotlib import pyplot as plt
 
+from geophires_docs import _PROJECT_ROOT
 from geophires_x_client import GeophiresInputParameters
-from geophires_x_client import GeophiresXClient
 from geophires_x_client import GeophiresXResult
 from geophires_x_client import ImmutableGeophiresInputParameters
 
@@ -134,25 +134,18 @@ def generate_production_temperature_graph(
 
 
 def generate_fervo_project_cape_4_graphs(
-    input_params: GeophiresInputParameters, result: GeophiresXResult, output_dir: Path
+    base_case: tuple[GeophiresInputParameters, GeophiresXResult],
+    singh_et_al_base_simulation: tuple[GeophiresInputParameters, GeophiresXResult],
+    output_dir: Path,
 ) -> None:
+    # base_case_input_params: GeophiresInputParameters = base_case[0]
+    # result:GeophiresXResult = base_case[1]
+
     # generate_net_power_graph(result, output_dir)
     # generate_production_temperature_graph(result, output_dir)
 
-    # fmt:off
-    singh_et_al_base_simulation_input_params = ImmutableGeophiresInputParameters(
-        from_file_path=input_params.as_file_path(),
-        params={
-            'Number of Production Wells': 4,
-            'Maximum Drawdown': 1,
-            'Plant Lifetime': 15,
-        },
-    )
-    # fmt:on
+    singh_et_al_base_simulation_result: GeophiresXResult = singh_et_al_base_simulation[1]
 
-    singh_et_al_base_simulation_result = GeophiresXClient().get_geophires_result(
-        singh_et_al_base_simulation_input_params
-    )
     # generate_net_power_graph(
     #     singh_et_al_base_simulation_result, output_dir, filename='singh_et_al_base_simulation-net-power-production.png'
     # )
@@ -164,14 +157,13 @@ def generate_fervo_project_cape_4_graphs(
 
 
 if __name__ == '__main__':
-    project_root = Path(__file__).parent.parent
-    docs_dir = project_root / 'docs'
+    docs_dir = _PROJECT_ROOT / 'docs'
     images_dir = docs_dir / '_images'
 
     input_params_: GeophiresInputParameters = ImmutableGeophiresInputParameters(
-        from_file_path=project_root / 'tests/examples/Fervo_Project_Cape-4.txt'
+        from_file_path=_PROJECT_ROOT / 'tests/examples/Fervo_Project_Cape-4.txt'
     )
 
-    result_ = GeophiresXResult(project_root / 'tests/examples/Fervo_Project_Cape-4.out')
+    result_ = GeophiresXResult(_PROJECT_ROOT / 'tests/examples/Fervo_Project_Cape-4.out')
 
     generate_fervo_project_cape_4_graphs(input_params_, result_, images_dir)

src/geophires_docs/generate_fervo_project_cape_4_md.py

@@ -7,25 +7,21 @@
 from __future__ import annotations
 
 import json
-from pathlib import Path
 from typing import Any
 
 import numpy as np
 from jinja2 import Environment
 from jinja2 import FileSystemLoader
 from pint.facets.plain import PlainQuantity
 
-from geophires_docs.generate_fervo_project_cape_4_graphs import generate_fervo_project_cape_4_graphs
+from geophires_docs import _PROJECT_ROOT
 from geophires_x.GeoPHIRESUtils import is_int
 from geophires_x.GeoPHIRESUtils import sig_figs
 from geophires_x_client import GeophiresInputParameters
 from geophires_x_client import GeophiresXResult
 from geophires_x_client import ImmutableGeophiresInputParameters
 
 # Add project root to path to import GEOPHIRES and docs modules
-_PROJECT_ROOT = Path(__file__).parent.parent.parent
-# sys.path.insert(0, str(_PROJECT_ROOT / 'src'))
-# sys.path.insert(0, Path(__file__).parent)
 
 
 def _get_input_parameters_dict(  # TODO consolidate with FervoProjectCape4TestCase._get_input_parameters
@@ -376,16 +372,7 @@ def _total_fracture_surface_area_per_well_m2(result: GeophiresXResult) -> float:
     )
 
 
-def main():
-    """
-    Generate Fervo_Project_Cape-4.md (markdown documentation) from the Jinja template.
-    """
-
-    input_params: GeophiresInputParameters = ImmutableGeophiresInputParameters(
-        from_file_path=_PROJECT_ROOT / 'tests/examples/Fervo_Project_Cape-4.txt'
-    )
-    result = GeophiresXResult(_PROJECT_ROOT / 'tests/examples/Fervo_Project_Cape-4.out')
-
+def generate_fervo_project_cape_4_md(input_params: GeophiresInputParameters, result: GeophiresXResult) -> None:
     # noinspection PyDictCreation
     template_values = {**get_fpc4_input_parameter_values(input_params, result), **get_result_values(result)}
 
@@ -395,8 +382,6 @@ def main():
     template_values['economics_parameters_table_md'] = generate_fpc4_economics_parameters_table_md(input_params)
 
     docs_dir = _PROJECT_ROOT / 'docs'
-    images_dir = docs_dir / '_images'
-    generate_fervo_project_cape_4_graphs(input_params, result, images_dir)
 
     # Set up Jinja environment
     env = Environment(loader=FileSystemLoader(docs_dir), autoescape=True)
@@ -417,5 +402,17 @@ def main():
     print(f"\tTotal CAPEX: ${template_values['total_capex_gusd']}B")
 
 
+def main():
+    """
+    Generate Fervo_Project_Cape-4.md (markdown documentation) from the Jinja template.
+    """
+
+    input_params: GeophiresInputParameters = ImmutableGeophiresInputParameters(
+        from_file_path=_PROJECT_ROOT / 'tests/examples/Fervo_Project_Cape-4.txt'
+    )
+    result = GeophiresXResult(_PROJECT_ROOT / 'tests/examples/Fervo_Project_Cape-4.out')
+    generate_fervo_project_cape_4_md(input_params, result)
+
+
 if __name__ == '__main__':
     main()