Merge pull request #473 from Blueprints-org/472-documentation-issue-latex-vs-math-in-chapter-8-12-from-nen-en-1992-1-1-and-all-other-ecs

472 documentation issue latex vs math in all current code

Author: viktor-rick

blueprints/checks/nominal_concrete_cover/nominal_concrete_cover.py

@@ -1,4 +1,4 @@
-"""Calculation of nominal concrete cover from NEN-EN 1992-1-1: Chapter 4 - Durability and cover to reinforcement."""
+r"""Calculation of nominal concrete cover from NEN-EN 1992-1-1: Chapter 4 - Durability and cover to reinforcement."""
 
 from dataclasses import dataclass, field
 from typing import Literal
@@ -28,15 +28,15 @@
 
 @dataclass(frozen=True)
 class NominalConcreteCover:
-    """Class responsible for the calculation of the nominal concrete cover :math:`c_{nom}` [:math:`mm`].
+    r"""Class responsible for the calculation of the nominal concrete cover [$$c_{nom}$$] [$$mm$$].
     It takes considerations of art.4.4.1.2 and 4.4.1.3 into account.
 
     Parameters
     ----------
     reinforcement_diameter: MM
-        The diameter of the reinforcement [:math:`mm`].
+        The diameter of the reinforcement [$$mm$$].
     nominal_max_aggregate_size: MM
-        The nominal maximum aggregate size [:math:`mm`].
+        The nominal maximum aggregate size [$$mm$$].
     constants: ConstantsBase
         The constants for the calculation of the nominal concrete cover.
     structural_class: ConcreteStructuralClassBase | int
@@ -49,16 +49,16 @@ class NominalConcreteCover:
     chloride_seawater: ChlorideSeawater | Literal["XS1", "XS2", "XS3", "NA"]
         The classification of corrosion induced by chlorides from sea water. Default is "Not applicable".
     delta_c_dur_gamma: MM
-        [:math:`Δc_{dur,γ}`] An additional safety requirement based on art. 4.4.1.2 (6) [:math:`mm`].
-        The value of [:math:`Δc_{dur,γ}`] for use in a Country may be found in its National Annex.
-        The recommended value is O mm. 0 mm is the default value in the formula if not specified otherwise.
+        [$$\Delta c_{dur,\gamma}$$] An additional safety requirement based on art. 4.4.1.2 (6) [$$mm$$].
+        The value of [$$\Delta c_{dur,\gamma}$$] for use in a Country may be found in its National Annex.
+        The recommended value is 0 mm. 0 mm is the default value in the formula if not specified otherwise.
     delta_c_dur_st: MM
-        [:math:`Δc_{dur,st}`] A reduction of minimum concrete cover when using stainless steel based on art. 4.4.1.2 (7) [:math:`mm`].
-        The value of [:math:`Δc_{dur,st}`] for use in a Country may be found in its National Annex.
+        [$$\Delta c_{dur,st}$$] A reduction of minimum concrete cover when using stainless steel based on art. 4.4.1.2 (7) [$$mm$$].
+        The value of [$$\Delta c_{dur,st}$$] for use in a Country may be found in its National Annex.
         The recommended value, without further specification, is 0 mm. 0 mm is the default value in the formula if not specified otherwise.
     delta_c_dur_add: MM
-        [:math:`Δc_{dur,add}`] A reduction of minimum concrete cover when using additional protection based on art. 4.4.1.2 (8) [:math:`mm`].
-        The value of [:math:`Δc_{dur,add}`] for use in a Country may be found in its National Annex.
+        [$$\Delta c_{dur,add}$$] A reduction of minimum concrete cover when using additional protection based on art. 4.4.1.2 (8) [$$mm$$].
+        The value of [$$\Delta c_{dur,add}$$] for use in a Country may be found in its National Annex.
         The recommended value, without further specification, is 0 mm. 0 mm is the default value in the formula if not specified otherwise.
     casting_surface: CastingSurface
         The casting surface of the concrete according to art. 4.4.1.3 (4).

blueprints/codes/eurocode/nen_9997_1_c2_2017/chapter_1_general_rules/formula_1_0_1.py

