Move sig_figs to GeoPHIRESUtils.py

Author: softwareengineerprogrammer

src/geophires_x/EconomicsSam.py

@@ -38,10 +38,10 @@
     project_vir_parameter,
     project_payback_period_parameter,
 )
-from geophires_x.GeoPHIRESUtils import is_float, is_int
+from geophires_x.GeoPHIRESUtils import is_float, is_int, sig_figs
 from geophires_x.OptionList import EconomicModel, EndUseOptions
 from geophires_x.Parameter import Parameter, OutputParameter, floatParameter
-from geophires_x.Units import convertible_unit, EnergyCostUnit, CurrencyUnit, Units, PercentUnit
+from geophires_x.Units import convertible_unit, EnergyCostUnit, CurrencyUnit, Units
 
 
 @dataclass
@@ -162,7 +162,7 @@ def calculate_sam_economics(model: Model) -> SamEconomicsCalculations:
     cash_flow = _calculate_sam_economics_cash_flow(model, single_owner)
 
     def sf(_v: float, num_sig_figs: int = 5) -> float:
-        return _sig_figs(_v, num_sig_figs)
+        return sig_figs(_v, num_sig_figs)
 
     sam_economics: SamEconomicsCalculations = SamEconomicsCalculations(sam_cash_flow_profile=cash_flow)
     sam_economics.lcoe_nominal.value = sf(single_owner.Outputs.lcoe_nom)
@@ -435,21 +435,3 @@ def _ppa_pricing_model(
 
 def _get_max_total_generation_kW(model: Model) -> float:
     return np.max(model.surfaceplant.ElectricityProduced.quantity().to(convertible_unit('kW')).magnitude)
-
-
-def _sig_figs(val: float | list | tuple, num_sig_figs: int) -> float:
-    """
-    TODO move to utilities, probably
-    """
-
-    if val is None:
-        return None
-
-    if isinstance(val, list) or isinstance(val, tuple):
-        return [_sig_figs(v, num_sig_figs) for v in val]
-
-    try:
-        return float('%s' % float(f'%.{num_sig_figs}g' % val))  # pylint: disable=consider-using-f-string
-    except TypeError:
-        # TODO warn
-        return val

src/geophires_x/GeoPHIRESUtils.py

@@ -642,3 +642,16 @@ def is_float(o: Any) -> bool:
     else:
         return True
 
+
+def sig_figs(val: float | list | tuple, num_sig_figs: int) -> float:
+    if val is None:
+        return None
+
+    if isinstance(val, list) or isinstance(val, tuple):
+        return [sig_figs(v, num_sig_figs) for v in val]
+
+    try:
+        return float('%s' % float(f'%.{num_sig_figs}g' % val))  # pylint: disable=consider-using-f-string
+    except TypeError:
+        # TODO warn
+        return val

tests/geophires_x_tests/test_economics_sam.py

@@ -17,11 +17,11 @@
 # noinspection PyProtectedMember
 from geophires_x.EconomicsSam import (
     calculate_sam_economics,
-    _sig_figs,
     get_sam_cash_flow_profile_tabulated_output,
     _ppa_pricing_model,
     _get_fed_and_state_tax_rates,
 )
+from geophires_x.GeoPHIRESUtils import sig_figs
 
 # noinspection PyProtectedMember
 from geophires_x.EconomicsSamCashFlow import _clean_profile, _is_category_row_label, _is_designator_row_label
@@ -459,8 +459,8 @@ def test_is_designator_row_label(self):
         self.assertTrue(_is_designator_row_label('plus PBI if not available for debt service:'))
 
     def test_sig_figs(self):
-        self.assertListEqual(_sig_figs([1.14, 2.24], 2), [1.1, 2.2])
-        self.assertListEqual(_sig_figs((1.14, 2.24), 2), [1.1, 2.2])
+        self.assertListEqual(sig_figs([1.14, 2.24], 2), [1.1, 2.2])
+        self.assertListEqual(sig_figs((1.14, 2.24), 2), [1.1, 2.2])
 
     def test_get_fed_and_state_tax_rates(self):
         self.assertEqual(([21], [7]), _get_fed_and_state_tax_rates(0.28))