Merge pull request NREL#240 from softwareengineerprogrammer/main

Add Estimated Jobs Created for electricity end-use

NREL#232

Author: softwareengineerprogrammer

.bumpversion.cfg

@@ -1,5 +1,5 @@
 [bumpversion]
-current_version = 3.4.34
+current_version = 3.4.35
 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.34
+    version: 3.4.35
     version_manager: "bump2version"
     website: "https://github.com/NREL"
     year_from: "2023"

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.34.svg
+.. |commits-since| image:: https://img.shields.io/github/commits-since/softwareengineerprogrammer/GEOPHIRES-X/v3.4.35.svg
     :alt: Commits since latest release
-    :target: https://github.com/softwareengineerprogrammer/GEOPHIRES-X/compare/v3.4.34...main
+    :target: https://github.com/softwareengineerprogrammer/GEOPHIRES-X/compare/v3.4.35...main
 
 .. |docs| image:: https://readthedocs.org/projects/GEOPHIRES-X/badge/?style=flat
     :target: https://nrel.github.io/GEOPHIRES-X

docs/conf.py

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

setup.py

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

src/geophires_x/Economics.py

@@ -1509,6 +1509,15 @@ def __init__(self, model: Model):
             ToolTipText="Production tax credit inflation adjusted"
         )
 
+        self.jobs_created_per_MW_electricity = self.ParameterDict[
+            self.jobs_created_per_MW_electricity.Name] = floatParameter(
+            "Estimated Jobs Created per MW of Electricity Produced",
+            DefaultValue=2.13,
+            UnitType=Units.NONE,
+            Required=False,
+            ToolTipText="Estimated jobs created per MW of electricity produced, per https://geothermal.org/resources/geothermal-basics"
+        )
+
         # local variable initialization
         self.CAPEX_cost_electricity_plant = 0.0
         self.CAPEX_cost_heat_plant = 0.0
@@ -1818,6 +1827,10 @@ def __init__(self, model: Model):
             PreferredUnits=CurrencyUnit.MDOLLARS,
             CurrentUnits=CurrencyUnit.MDOLLARS
         )
+        self.jobs_created = self.OutputParameterDict[self.jobs_created.Name] = OutputParameter(
+            Name="Estimated Jobs Created",
+            UnitType=Units.NONE,
+        )
 
         model.logger.info(f'Complete {__class__!s}: {sys._getframe().f_code.co_name}')
 
@@ -2890,6 +2903,11 @@ def Calculate(self, model: Model) -> None:
         # Calculate LCOE/LCOH
         self.LCOE.value, self.LCOH.value, self.LCOC.value = CalculateLCOELCOHLCOC(self, model)
 
+        # https://github.com/NREL/GEOPHIRES-X/issues/232
+        self.jobs_created.value = round(
+            np.average(model.surfaceplant.ElectricityProduced.quantity().to(
+                'MW').magnitude * self.jobs_created_per_MW_electricity.value))
+
         model.logger.info(f'complete {__class__!s}: {sys._getframe().f_code.co_name}')
 
     def __str__(self):

src/geophires_x/Outputs.py

@@ -1638,6 +1638,10 @@ def PrintOutputs(self, model: Model):
                                                               EndUseOptions.COGENERATION_PARALLEL_EXTRA_ELECTRICITY]:
                     f.write(f'      CHP: Percent cost allocation for electrical plant: {model.economics.CAPEX_heat_electricity_plant_ratio.value*100.0:10.2f}%' + NL)
 
+                if model.surfaceplant.enduse_option.value in [EndUseOptions.ELECTRICITY]:
+                    f.write(f'      Estimated Jobs Created:                                 {model.economics.jobs_created.value}\n')
+
+
                 f.write(NL)
                 f.write('                          ***ENGINEERING PARAMETERS***\n')
                 f.write(NL)

src/geophires_x/__init__.py

@@ -1 +1 @@
-__version__ = '3.4.34'
+__version__ = '3.4.35'

src/geophires_x_client/geophires_x_result.py

@@ -71,6 +71,7 @@ class GeophiresXResult:
                 'Fixed Charge Rate (FCR)',  # SUTRA
                 'Project Payback Period',
                 'CHP: Percent cost allocation for electrical plant',
+                'Estimated Jobs Created',
             ],
             'EXTENDED ECONOMICS': [
                 'Adjusted Project LCOE (after incentives, grants, AddOns,etc)',

tests/example1_addons.csv

@@ -18,6 +18,7 @@ ECONOMIC PARAMETERS,Project VIR=PI=PIR,,3.42,
 ECONOMIC PARAMETERS,Project MOIC,,36.27,
 ECONOMIC PARAMETERS,Fixed Charge Rate (FCR),,5.0,
 ECONOMIC PARAMETERS,Project Payback Period,,7.05,yr
+ECONOMIC PARAMETERS,Estimated Jobs Created,,12,
 EXTENDED ECONOMICS,"Adjusted Project LCOE (after incentives\, grants\, AddOns\,etc)",,1.74,cents/kWh
 EXTENDED ECONOMICS,"Adjusted Project LCOH (after incentives\, grants\, AddOns\,etc)",,0.0,USD/MMBTU
 EXTENDED ECONOMICS,"Adjusted Project CAPEX (after incentives\, grants\, AddOns\, etc)",,101.07,MUSD
@@ -96,7 +97,7 @@ SURFACE EQUIPMENT SIMULATION RESULTS,Average Annual Total Electricity Generation
 SURFACE EQUIPMENT SIMULATION RESULTS,Average Annual Net Electricity Generation,,42.3,GWh
 SURFACE EQUIPMENT SIMULATION RESULTS,Average Pumping Power,,0.2,MW
 SURFACE EQUIPMENT SIMULATION RESULTS,Initial pumping power/net installed power,,3.82,%
-Simulation Metadata,GEOPHIRES Version,,3.4.31,
+Simulation Metadata,GEOPHIRES Version,,3.4.34,
 POWER GENERATION PROFILE,THERMAL DRAWDOWN,1,1.0,
 POWER GENERATION PROFILE,THERMAL DRAWDOWN,2,1.0056,
 POWER GENERATION PROFILE,THERMAL DRAWDOWN,3,1.0073,