Start formatting plots

Author: robbievanleeuwen

docs/examples/as3600.ipynb

@@ -437,7 +437,7 @@
    "name": "python",
    "nbconvert_exporter": "python",
    "pygments_lexer": "ipython3",
-   "version": "3.11.4"
+   "version": "3.12.7"
   },
   "vscode": {
    "interpreter": {

docs/examples/biaxial_bending.ipynb

@@ -149,7 +149,13 @@
    "metadata": {},
    "outputs": [],
    "source": [
-    "bb_res.plot_diagram()"
+    "bb_res.plot_diagram(\n",
+    "    eng=True,\n",
+    "    n_scale=1e-3,\n",
+    "    m_scale=1e-6,\n",
+    "    n_unit=\"kN\",\n",
+    "    m_unit=\"kN.m\",\n",
+    ")"
    ]
   },
   {
@@ -168,7 +174,13 @@
    "outputs": [],
    "source": [
     "bb_res = conc_sec.biaxial_bending_diagram(n=1000e3, n_points=24, progress_bar=False)\n",
-    "bb_res.plot_diagram()"
+    "bb_res.plot_diagram(\n",
+    "    eng=True,\n",
+    "    n_scale=1e-3,\n",
+    "    m_scale=1e-6,\n",
+    "    n_unit=\"kN\",\n",
+    "    m_unit=\"kN.m\",\n",
+    ")"
    ]
   },
   {
@@ -189,8 +201,8 @@
    "source": [
     "mi_x = conc_sec.moment_interaction_diagram(progress_bar=False)\n",
     "mi_y = conc_sec.moment_interaction_diagram(theta=np.pi / 2, progress_bar=False)\n",
-    "mi_x.plot_diagram()\n",
-    "mi_y.plot_diagram(moment=\"m_y\")\n",
+    "mi_x.plot_diagram(eng=True)\n",
+    "mi_y.plot_diagram(moment=\"m_y\", eng=True)\n",
     "print(f\"Decompression point for M_x is N = {mi_x.results[1].n / 1e3:.2f} kN\")\n",
     "print(f\"Decompression point for M_y is N = {mi_y.results[1].n / 1e3:.2f} kN\")"
    ]
@@ -232,7 +244,14 @@
    "metadata": {},
    "outputs": [],
    "source": [
-    "BiaxialBendingResults.plot_multiple_diagrams_3d(biaxial_results)"
+    "BiaxialBendingResults.plot_multiple_diagrams_3d(\n",
+    "    biaxial_results,\n",
+    "    eng=True,\n",
+    "    n_scale=1e-3,\n",
+    "    m_scale=1e-6,\n",
+    "    n_unit=\"kN\",\n",
+    "    m_unit=\"kN.m\",\n",
+    ")"
    ]
   },
   {
@@ -250,7 +269,15 @@
    "metadata": {},
    "outputs": [],
    "source": [
-    "BiaxialBendingResults.plot_multiple_diagrams_2d(biaxial_results, fmt=\"o-\")"
+    "BiaxialBendingResults.plot_multiple_diagrams_2d(\n",
+    "    biaxial_results,\n",
+    "    fmt=\"o-\",\n",
+    "    eng=True,\n",
+    "    n_scale=1e-3,\n",
+    "    m_scale=1e-6,\n",
+    "    n_unit=\"kN\",\n",
+    "    m_unit=\"kN.m\",\n",
+    ")"
    ]
   },
   {
@@ -268,17 +295,24 @@
    "metadata": {},
    "outputs": [],
    "source": [
-    "import matplotlib.pyplot as plt\n",
-    "\n",
-    "labels = [f\"N = {bb_res.n / 1e3:.0f} kN\" for bb_rs in biaxial_results[::2]]\n",
+    "labels = [f\"N = {bb_res.n / 1e3:.0f} kN\" for bb_res in biaxial_results[::2]]\n",
     "\n",
     "ax = BiaxialBendingResults.plot_multiple_diagrams_2d(\n",
-    "    biaxial_results[::2], fmt=\"-\", labels=labels, render=False\n",
-    ")\n",
-    "ax.set_xlabel(\"Bending Moment $M_x$ [kN.m]\")\n",
-    "ax.set_ylabel(\"Bending Moment $M_y$ [kN.m]\")\n",
-    "plt.show()"
+    "    biaxial_results[::2],\n",
+    "    fmt=\"-\",\n",
+    "    labels=labels,\n",
+    "    m_scale=1e-6,\n",
+    "    m_unit=\"kN.m\",\n",
+    ")"
    ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "id": "23",
+   "metadata": {},
+   "outputs": [],
+   "source": []
   }
  ],
  "metadata": {

docs/examples/cracked_properties.ipynb

@@ -256,7 +256,7 @@
    "name": "python",
    "nbconvert_exporter": "python",
    "pygments_lexer": "ipython3",
-   "version": "3.11.4"
+   "version": "3.12.7"
   }
  },
  "nbformat": 4,

docs/examples/moment_curvature.ipynb

@@ -256,7 +256,12 @@
    "outputs": [],
    "source": [
     "MomentCurvatureResults.plot_multiple_results(\n",
-    "    moment_curvature_results=moment_curvature_results, labels=labels, fmt=\"-\"\n",
+    "    moment_curvature_results=moment_curvature_results,\n",
+    "    labels=labels,\n",
+    "    fmt=\"-\",\n",
+    "    eng=True,\n",
+    "    m_scale=1e-6,\n",
+    "    m_unit=\"kN.m\",\n",
     ")"
    ]
   },
