Add quantiphy, print_results() uses engineering notation

Author: robbievanleeuwen

docs/examples/area_properties.ipynb

@@ -132,7 +132,7 @@
    "outputs": [],
    "source": [
     "gross_props = conc_sec.get_gross_properties()\n",
-    "gross_props.print_results(fmt=\".3e\")"
+    "gross_props.print_results()"
    ]
   },
   {
@@ -153,7 +153,7 @@
    "outputs": [],
    "source": [
     "transformed_props = conc_sec.get_transformed_gross_properties(elastic_modulus=30.1e3)\n",
-    "transformed_props.print_results(fmt=\".3e\")"
+    "transformed_props.print_results()"
    ]
   }
  ],

docs/examples/prestressed_section.ipynb

@@ -270,7 +270,7 @@
    "source": [
     "gross_props_serv = conc_sec_serv.get_gross_properties()\n",
     "gross_props_ult = conc_sec_ult.get_gross_properties()\n",
-    "gross_props_serv.print_results(fmt=\".3e\")"
+    "gross_props_serv.print_results()"
    ]
   },
   {
@@ -376,7 +376,7 @@
    "source": [
     "cr_p_serv = conc_sec_serv.calculate_cracked_properties(m_ext=0)\n",
     "cr_p_ult = conc_sec_ult.calculate_cracked_properties(m_ext=0)\n",
-    "cr_p_serv.print_results(fmt=\".3e\")\n",
+    "cr_p_serv.print_results()\n",
     "cr_stress_p_serv = conc_sec_serv.calculate_cracked_stress(cracked_results=cr_p_serv)\n",
     "cr_stress_p_serv.plot_stress()"
    ]

pyproject.toml

@@ -40,6 +40,7 @@ dependencies = [
     "cytriangle~=1.0.3",
     "rich[jupyter]~=13.9.3",
     "more-itertools~=10.5.0",
+    "quantiphy~=2.20",
 ]
 
 [project.urls]

src/concreteproperties/post.py

@@ -6,6 +6,7 @@
 from typing import TYPE_CHECKING
 
 import matplotlib.pyplot as plt
+from quantiphy import Quantity
 
 if TYPE_CHECKING:
     import matplotlib.axes
@@ -100,3 +101,41 @@ def plotting_context(
         else:
             plt.draw()
             plt.pause(0.001)
+
+
+def string_formatter(
+    value: float,
+    eng: bool,
+    prec: int,
+    scale: float = 1.0,
+) -> str:
+    """Formats a float using engineering or fixed notation.
+
+    Args:
+        value: Number to format
+        eng: If set to ``True``, formats with engineering notation. If set to ``False``,
+            formats with fixed notation.
+        prec: The desired precision (i.e. one plus this value is the desired number of
+            digits)
+        scale: Factor by which to scale the value. Defaults to ``1.0``.
+
+    Returns:
+        Formatted string
+    """
+    q = Quantity(value)
+    form = "eng" if eng else "fixed"
+    val_fmt = q.render(
+        form=form, show_units=False, prec=prec, scale=scale, strip_zeros=False
+    )
+    spl = val_fmt.split("e")
+
+    # if there is an exponent, render as 'x 10^n'
+    if eng and len(spl) > 1:
+        num = spl[0]
+        exp = spl[1]
+        return f"{num} x 10^{exp}"
+    else:
+        return val_fmt
+
+
+# TODO: FuncFormatter for plots