@@ -10,22 +10,22 @@
 
 
 class Form1Dot0Dot1EquivalentPilePointCenterline(Formula):
-    """Class representing formula 1.0.1 for the calculation of the equivalent pile point centerline :math:`D_{eq}` in [m]."""
+    r"""Class representing formula 1.0.1 for the calculation of the equivalent pile point centerline [$$D_{eq}$$] in [$$m$$]."""
 
     label = "1.0.1"
     source_document = NEN_9997_1_C2_2017
 
     def __init__(self, a: M, b: M) -> None:
-        """[:math:`D_{eq}`] Equivalent pile point centerline.
+        r"""[$$D_{eq}$$] Equivalent pile point centerline.
 
         NEN 9997-1+C2:2017 art.1.5.2.106a - Formula (1.0.1)
 
         Parameters
         ----------
         a : M
-            [:math:`a`] minor dimension of the largest cross-section at the pile tip [:math:`m`].
+            [$$a$$] minor dimension of the largest cross-section at the pile tip [$$m$$].
         b : M
-            [:math:`b`] major dimension of the largest cross-section at the pile tip [:math:`m`].
+            [$$b$$] major dimension of the largest cross-section at the pile tip [$$m$$].
 
             Where: b ≤ 1.5 * a
         """

blueprints/codes/eurocode/nen_9997_1_c2_2017/chapter_2_basic_of_geotechnical_design/formula_2_1_a.py

@@ -8,22 +8,22 @@
 
 
 class Form2Dot1aDesignValueLoad(Formula):
-    """Class representing formula 2.1a for the calculation of the design value :math:`F_{d}` of actions."""
+    """Class representing formula 2.1a for the calculation of the design value [$$F_{d}$$] of actions."""
 
     label = "2.1a"
     source_document = NEN_9997_1_C2_2017
 
-    def __init__(self, gamma_f: DIMENSIONLESS, f_rep: float) -> None:
-        """[:math:`F_{d}`] Design value of actions.
+    def __init__(self, gamma_f: DIMENSIONLESS, f_rep: DIMENSIONLESS) -> None:
+        r"""[$$F_{d}$$] Design value of actions.
 
         NEN 9997-1+C2:2017 art.2.4.6.1(2) - (Formula 2.1a)
 
         Parameters
         ----------
         gamma_f : DIMENSIONLESS
-            [:math:`γ_{F}`] partial factor for actions for persistent and transient situations defined in annex A [-].
-        f_rep : float
-            [:math:`F_{rep}`] Representative value of actions.
+            [$$\gamma_{F}$$] partial factor for actions for persistent and transient situations defined in annex A [$$-$$].
+        f_rep : DIMENSIONLESS
+            [$$F_{rep}$$] Representative value of actions.
 
             Use your own implementation for this value or use :class:`Form2Dot1bRepresentativeValue`.
         """
@@ -34,8 +34,8 @@ def __init__(self, gamma_f: DIMENSIONLESS, f_rep: float) -> None:
     @staticmethod
     def _evaluate(
         gamma_f: DIMENSIONLESS,
-        f_rep: float,
-    ) -> float:
+        f_rep: DIMENSIONLESS,
+    ) -> DIMENSIONLESS:
         """Evaluates the formula, for more information see the __init__ method."""
         raise_if_negative(gamma_f=gamma_f)
         return gamma_f * f_rep

blueprints/codes/eurocode/nen_9997_1_c2_2017/chapter_2_basic_of_geotechnical_design/formula_2_1_b.py

@@ -8,22 +8,22 @@
 
 
 class Form2Dot1bRepresentativeValue(Formula):
-    """Class representing formula 2.1b for the calculation of the representative value :math:`F_{rep}` of actions."""
+    """Class representing formula 2.1b for the calculation of the representative value [$$F_{rep}$$] of actions."""
 
     label = "2.1b"
     source_document = NEN_9997_1_C2_2017
 
-    def __init__(self, psi: DIMENSIONLESS, f_k: float) -> None:
-        """[:math:`F_{rep}`] Representative value of actions.
+    def __init__(self, psi: DIMENSIONLESS, f_k: DIMENSIONLESS) -> None:
+        r"""[$$F_{rep}$$] Representative value of actions.
 
         NEN 9997-1+C2:2017 art.2.4.6.1(2) - Formula (2.1b)
 
         Parameters
         ----------
         psi : DIMENSIONLESS