@@ -294,7 +299,12 @@
    "outputs": [],
    "source": [
     "MomentCurvatureResults.plot_multiple_results(\n",
-    "    moment_curvature_results=moment_curvature_results[1:], labels=labels[1:], fmt=\"-\"\n",
+    "    moment_curvature_results=moment_curvature_results[1:],\n",
+    "    labels=labels[1:],\n",
+    "    fmt=\"-\",\n",
+    "    eng=True,\n",
+    "    m_scale=1e-6,\n",
+    "    m_unit=\"kN.m\",\n",
     ")"
    ]
   },
@@ -440,7 +450,7 @@
    "metadata": {},
    "outputs": [],
    "source": [
-    "res1.plot_results(fmt=\"x-\")\n",
+    "res1.plot_results()\n",
     "print(f\"Number of calculations = {len(res1.kappa)}\")\n",
     "print(f\"Failure curvature = {res1.kappa[-1]:.4e}\")"
    ]
@@ -479,7 +489,7 @@
    "metadata": {},
    "outputs": [],
    "source": [
-    "res2.plot_results(fmt=\"x-\")\n",
+    "res2.plot_results()\n",
     "print(f\"Number of calculations = {len(res2.kappa)}\")\n",
     "print(f\"Failure curvature = {res2.kappa[-1]:.4e}\")"
    ]
@@ -529,7 +539,7 @@
    "metadata": {},
    "outputs": [],
    "source": [
-    "res3.plot_results(fmt=\"x-\")\n",
+    "res3.plot_results()\n",
     "print(f\"Number of calculations = {len(res3.kappa)}\")\n",
     "print(f\"Failure curvature = {res3.kappa[-1]:.4e}\")"
    ]
@@ -670,6 +680,9 @@
     "    moment_curvature_results=[res_n0, res_n1, res_nt],\n",
     "    labels=[\"$N=0$ kN\", \"$N=0.2f'cA_g$\", \"$N=-1000$ kN\"],\n",
     "    fmt=\"-\",\n",
+    "    eng=True,\n",
+    "    m_scale=1e-6,\n",
+    "    m_unit=\"kN.m\",\n",
     ")"
    ]
   },

docs/examples/moment_interaction.ipynb

@@ -148,7 +148,7 @@
    "metadata": {},
    "outputs": [],
    "source": [
-    "mi_res.plot_diagram()"
+    "mi_res.plot_diagram(eng=True, n_unit=\"N\", m_unit=\"N.mm\")"
    ]
   },
   {
@@ -167,7 +167,13 @@
    "outputs": [],
    "source": [
     "mi_res = conc_sec.moment_interaction_diagram(theta=np.pi / 2, progress_bar=False)\n",
-    "mi_res.plot_diagram(moment=\"m_y\")"
+    "mi_res.plot_diagram(\n",
+    "    moment=\"m_y\",\n",
+    "    n_scale=1e-3,\n",
+    "    m_scale=1e-6,\n",
+    "    n_unit=\"kN\",\n",
+    "    m_unit=\"kN.m\",\n",
+    ")"
    ]
   },
   {
@@ -222,7 +228,13 @@
    "source": [
     "# plot all the diagrams on one image\n",
     "MomentInteractionResults.plot_multiple_diagrams(\n",
-    "    moment_interaction_results=mi_results, labels=labels, fmt=\"-\"\n",
+    "    moment_interaction_results=mi_results,\n",
+    "    labels=labels,\n",
+    "    fmt=\"-\",\n",
+    "    n_scale=1e-3,\n",
+    "    m_scale=1e-6,\n",
+    "    n_unit=\"kN\",\n",
+    "    m_unit=\"kN.m\",\n",
     ")"
    ]
   },
@@ -265,6 +277,9 @@
     "    moment_interaction_results=[mi_res_pos, mi_res_neg],\n",
     "    labels=[\"Positive\", \"Negative\"],\n",
     "    fmt=\"-\",\n",
+    "    eng=True,\n",
+    "    n_unit=\"N\",\n",
+    "    m_unit=\"N.mm\",\n",
     ")"
    ]
   },
@@ -380,7 +395,16 @@
    "source": [
     "import matplotlib.pyplot as plt\n",
     "\n",
-    "ax = mi_res.plot_diagram(fmt=\"-kx\", labels=True, label_offset=True, render=False)\n",
+    "ax = mi_res.plot_diagram(\n",
+    "    fmt=\"-kx\",\n",
+    "    labels=True,\n",
+    "    label_offset=True,\n",
+    "    n_scale=1e-3,\n",
+    "    m_scale=1e-6,\n",
+    "    n_unit=\"kN\",\n",
+    "    m_unit=\"kN.m\",\n",
+    "    render=False,\n",
+    ")\n",
     "\n",
     "# reset axis limits to ensure labels are within plot\n",
     "ax.set_xlim(-20, 850)\n",

src/concreteproperties/design_codes/as3600.py

@@ -1,5 +1,6 @@
 """AS3600 class for designing to the Australian Standard AS 3600:2018."""
 
+# TODO: have built in options for result classes that can be set by codes!!
 from __future__ import annotations
 
 from copy import deepcopy

src/concreteproperties/post.py

@@ -138,4 +138,21 @@ def string_formatter(
         return val_fmt
 
 
-# TODO: FuncFormatter for plots
+def string_formatter_plots(
+    value: float,
+    prec: int,
+) -> str:
+    """Formats a float using engineering notation for plotting.
+
+    Args:
+        value: Number to format
+        prec: The desired precision (i.e. one plus this value is the desired number of
+            digits)
+
+    Returns:
+        Formatted string
+    """
+    q = Quantity(value)
+    return q.render(
+        form="eng", show_units=False, prec=prec, strip_zeros=True, strip_radix=True
+    )