-            [:math:`Ψ`] factor for converting the characteristic value to the representative value [-].
-        f_k : float
-            [:math:`F_{k}`] Characteristic value of actions.
+            [$$\Psi$$] factor for converting the characteristic value to the representative value [$$-$$].
+        f_k : DIMENSIONLESS
+            [$$F_{k}$$] Characteristic value of actions [$$-$$].
         """
         super().__init__()
         self.psi = psi
@@ -32,8 +32,8 @@ def __init__(self, psi: DIMENSIONLESS, f_k: float) -> None:
     @staticmethod
     def _evaluate(
         psi: DIMENSIONLESS,
-        f_k: float,
-    ) -> float:
+        f_k: DIMENSIONLESS,
+    ) -> DIMENSIONLESS:
         """Evaluates the formula, for more information see the __init__ method."""
         raise_if_negative(psi=psi)
         return psi * f_k

blueprints/codes/eurocode/nen_9997_1_c2_2017/chapter_2_basic_of_geotechnical_design/formula_2_2.py

@@ -8,30 +8,30 @@
 
 
 class Form2Dot2DesignValueGeotechnicalParameter(Formula):
-    """Class representing formula 2.2 for the calculation of the design value :math:`X_d` of geotechnical parameter :math:`X`."""
+    """Class representing formula 2.2 for the calculation of the design value [$$X_d$$] of geotechnical parameter [$$X$$]."""
 
     label = "2.2"
     source_document = NEN_9997_1_C2_2017
 
-    def __init__(self, x_k: float, gamma_m: DIMENSIONLESS) -> None:
-        """[:math:`X_d`] Design value of geotechnical parameter [:math:`X`].
+    def __init__(self, x_k: DIMENSIONLESS, gamma_m: DIMENSIONLESS) -> None:
+        r"""[$$X_d$$] Design value of geotechnical parameter [$$X$$].
 
         NEN 9997-1+C2:2017 art.2.4.6.2(1) - Formula (2.2)
 
         Parameters
         ----------
-        x_k : float
-            [:math:`X_{k}`] Characteristic value of geotechnical parameter [:math:`X`].
+        x_k : DIMENSIONLESS
+            [$$X_{k}$$] Characteristic value of geotechnical parameter [$$X$$].
         gamma_m : DIMENSIONLESS
-            [:math:`gamma_M`] material partial factor [-].
+            [$$\gamma_M$$] material partial factor [$$-$$].
         """
         super().__init__()
         self.x_k = x_k
         self.gamma_m = gamma_m
 
     @staticmethod
     def _evaluate(
-        x_k: float,
+        x_k: DIMENSIONLESS,
         gamma_m: DIMENSIONLESS,
     ) -> float:
         """Evaluates the formula, for more information see the __init__ method."""

blueprints/codes/eurocode/nen_9997_1_c2_2017/chapter_2_basic_of_geotechnical_design/formula_2_4.py

@@ -9,30 +9,30 @@
 
 
 class Form2Dot4DesignValueGeotechnicalParameter:
-    """Class representing formula 2.4 for the check of
+    r"""Class representing formula 2.4 for the check of
     the destabilizing load effect
     against the stabilizing load effect and friction resistance
-    :math:`E_{dst;d} ≤ E_{stb;d} + T_d`.
+    [$$E_{dst;d} \leq E_{stb;d} + T_d$$].
     """
 
     label = "2.4"
     source_document = NEN_9997_1_C2_2017
 
     def __init__(self, e_dst_d: KN, e_stb_d: KN, t_d: KN) -> None:
-        """Check of the destabilizing load effect
+        r"""Check of the destabilizing load effect
         against the stabilizing load effect and friction resistance
-        [:math:`E_{dst;d} ≤ E_{stb;d} + T_d`].
+        [$$E_{dst;d} \leq E_{stb;d} + T_d$$].
 
         NEN 9997-1+C2:2017 art.2.4.7.2(1) - Formula (2.4)
 
         Parameters
         ----------
-        E_dst_d : N
-            [:math:`E_dst;d`] Design value of destabilizing load effect.
-        E_stb_d : N
-            [:math:`E_stb;d`] Design value of stabilizing load effect.
-        T_d : N
-            [:math: `T_d`] Design value of friction resistance.
+        E_dst_d : KN
+            [$$E_{dst;d}$$] Design value of destabilizing load effect [$$kN$$].
+        E_stb_d : KN
+            [$$E_{stb;d}$$] Design value of stabilizing load effect [$$kN$$].
+        T_d : KN
+            [$$T_d$$] Design value of friction resistance [$$kN$$].
         """
         self.e_dst_d = e_dst_d
         self.e_stb_d = e_stb_d

blueprints/codes/eurocode/nen_en_1992_1_1_c2_2011/chapter_3_materials/formula_3_1.py

@@ -3,12 +3,12 @@
 from blueprints.codes.eurocode.nen_en_1992_1_1_c2_2011 import NEN_EN_1992_1_1_C2_2011
 from blueprints.codes.formula import Formula
 from blueprints.codes.latex_formula import LatexFormula
-from blueprints.type_alias import MPA
+from blueprints.type_alias import DIMENSIONLESS, MPA
 from blueprints.validations import raise_if_negative
 
 
 class Form3Dot1EstimationConcreteCompressiveStrength(Formula):
-    """Class representing formula 3.1 for the estimation of the concrete compressive strength, fcm(t),  after t days
+    r"""Class representing formula 3.1 for the estimation of the concrete compressive strength, [$$f_{cm}(t)$$], after t days
     with an average temperature of 20 degrees Celsius.
     """
 
@@ -17,19 +17,19 @@ class Form3Dot1EstimationConcreteCompressiveStrength(Formula):
 
     def __init__(
         self,
-        beta_cc_t: float,
+        beta_cc_t: DIMENSIONLESS,
         f_cm: MPA,
     ) -> None:
-        """[fcm(t)] The estimated concrete compressive strength [MPa].
+        r"""[$$f_{cm}(t)$$] The estimated concrete compressive strength [$$MPa$$].
 
         NEN-EN 1992-1-1+C2:2011 art.3.1.2(6) - Formula (3.1)
 
         Parameters
         ----------
-        beta_cc_t : float
-            [βcc(t)] Coefficient dependent of the age of concrete [-].
+        beta_cc_t : DIMENSIONLESS
+            [$$\beta_{cc}(t)$$] Coefficient dependent of the age of concrete [$$-$$].
         f_cm : MPA
-            [fcm] Average concrete compressive strength on day 28 based on table 3.1 [MPa].
+            [$$f_{cm}$$] Average concrete compressive strength on day 28 based on table 3.1 [$$MPa$$].
 
         Returns
         -------
@@ -41,7 +41,7 @@ def __init__(
 
     @staticmethod
     def _evaluate(
-        beta_cc_t: float,
+        beta_cc_t: DIMENSIONLESS,
         f_cm: MPA,
     ) -> MPA:
         """Evaluates the formula, for more information see the __init__ method."""

blueprints/codes/eurocode/nen_en_1992_1_1_c2_2011/chapter_3_materials/formula_3_10.py

@@ -5,7 +5,7 @@
 from blueprints.codes.eurocode.nen_en_1992_1_1_c2_2011 import NEN_EN_1992_1_1_C2_2011
 from blueprints.codes.formula import Formula
 from blueprints.codes.latex_formula import LatexFormula
-from blueprints.type_alias import DAYS, MM, MM2
+from blueprints.type_alias import DAYS, DIMENSIONLESS, MM, MM2
 
 
 class Form3Dot10CoefficientAgeConcreteDryingShrinkage(Formula):
@@ -20,18 +20,18 @@ def __init__(
         t_s: DAYS,
         h_0: MM,
     ) -> None:
-        """[βds(t,ts)] Coefficient for drying shrinkage due to age of concrete [-].
+        r"""[$$\beta_{ds}(t, t_s)$$] Coefficient for drying shrinkage due to age of concrete [$$-$$].
 
         NEN-EN 1992-1-1+C2:2011 art.3.1.4(6) - Formula (3.10)
 
         Parameters
         ----------
         t : DAYS
-            [t] Age in days of the concrete at the considered moment [days].
+            [$$t$$] Age in days of the concrete at the considered moment [$$days$$].
         t_s : DAYS
-            [t] Age in days of the concrete at the start of the drying shrinkage [days].
+            [$$t_s$$] Age in days of the concrete at the start of the drying shrinkage [$$days$$].
         h_0 : MM
-            [h0] fictional thickness of cross-section [mm].
+            [$$h_0$$] fictional thickness of cross-section [$$mm$$].
             = 2 * Ac / u
             Use your own implementation of this formula or use the SubForm3Dot10FictionalCrossSection class.
 
@@ -49,7 +49,7 @@ def _evaluate(
         t: DAYS,
         t_s: DAYS,
         h_0: MM,
-    ) -> float:
+    ) -> DIMENSIONLESS:
         """Evaluates the formula, for more information see the __init__ method."""
         if t <= 0:
             raise ValueError(f"Invalid t: {t}. t cannot be negative or zero")
@@ -83,16 +83,16 @@ def __init__(
         a_c: MM2,
         u: MM,
     ) -> None:
-        """[h0] Fictional thickness of the cross-section [mm].
+        r"""[$$h_0$$] Fictional thickness of the cross-section [$$mm$$].
 
         NEN-EN 1992-1-1+C2:2011 art.3.1.4(6) - h0
 
         Parameters
         ----------
         a_c : MM2
-            [Ac] Area of the cross-section of the concrete [mm²].
+            [$$A_c$$] Area of the cross-section of the concrete [$$mm^2$$].
         u : MM
-            [u] Circumference of part that is subjected to drying [mm].
+            [$$u$$] Circumference of part that is subjected to drying [$$mm$$].
         """
         super().__init__()
         self.a_c = a_c

blueprints/codes/eurocode/nen_en_1992_1_1_c2_2011/chapter_3_materials/formula_3_11.py

@@ -3,6 +3,7 @@
 from blueprints.codes.eurocode.nen_en_1992_1_1_c2_2011 import NEN_EN_1992_1_1_C2_2011
 from blueprints.codes.formula import Formula
 from blueprints.codes.latex_formula import LatexFormula
+from blueprints.type_alias import DIMENSIONLESS
 
 
 class Form3Dot11AutogeneShrinkage(Formula):
@@ -13,21 +14,21 @@ class Form3Dot11AutogeneShrinkage(Formula):
 
     def __init__(
         self,
-        beta_as_t: float,
-        epsilon_ca_inf: float,
+        beta_as_t: DIMENSIONLESS,
+        epsilon_ca_inf: DIMENSIONLESS,
     ) -> None:
-        """[εca(t)] Autogene shrinkage [-].
+        r"""[$$\epsilon_{ca}(t)$$] Autogene shrinkage [$$-$$].
 
         NEN-EN 1992-1-1+C2:2011 art.3.1.4(6) - Formula (3.11)
 
         Parameters
         ----------
-        beta_as_t : float
-            [βas(t)] Coefficient dependent on time in days for autogene shrinkage [-].
+        beta_as_t : DIMENSIONLESS
+            [$$\beta_{as}(t)$$] Coefficient dependent on time in days for autogene shrinkage [$$-$$].
             = 1 - exp(-0.2 * t^0.5)
             Use your own implementation of this formula or use the Form3Dot13CoefficientTimeAutogeneShrinkage class
-        epsilon_ca_inf : float
-            [εca(∞)] Autogene shrinkage at infinity [-].
+        epsilon_ca_inf : DIMENSIONLESS
+            [$$\epsilon_{ca}(\infty)$$] Autogene shrinkage at infinity [$$-$$].
             = 2.5 * (fck - 10) E-6
             Use your own implementation of this formula or use the Form3Dot12AutogeneShrinkageInfinity class.
 
@@ -41,8 +42,8 @@ def __init__(
 
     @staticmethod
     def _evaluate(
-        beta_as_t: float,
-        epsilon_ca_inf: float,
+        beta_as_t: DIMENSIONLESS,
+        epsilon_ca_inf: DIMENSIONLESS,
     ) -> float:
         """Evaluates the formula, for more information see the __init__ method."""
         if beta_as_t < 0: