geolysis 0.10.3__py3-none-any.whl → 0.11.0__py3-none-any.whl

geolysis/__init__.py

@@ -1,5 +1,5 @@
 from . import bearing_capacity, foundation, soil_classifier, spt
 
-__version__ = "0.10.3"
+__version__ = "0.11.0"
 
 __all__ = ["foundation", "soil_classifier", "spt", "bearing_capacity"]

geolysis/bearing_capacity/abc/__init__.py

@@ -10,12 +10,12 @@ from ._cohl import (
 )
 
 __all__ = [
-    "create_abc_4_cohesionless_soils",
-    "ABCType",
     "BowlesABC4PadFoundation",
     "BowlesABC4MatFoundation",
     "MeyerhofABC4PadFoundation",
     "MeyerhofABC4MatFoundation",
     "TerzaghiABC4PadFoundation",
     "TerzaghiABC4MatFoundation",
+    "ABCType",
+    "create_abc_4_cohesionless_soils",
 ]

geolysis/bearing_capacity/abc/_cohl/_core.py

@@ -42,7 +42,8 @@ class AllowableBearingCapacity(ABC):
     @tol_settlement.setter
     @validate_func_args
     def tol_settlement(
-            self, tol_settlement: Annotated[float, MustBeLessThanOrEqual(25.4)]
+            self,
+            tol_settlement: Annotated[float, MustBeLessThanOrEqual(25.4)],
     ):
         self._tol_settlement = tol_settlement
 
@@ -57,6 +58,12 @@ class AllowableBearingCapacity(ABC):
         return min(1.0 + 0.33 * depth / width, 1.33)
 
     def bearing_capacity_results(self) -> dict:
+        """Return a dictionary of bearing capacity results with
+        intermediate calculations.
+
+        !!! info "Added in v0.11.0"
+
+        """
         return {
             "bearing_capacity": self.bearing_capacity(),
             "depth_factor": self._fd(),

geolysis/bearing_capacity/abc/_cohl/bowles_abc.py

@@ -8,27 +8,8 @@ class BowlesABC4PadFoundation(AllowableBearingCapacity):
     r"""Allowable bearing capacity for pad foundation on cohesionless
     soils according to `Bowles (1997)`.
 
-    $$
-     q_a(kPa) = 19.16(N_1)_{55} f_d\left(\dfrac{S}{25.4}\right),
-                \ B \ \le \ 1.2m
-     $$
-
-     $$
-     q_a(kPa) = 11.98(N_1)_{55}\left(\dfrac{3.28B + 1}{3.28B} \right)^2
-                     f_d \left(\dfrac{S}{25.4}\right), \ B \ \gt 1.2m
-     $$
-
-     $$
-     f_d = 1 + 0.33 \cdot \frac{D_f}{B} \le 1.33
-     $$
-
-    - $q_a$ (kPa): Allowable bearing capacity
-    - $N$: Corrected SPT N-value
-    - $f_d$: Depth factor
-    - $S$ (mm): Tolerable settlement
-    - $B$ (m): Width of foundation footing
-    - $D_f$ (m): Depth of foundation footing
-    - $D_w$ (m): Depth of water below ground level
+    See [implementation](../formulas/allowable-bearing-capacity.md/#bowles-bearing-capacity-for-pad-foundation)
+    for more details on bearing capacity equation used.
 
     """
 
@@ -77,21 +58,9 @@ class BowlesABC4MatFoundation(BowlesABC4PadFoundation):
     r"""Allowable bearing capacity for mat foundation on cohesionless
     soils according to `Bowles (1997)`.
 
-    $$
-     q_a(kPa) = 11.98(N_1)_{55}f_d\left(\dfrac{S}{25.4}\right)
-    $$
-
-    $$
-    f_d = 1 + 0.33 \cdot \frac{D_f}{B} \le 1.33
-    $$
+    See [implementation](../formulas/allowable-bearing-capacity.md/#bowles-bearing-capacity-for-mat-foundation)
+    for more details on bearing capacity equation used.
 
-    - $q_a$ (kPa): Allowable bearing capacity
-    - $N$: Corrected SPT N-value
-    - $f_d$: Depth factor
-    - $S$ (mm): Tolerable settlement
-    - $B$ (m): Width of foundation footing
-    - $D_f$ (m): Depth of foundation footing
-    - $D_w$ (m): Depth of water below ground level
     """
 
     @round_(ndigits=2)

geolysis/bearing_capacity/abc/_cohl/meyerhof_abc.py

@@ -5,29 +5,11 @@ from ._core import AllowableBearingCapacity
 
 
 class MeyerhofABC4PadFoundation(AllowableBearingCapacity):
-    r"""Allowable bearing capacity for pad foundation on cohesionless
+    """Allowable bearing capacity for pad foundation on cohesionless
     soils according to `Meyerhof (1956)`.
 
-    $$
-     q_a(kPa) = 12N f_d\left(\dfrac{S}{25.4}\right), \ B \ \le 1.2m
-     $$
-
-     $$
-     q_a(kPa) = 8N\left(\dfrac{3.28B + 1}{3.28B} \right)^2 f_d\left(
-                \dfrac{S}{25.4}\right), \ B \ \gt 1.2m
-     $$
-
-     $$
-     f_d = 1 + 0.33 \cdot \frac{D_f}{B} \le 1.33
-     $$
-
-    - $q_a$ (kPa): Allowable bearing capacity
-    - $N$: Corrected SPT N-value
-    - $f_d$: Depth factor
-    - $S$ (mm): Tolerable settlement
-    - $B$ (m): Width of foundation footing
-    - $D_f$ (m): Depth of foundation footing
-    - $D_w$ (m): Depth of water below ground level
+    See [implementation](../formulas/allowable-bearing-capacity.md/#meyerhof-bearing-capacity-for-pad-foundation)
+    for more details on bearing capacity equation used.
 
     """
 
@@ -73,24 +55,12 @@ class MeyerhofABC4PadFoundation(AllowableBearingCapacity):
 
 
 class MeyerhofABC4MatFoundation(MeyerhofABC4PadFoundation):
-    r"""Allowable bearing capacity for mat foundation on cohesionless
+    """Allowable bearing capacity for mat foundation on cohesionless
     soils according to `Meyerhof (1956)`.
 
-    $$
-     q_a(kPa) = 8 N f_d\left(\dfrac{S}{25.4}\right)
-    $$
-
-    $$
-     f_d = 1 + 0.33 \cdot \frac{D_f}{B} \le 1.33
-    $$
+    See [implementation](../formulas/allowable-bearing-capacity.md/#meyerhof-bearing-capacity-for-mat-foundation)
+    for more details on bearing capacity equation used.
 
-    - $q_a$ (kPa): Allowable bearing capacity
-    - $N$: Corrected SPT N-value
-    - $f_d$: Depth factor
-    - $S$ (mm): Tolerable settlement
-    - $B$ (m): Width of foundation footing
-    - $D_f$ (m): Depth of foundation footing
-    - $D_w$ (m): Depth of water below ground level
     """
 
     @round_(ndigits=2)

geolysis/bearing_capacity/abc/_cohl/terzaghi_abc.py

@@ -5,39 +5,11 @@ from ._core import AllowableBearingCapacity
 
 
 class TerzaghiABC4PadFoundation(AllowableBearingCapacity):
-    r"""Allowable bearing capacity for pad foundation on cohesionless
+    """Allowable bearing capacity for pad foundation on cohesionless
     soils according to `Terzaghi & Peck (1948)`.
 
-    $$
-     q_a(kPa) = 12N \dfrac{1}{c_w f_d}\left(\dfrac{S}{25.4}\right),
-                 \ B \ \le 1.2m
-    $$
-
-    $$
-     q_a(kPa) = 8N\left(\dfrac{3.28B + 1}{3.28B} \right)^2\dfrac{1}
-                 {c_w f_d}\left(\dfrac{S}{25.4}\right), \ B \ \gt 1.2m
-    $$
-
-    $$
-     f_d = 1 + 0.25 \cdot \frac{D_f}{B} \le 1.25
-    $$
-
-    $$
-     c_w = 2 - \frac{D_w}{2B} \le 2, D_w \gt D_f
-    $$
-
-    $$
-     c_w = 2 - \frac{D_f}{2B} \le 2, D_w \le D_f
-    $$
-
-    - $q_a$ (kPa): Allowable bearing capacity
-    - $N$: Corrected SPT N-value
-    - $f_d$: Depth factor
-    - $c_w$: Water correction factor
-    - $S$ (mm): Tolerable settlement
-    - $B$ (m): Width of foundation footing
-    - $D_f$ (m): Depth of foundation footing
-    - $D_w$ (m): Depth of water below ground level
+    See [implementation](../formulas/allowable-bearing-capacity.md/#terzaghi-bearing-capacity-for-pad-foundation)
+    for more details on bearing capacity equation used.
 
     """
 
@@ -110,33 +82,12 @@ class TerzaghiABC4PadFoundation(AllowableBearingCapacity):
 
 
 class TerzaghiABC4MatFoundation(TerzaghiABC4PadFoundation):
-    r"""Allowable bearing capacity for mat foundation on cohesionless
+    """Allowable bearing capacity for mat foundation on cohesionless
     soils according to `Terzaghi & Peck (1948)`.
 
-    $$
-     q_a(kPa) = 8N\dfrac{1}{c_w f_d}\left(\dfrac{S}{25.4}\right)
-    $$
-
-    $$
-     f_d = 1 + 0.25 \cdot \frac{D_f}{B} \le 1.25
-    $$
-
-    $$
-     c_w = 2 - \frac{D_w}{2B} \le 2, D_w \gt D_f
-    $$
-
-    $$
-     c_w = 2 - \frac{D_f}{2B} \le 2, D_w \le D_f
-    $$
-
-    - $q_a$ (kPa): Allowable bearing capacity
-    - $N$: Corrected SPT N-value
-    - $f_d$: Depth factor
-    - $c_w$: Water correction factor
-    - $S$ (mm): Tolerable settlement
-    - $B$ (m): Width of foundation footing
-    - $D_f$ (m): Depth of foundation footing
-    - $D_w$ (m): Depth of water below ground level
+    See [implementation](../formulas/allowable-bearing-capacity.md/#terzaghi-bearing-capacity-for-mat-foundation)
+    for more details on bearing capacity equation used.
+
     """
 
     @round_(ndigits=2)

geolysis/bearing_capacity/ubc/__init__.py

@@ -16,13 +16,13 @@ from ._terzaghi_ubc import (
 from ._vesic_ubc import VesicUltimateBearingCapacity
 
 __all__ = [
-    "UBCType",
     "TerzaghiUBC4StripFooting",
     "TerzaghiUBC4CircularFooting",
     "TerzaghiUBC4RectangularFooting",
     "TerzaghiUBC4SquareFooting",
     "HansenUltimateBearingCapacity",
     "VesicUltimateBearingCapacity",
+    "UBCType",
     "create_ubc_4_all_soil_types",
 ]
 
@@ -46,18 +46,18 @@ class UBCType(AbstractStrEnum):
 
 @validate_func_args
 def create_ubc_4_all_soil_types(
-        friction_angle: float,
-        cohesion: float,
-        moist_unit_wgt: float,
-        depth: float,
-        width: float,
-        length: Optional[float] = None,
-        eccentricity: float = 0.0,
-        ground_water_level: Optional[float] = None,
-        load_angle: float = 0.0,
-        apply_local_shear: bool = False,
-        shape: Shape | str = "square",
-        ubc_type: Annotated[UBCType | str, MustBeMemberOf(UBCType)] = "hansen",
+    friction_angle: float,
+    cohesion: float,
+    moist_unit_wgt: float,
+    depth: float,
+    width: float,
+    length: Optional[float] = None,
+    eccentricity: float = 0.0,
+    ground_water_level: Optional[float] = None,
+    load_angle: float = 0.0,
+    apply_local_shear: bool = False,
+    shape: Shape | str = "square",
+    ubc_type: Annotated[UBCType | str, MustBeMemberOf(UBCType)] = "hansen",
 ) -> UltimateBearingCapacity:
     r"""A factory function that encapsulate the creation of ultimate
     bearing capacity.
@@ -101,8 +101,7 @@ def create_ubc_4_all_soil_types(
         shape=shape,
     )
 
-    ubc_class = _get_ultimate_bearing_capacity(ubc_type,
-                                               fnd_size.footing_shape)
+    ubc_class = _get_ultimate_bearing_capacity(ubc_type, fnd_size.footing_shape)
 
     return ubc_class(
         friction_angle=friction_angle,

geolysis/bearing_capacity/ubc/_core.py

@@ -21,22 +21,6 @@ class UltimateBearingCapacity(ABC):
             apply_local_shear: bool = False,
     ) -> None:
         r"""
-
-        $$
-        q_u = cN_c s_c d_c i_c + qN_q s_q d_q i_q
-              + 0.5 \gamma B N_{\gamma} s_{\gamma} d_{\gamma} i_{\gamma}
-        $$
-
-        - $q_u$ (kPa): Ultimate bearing capacity
-        - $c$ (kPa): Cohesion of soil
-        - $q$ (kPa): Overburden pressure of soil
-        - $\gamma$ (kN/m³): Unit weight of soil
-        - $B$ (m): Width of foundation footing
-        - $N_c$, $N_q$, $N_{\gamma}$: Bearing capacity factors
-        - $s_c$, $s_q$, $s_{\gamma}$: Shape factors
-        - $d_c$, $d_q$, $d_{\gamma}$: Depth factors
-        - $i_c$, $i_q$, $i_{\gamma}$: Inclination factors
-
         :param friction_angle: Internal angle of friction for general
                                shear failure (degrees).
         :param cohesion: Cohesion of soil ($kPa$).
@@ -196,6 +180,12 @@ class UltimateBearingCapacity(ABC):
         )
 
     def bearing_capacity_results(self) -> dict:
+        """Return a dictionary of bearing capacity results with
+        intermediate calculations.
+
+        !!! info "Added in v0.11.0"
+
+        """
         return {
             "bearing_capacity": self.bearing_capacity(),
             "n_c": self.n_c,

geolysis/bearing_capacity/ubc/_hansen_ubc.py

@@ -14,21 +14,22 @@ class HansenBearingCapacityFactors:
         if isclose(friction_angle, 0.0):
             return 5.14
         return cot(friction_angle) * (
-            HansenBearingCapacityFactors.n_q(friction_angle) - 1.0
+                HansenBearingCapacityFactors.n_q(friction_angle) - 1.0
         )
 
     @staticmethod
     @round_(ndigits=2)
     def n_q(friction_angle: float) -> float:
-        return tan(45.0 + friction_angle / 2.0) ** 2.0 * exp(pi * tan(friction_angle))
+        return tan(45.0 + friction_angle / 2.0) ** 2.0 * exp(
+            pi * tan(friction_angle))
 
     @staticmethod
     @round_(ndigits=2)
     def n_gamma(friction_angle: float) -> float:
         return (
-            1.8
-            * (HansenBearingCapacityFactors.n_q(friction_angle) - 1.0)
-            * tan(friction_angle)
+                1.8
+                * (HansenBearingCapacityFactors.n_q(friction_angle) - 1.0)
+                * tan(friction_angle)
         )
 
 
@@ -90,10 +91,10 @@ class HansenInclinationFactors:
     @staticmethod
     @round_(ndigits=2)
     def i_c(
-        cohesion: float,
-        load_angle: float,
-        f_width: float,
-        f_length: float,
+            cohesion: float,
+            load_angle: float,
+            f_width: float,
+            f_length: float,
     ) -> float:
         return 1.0 - sin(load_angle) / (2.0 * cohesion * f_width * f_length)
 
@@ -109,142 +110,68 @@ class HansenInclinationFactors:
 
 
 class HansenUltimateBearingCapacity(UltimateBearingCapacity):
-    r"""Ultimate bearing capacity for soils according to `Hansen (1961)`."""
+    r"""Ultimate bearing capacity for soils according to `Hansen (1961)`.
+
+    See [implementation](../formulas/ultimate-bearing-capacity.md/#hansen-bearing-capacity)
+    for more details on bearing capacity equation used.
+
+    """
 
     @property
     def n_c(self) -> float:
-        r"""Bearing capacity factor $N_c$.
-
-        $$
-        N_c = \cot(\phi) \left(N_q - 1\right)
-        $$
-        """
+        r"""Bearing capacity factor $N_c$."""
         return HansenBearingCapacityFactors.n_c(self.friction_angle)
 
     @property
     def n_q(self) -> float:
-        r"""Bearing capacity factor $N_q$.
-
-        $$
-        N_q = \tan^2\left(45 + \frac{\phi}{2}\right) \cdot e^{\pi \tan(\phi)}
-        $$
-        """
+        r"""Bearing capacity factor $N_q$."""
         return HansenBearingCapacityFactors.n_q(self.friction_angle)
 
     @property
     def n_gamma(self) -> float:
-        r"""Bearing capacity factor $N_{\gamma}$.
-
-        $$
-        N_{\gamma} = 1.8 \left(N_q - 1\right) \tan(\phi)
-        $$
-        """
+        r"""Bearing capacity factor $N_{\gamma}$."""
         return HansenBearingCapacityFactors.n_gamma(self.friction_angle)
 
     @property
     def s_c(self) -> float:
-        r"""Shape factor $S_c$.
-
-        $$
-        s_c = 1.0 \rightarrow \text{Strip footing}
-        $$
-
-        $$
-        s_c = 1.0 + 0.2 \frac{B}{L} \rightarrow \text{Rectangular footing}
-        $$
-
-        $$
-        s_c = 1.3 \rightarrow \text{Square or circular footing}
-        $$
-        """
+        r"""Shape factor $S_c$."""
         width, length, shape = self.foundation_size.footing_params()
         return HansenShapeFactors.s_c(width, length, shape)
 
     @property
     def s_q(self) -> float:
-        r"""Shape factor $S_q$.
-
-        $$
-        s_q = 1.0 \rightarrow \text{Strip footing}
-        $$
-
-        $$
-        s_q = 1.0 + 0.2 \cdot \frac{B}{L} \rightarrow \text{Rectangular footing}
-        $$
-
-        $$
-        s_q = 1.2 \rightarrow \text{Square or circular footing}
-        $$
-        """
+        r"""Shape factor $S_q$."""
         width, length, shape = self.foundation_size.footing_params()
         return HansenShapeFactors.s_q(width, length, shape)
 
     @property
     def s_gamma(self) -> float:
-        r"""Shape factor $S_{\gamma}$.
-
-        $$
-        s_{\gamma} = 1.0 \rightarrow \text{Strip footing}
-        $$
-
-        $$
-        s_{\gamma} = 1.0 - 0.4 \frac{B}{L} \rightarrow
-                      \text{Rectangular footing}
-        $$
-
-        $$
-        s_{\gamma} = 0.8 \rightarrow \text{Square footing}
-        $$
-
-        $$
-        s_{\gamma} = 0.6 \rightarrow \text{Circular footing}
-        $$
-        """
+        r"""Shape factor $S_{\gamma}$."""
         width, length, shape = self.foundation_size.footing_params()
         return HansenShapeFactors.s_gamma(width, length, shape)
 
     @property
     def d_c(self) -> float:
-        r"""Depth factor $D_c$.
-
-        $$
-        d_c = 1.0 + 0.35 \cdot \frac{D_f}{B}
-        $$
-        """
+        r"""Depth factor $D_c$."""
         depth = self.foundation_size.depth
         width = self.foundation_size.width
         return HansenDepthFactors.d_c(depth, width)
 
     @property
     def d_q(self) -> float:
-        r"""Depth factor $D_q$.
-
-        $$
-        d_q = 1.0 + 0.35 \cdot \frac{D_f}{B}
-        $$
-        """
+        r"""Depth factor $D_q$."""
         depth = self.foundation_size.depth
         width = self.foundation_size.width
         return HansenDepthFactors.d_q(depth, width)
 
     @property
     def d_gamma(self) -> float:
-        r"""Depth factor $D_{\gamma}$.
-
-        $$
-        d_{\gamma} = 1.0
-        $$
-        """
+        r"""Depth factor $D_{\gamma}$."""
         return HansenDepthFactors.d_gamma()
 
     @property
     def i_c(self) -> float:
-        r"""Inclination factor $I_c$.
-
-        $$
-        I_c = 1 - \frac{\sin(\alpha)}{2cBL}
-        $$
-        """
+        r"""Inclination factor $I_c$."""
         width, length = self.foundation_size.width, self.foundation_size.length
         return HansenInclinationFactors.i_c(
             self.cohesion, self.load_angle, width, length
@@ -252,20 +179,10 @@ class HansenUltimateBearingCapacity(UltimateBearingCapacity):
 
     @property
     def i_q(self) -> float:
-        r"""Inclination factor $I_q$.
-
-        $$
-        I_q = 1 - \frac{1.5 \sin(\alpha)}{\cos(\alpha)}
-        $$
-        """
+        r"""Inclination factor $I_q$."""
         return HansenInclinationFactors.i_q(self.load_angle)
 
     @property
     def i_gamma(self) -> float:
-        r"""Inclination factor $I_{\gamma}$.
-
-        $$
-        I_{\gamma} = I_q^2
-        $$
-        """
+        r"""Inclination factor $I_{\gamma}$."""
         return HansenInclinationFactors.i_gamma(self.load_angle)

geolysis/bearing_capacity/ubc/_terzaghi_ubc.py

@@ -52,16 +52,6 @@ class TerzaghiUltimateBearingCapacity(UltimateBearingCapacity, ABC):
             apply_local_shear: bool = False,
     ) -> None:
         r"""
-
-        - $q_u$ (kPa): Ultimate bearing capacity
-        - $c$ (kPa): Cohesion of soil
-        - $q$ (kPa): Overburden pressure of soil
-        - $\gamma$ (kN/m³): Unit weight of soil
-        - $B$ (m): Width of foundation footing
-        - $L$ (m): Length of foundation footing
-        - $N_c$, $N_q$, $N_{\gamma}$: Bearing capacity factors
-
-
         :param friction_angle: Internal angle of friction for general
                                shear failure (degrees).
         :param cohesion: Cohesion of soil ($kPa$).
@@ -81,37 +71,26 @@ class TerzaghiUltimateBearingCapacity(UltimateBearingCapacity, ABC):
 
     @property
     def n_c(self) -> float:
-        r"""Bearing capacity factor $N_c$.
-
-        $$N_c = \cot(\phi) \cdot (N_q - 1)$$
-        """
+        r"""Bearing capacity factor $N_c$."""
         return TerzaghiBearingCapacityFactors.n_c(self.friction_angle)
 
     @property
     def n_q(self) -> float:
-        r"""Bearing capacity factor $N_q$.
-
-        $$
-        N_q = \dfrac{e^{(\frac{3\pi}{2} - \phi)\tan\phi}}
-                    {2\cos^2(45 + \frac{\phi}{2})}
-        $$
-        """
+        r"""Bearing capacity factor $N_q$."""
         return TerzaghiBearingCapacityFactors.n_q(self.friction_angle)
 
     @property
     def n_gamma(self) -> float:
-        r"""Bearing capacity factor $N_{\gamma}$.
-
-        $$N_{\gamma} =  (N_q - 1) \cdot \tan(1.4\phi)$$
-        """
+        r"""Bearing capacity factor $N_{\gamma}$."""
         return TerzaghiBearingCapacityFactors.n_gamma(self.friction_angle)
 
 
 class TerzaghiUBC4StripFooting(TerzaghiUltimateBearingCapacity):
-    r"""Ultimate bearing capacity for strip footing according to
+    """Ultimate bearing capacity for strip footing according to
     `Terzaghi 1943`.
 
-    $$q_u = cN_c + qN_q + 0.5 \gamma BN_{\gamma}$$
+    See [implementation](../formulas/ultimate-bearing-capacity.md/#terzaghi-bearing-capacity-for-strip-footing)
+    for more details on bearing capacity equation used.
     """
 
     @round_(ndigits=2)
@@ -125,10 +104,11 @@ class TerzaghiUBC4StripFooting(TerzaghiUltimateBearingCapacity):
 
 
 class TerzaghiUBC4CircularFooting(TerzaghiUltimateBearingCapacity):
-    r"""Ultimate bearing capacity for circular footing according to
+    """Ultimate bearing capacity for circular footing according to
     `Terzaghi 1943`.
 
-    $$q_u = 1.3cN_c + qN_q + 0.3 \gamma BN_{\gamma}$$
+    See [implementation](../formulas/ultimate-bearing-capacity.md/#terzaghi-bearing-capacity-for-circular-footing)
+    for more details on bearing capacity equation used.
     """
 
     @round_(ndigits=2)
@@ -145,10 +125,8 @@ class TerzaghiUBC4RectangularFooting(TerzaghiUltimateBearingCapacity):
     r"""Ultimate bearing capacity for rectangular footing according to
     `Terzaghi 1943`.
 
-    $$
-    q_u = \left(1 + 0.3 \dfrac{B}{L} \right) c N_c + qN_q
-          + \left(1 - 0.2 \dfrac{B}{L} \right) 0.5 B \gamma N_{\gamma}
-    $$
+    See [implementation](../formulas/ultimate-bearing-capacity.md/#terzaghi-bearing-capacity-for-rectangular-footing)
+    for more details on bearing capacity equation used.
     """
 
     @round_(ndigits=2)
@@ -167,10 +145,11 @@ class TerzaghiUBC4RectangularFooting(TerzaghiUltimateBearingCapacity):
 
 
 class TerzaghiUBC4SquareFooting(TerzaghiUBC4RectangularFooting):
-    r"""Ultimate bearing capacity for square footing according to
+    """Ultimate bearing capacity for square footing according to
     `Terzaghi 1943``.
 
-    $$q_u = 1.3cN_c + qN_q + 0.4 \gamma BN_{\gamma}$$
+    See [implementation](../formulas/ultimate-bearing-capacity.md/#terzaghi-bearing-capacity-for-square-footing)
+    for more details on bearing capacity equation used.
     """
 
     def bearing_capacity(self):

geolysis/bearing_capacity/ubc/_vesic_ubc.py

@@ -22,9 +22,9 @@ class VesicBearingCapacityFactors:
     @round_(ndigits=2)
     def n_gamma(friction_angle: float) -> float:
         return (
-            2.0
-            * (VesicBearingCapacityFactors.n_q(friction_angle) + 1.0)
-            * tan(friction_angle)
+                2.0
+                * (VesicBearingCapacityFactors.n_q(friction_angle) + 1.0)
+                * tan(friction_angle)
         )
 
 
@@ -32,10 +32,10 @@ class VesicShapeFactors:
     @staticmethod
     @round_(ndigits=2)
     def s_c(
-        friction_angle: float,
-        f_width: float,
-        f_length: float,
-        f_shape: Shape,
+            friction_angle: float,
+            f_width: float,
+            f_length: float,
+            f_shape: Shape,
     ) -> float:
         _n_q = VesicBearingCapacityFactors.n_q(friction_angle)
         _n_c = VesicBearingCapacityFactors.n_c(friction_angle)
@@ -50,10 +50,10 @@ class VesicShapeFactors:
     @staticmethod
     @round_(ndigits=2)
     def s_q(
-        friction_angle: float,
-        f_width: float,
-        f_length: float,
-        f_shape: Shape,
+            friction_angle: float,
+            f_width: float,
+            f_length: float,
+            f_shape: Shape,
     ) -> float:
         if f_shape == Shape.STRIP:
             return 1.0
@@ -83,8 +83,9 @@ class VesicDepthFactors:
     @staticmethod
     @round_(ndigits=2)
     def d_q(friction_angle: float, f_depth: float, f_width: float) -> float:
-        return 1.0 + 2.0 * tan(friction_angle) * (1.0 - sin(friction_angle)) ** 2.0 * (
-            f_depth / f_width
+        return 1.0 + 2.0 * tan(friction_angle) * (
+                    1.0 - sin(friction_angle)) ** 2.0 * (
+                f_depth / f_width
         )
 
     @staticmethod
@@ -114,140 +115,74 @@ class VesicInclinationFactors:
 
 
 class VesicUltimateBearingCapacity(UltimateBearingCapacity):
-    """Ultimate bearing capacity for soils according to `Vesic (1973)`."""
+    """Ultimate bearing capacity for soils according to `Vesic (1973)`.
+
+    See [implementation](../formulas/ultimate-bearing-capacity.md/#vesic-bearing-capacity)
+    for more details on bearing capacity equation used.
+    """
 
     @property
     def n_c(self) -> float:
-        r"""Bearing capacity factor $N_c$.
-
-        $$N_c = \cot(\phi) \left(N_q - 1\right)$$
-        """
+        r"""Bearing capacity factor $N_c$."""
         return VesicBearingCapacityFactors.n_c(self.friction_angle)
 
     @property
     def n_q(self) -> float:
-        r"""Bearing capacity factor $N_q$.
-
-        $$
-        N_q = \tan^2\left(45 + \frac{\phi}{2}\right) \cdot
-               e^{\pi \tan(\phi)}
-        $$
-        """
+        r"""Bearing capacity factor $N_q$."""
         return VesicBearingCapacityFactors.n_q(self.friction_angle)
 
     @property
     def n_gamma(self) -> float:
-        r"""Bearing capacity factor $N_{\gamma}$.
-
-        $$N_{\gamma} = 2(N_q + 1) \tan(\phi)$$
-        """
+        r"""Bearing capacity factor $N_{\gamma}$."""
         return VesicBearingCapacityFactors.n_gamma(self.friction_angle)
 
     @property
     def s_c(self) -> float:
-        r"""Shape factor $S_c$.
-
-        $$s_c = 1.0 \rightarrow \text{Strip footing}$$
-
-        $$
-        s_c = 1 + \dfrac{B}{L} \cdot \dfrac{N_q}{N_c} \rightarrow
-                 \text{Rectangular footing}
-        $$
-
-        $$
-        s_c &= 1 + \dfrac{N_q}{N_c} \rightarrow
-                \text{Square or circular footing}
-        $$
-        """
+        r"""Shape factor $S_c$."""
         width, length, shape = self.foundation_size.footing_params()
         return VesicShapeFactors.s_c(self.friction_angle, width, length, shape)
 
     @property
     def s_q(self) -> float:
-        r"""Shape factor $S_q$.
-
-
-        $$s_q = 1.0 \rightarrow \text{Strip footing}$$
-
-        $$
-        s_q = 1 + \dfrac{B}{L} \cdot \tan(\phi) \rightarrow
-                     \text{Rectangular footing}
-        $$
-
-        $$
-        s_q = 1 + \tan(\phi) \rightarrow \text{Square or circular footing}
-        $$
-        """
+        r"""Shape factor $S_q$."""
         width, length, shape = self.foundation_size.footing_params()
         return VesicShapeFactors.s_q(self.friction_angle, width, length, shape)
 
     @property
     def s_gamma(self) -> float:
-        r"""Shape factor $S_{\gamma}$.
-
-        $$s_{\gamma} = 1.0 \rightarrow \text{Strip footing}$$
-
-        $$
-        s_{\gamma} = 1.0 - 0.4 \dfrac{B}{L} \rightarrow
-                        \text{Rectangular footing}
-        $$
-
-        $$
-        s_{\gamma} = 0.6 \rightarrow \text{Square or circular footing}
-        $$
-        """
+        r"""Shape factor $S_{\gamma}$."""
         width, length, shape = self.foundation_size.footing_params()
         return VesicShapeFactors.s_gamma(width, length, shape)
 
     @property
     def d_c(self) -> float:
-        r"""Depth factor $D_c$.
-
-        $$d_c = 1 + 0.4 \dfrac{D_f}{B}$$
-        """
+        r"""Depth factor $D_c$."""
         depth, width = self.foundation_size.depth, self.foundation_size.width
         return VesicDepthFactors.d_c(depth, width)
 
     @property
     def d_q(self) -> float:
-        r"""Depth factor $D_q$.
-
-        $$
-        d_q = 1 + 2 \tan(\phi) \cdot (1 - \sin(\phi))^2
-              \cdot \dfrac{D_f}{B}
-        $$
-        """
+        r"""Depth factor $D_q$."""
         depth, width = self.foundation_size.depth, self.foundation_size.width
         return VesicDepthFactors.d_q(self.friction_angle, depth, width)
 
     @property
     def d_gamma(self) -> float:
-        r"""Depth factor $D_{\gamma}$.
-
-        $$d_{\gamma} = 1.0$$
-        """
+        r"""Depth factor $D_{\gamma}$."""
         return VesicDepthFactors.d_gamma()
 
     @property
     def i_c(self) -> float:
-        r"""Inclination factor $I_c$.
-
-        $$i_c = (1 - \dfrac{\alpha}{90})^2$$
-        """
+        r"""Inclination factor $I_c$."""
         return VesicInclinationFactors.i_c(self.load_angle)
 
     @property
     def i_q(self) -> float:
-        r"""Inclination factor $I_q$.
-
-        $$i_q = (1 - \dfrac{\alpha}{90})^2$$
-        """
+        r"""Inclination factor $I_q$."""
         return VesicInclinationFactors.i_q(self.load_angle)
 
     @property
     def i_gamma(self) -> float:
-        r"""Inclination factor $I_{\gamma}$.
-
-        $$i_{\gamma} = \left(1 - \dfrac{\alpha}{\phi} \right)^2$$
-        """
-        return VesicInclinationFactors.i_gamma(self.friction_angle, self.load_angle)
+        r"""Inclination factor $I_{\gamma}$."""
+        return VesicInclinationFactors.i_gamma(self.friction_angle,
+                                               self.load_angle)

geolysis/soil_classifier.py

@@ -35,8 +35,7 @@ class _Clf(tuple, enum.Enum):
 
 
 class USCSSymbol(_Clf):
-    """
-    Unified Soil Classification System (USCS) symbols and descriptions.
+    """Unified Soil Classification System (USCS) symbols and descriptions.
 
     Each member represents a USCS soil type, grading, or plasticity symbol.
     Aliases are provided where applicable.

geolysis/spt.py

@@ -413,22 +413,11 @@ class OPC:
 
     @round_(ndigits=1)
     def corrected_spt_n_value(self) -> float:
-        r"""Corrected SPT N-value.
-
-        $$
-        (N_1)_{60} = C_N \cdot N_{60}
-        $$
-
-        !!! note
-
-            `60` is used in this case to represent `60%` hammer
-             efficiency and can be any percentage of hammer efficiency
-             e.g. $N_{55}$ for `55%` hammer efficiency.
-        """
-        corrected_spt = self.correction() * self.std_spt_n_value
+        r"""Corrected SPT N-value."""
         # Corrected SPT should not be more
         # than 2 times the Standardized SPT
-        return min(corrected_spt, 2 * self.std_spt_n_value)
+        correction = min(self.correction(), 2.0)
+        return correction * self.std_spt_n_value
 
     @abstractmethod
     def correction(self) -> float:
@@ -452,17 +441,7 @@ class GibbsHoltzOPC(OPC):
         self._eop = val
 
     def correction(self) -> float:
-        r"""SPT Correction.
-
-        $$
-        C_N = \dfrac{350}{\sigma_o + 70} \, \sigma_o \le 280kN/m^2
-        $$
-
-        $\frac{N_c}{N_{60}}$ should lie between 0.45 and 2.0, if
-        $\frac{N_c}{N_{60}}$ is greater than 2.0, :math:`N_c` should be
-        divided by 2.0 to obtain the design value used in finding the
-        bearing capacity of the soil.
-        """
+        r"""SPT Correction."""
         corr = 350.0 / (self.eop + 70.0)
         return corr / 2.0 if corr > 2.0 else corr
 
@@ -476,22 +455,7 @@ class BazaraaPeckOPC(OPC):
     STD_PRESSURE: Final = 71.8
 
     def correction(self) -> float:
-        r"""SPT Correction.
-
-        $$
-        C_N = \dfrac{4}{1 + 0.0418 \cdot \sigma_o}, \,
-              \sigma_o \lt 71.8kN/m^2
-        $$
-
-        $$
-        C_N = \dfrac{4}{3.25 + 0.0104 \cdot \sigma_o},
-               \, \sigma_o \gt 71.8kN/m^2
-        $$
-
-        $$
-        C_N = 1 \, , \, \sigma_o = 71.8kN/m^2
-        $$
-        """
+        r"""SPT Correction."""
         if isclose(self.eop, self.STD_PRESSURE, rel_tol=0.01):
             corr = 1.0
         elif self.eop < self.STD_PRESSURE:
@@ -517,12 +481,7 @@ class PeckOPC(OPC):
         self._eop = val
 
     def correction(self) -> float:
-        r"""SPT Correction.
-
-        $$
-        C_N = 0.77 \log \left(\dfrac{2000}{\sigma_o} \right)
-        $$
-        """
+        r"""SPT Correction."""
         return 0.77 * log10(2000.0 / self.eop)
 
 
@@ -532,12 +491,7 @@ class LiaoWhitmanOPC(OPC):
     """
 
     def correction(self) -> float:
-        r"""SPT Correction.
-
-        $$
-        C_N = \sqrt{\dfrac{100}{\sigma_o}}
-        $$
-        """
+        r"""SPT Correction."""
         return sqrt(100.0 / self.eop)
 
 
@@ -545,12 +499,7 @@ class SkemptonOPC(OPC):
     """Overburden Pressure Correction according to `Skempton (1986)`."""
 
     def correction(self) -> float:
-        r"""SPT Correction.
-
-        $$
-        C_N = \dfrac{2}{1 + 0.01044 \cdot \sigma_o}
-        $$
-        """
+        r"""SPT Correction."""
         return 2.0 / (1.0 + 0.01044 * self.eop)
 
 
@@ -587,25 +536,14 @@ class DilatancyCorrection:
 
     @round_(ndigits=1)
     def corrected_spt_n_value(self) -> float:
-        r"""Corrected SPT N-value.
-
-        $$
-        (N_1)_{60} = 15 + \dfrac{1}{2}((N_1)_{60} - 15) \, , \,
-                     (N_1)_{60} \gt 15
-        $$
-
-        $$
-        (N_1)_{60} = (N_1)_{60} \, , \, (N_1)_{60} \le 15
-        $$
-        """
+        r"""Corrected SPT N-value."""
         if self.corr_spt_n_value <= 15.0:
             return self.corr_spt_n_value
         return 15.0 + 0.5 * (self.corr_spt_n_value - 15.0)
 
 
 class OPCType(AbstractStrEnum):
-    """
-    Enumeration of overburden pressure correction (OPC) methods.
+    """Enumeration of overburden pressure correction (OPC) methods.
 
     Each member represents a method used to correct SPT results
     for the effects of overburden pressure in geotechnical design.
@@ -647,9 +585,7 @@ def create_overburden_pressure_correction(
 
     :param std_spt_n_value: SPT N-value standardized for field
                             procedures.
-
     :param eop: Effective overburden pressure ($kPa$).
-
     :param opc_type: Overburden Pressure Correction type to apply.
     """
     opc_type = OPCType(opc_type)

{geolysis-0.10.3.dist-info → geolysis-0.11.0.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: geolysis
-Version: 0.10.3
+Version: 0.11.0
 Summary: geolysis is an opensource software for geotechnical engineering analysis and modeling.
 Author-email: Patrick Boateng <boatengpato.pb@gmail.com>
 License: MIT License

geolysis-0.11.0.dist-info/RECORD

@@ -0,0 +1,22 @@
+geolysis/__init__.py,sha256=ZeA59xkCLwiAA8wj2WyZEBkQlW1_JDu8nNCjTzJq96I,161
+geolysis/foundation.py,sha256=khmZCa8V-UEqp7A4WlIwt8Oy5tVQdT0UsaLMuxEbDQU,12819
+geolysis/soil_classifier.py,sha256=Rv1LiJID4DalpZPT0s0ulOkwR_1aZh2px8k8xpG6w-4,27437
+geolysis/spt.py,sha256=GfFf4j2AilqQCrAOeJJBmk0vXcOCJ8XorUilsC1X13Y,17179
+geolysis/utils.py,sha256=UnfRaz0MXxBxipcyezYMsxl5LuUTPl_kTztNQ94B8gA,2461
+geolysis/bearing_capacity/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+geolysis/bearing_capacity/abc/__init__.py,sha256=nycD68gdA116n2VX5fT_hq7ZZz3CF4OVuU3DIgnlnZw,518
+geolysis/bearing_capacity/abc/_cohl/__init__.py,sha256=M1EBn2WMgtG-Dg-LT7N-OVke6upwL6plqyPCn3ebR0M,4110
+geolysis/bearing_capacity/abc/_cohl/_core.py,sha256=1YeOe2YYUr6UHdaOjNQoy_PcZo8VTdouz-j2kpdEVqU,2094
+geolysis/bearing_capacity/abc/_cohl/bowles_abc.py,sha256=70SCvyxKVtjE-gPO5YxnQ_098mkBBUjjQ3F_BQZYGVY,2448
+geolysis/bearing_capacity/abc/_cohl/meyerhof_abc.py,sha256=mIvqXoMLJ9z7JDEUQYPV1n2Ssn0z6CYL8qFNU2PcKqk,2411
+geolysis/bearing_capacity/abc/_cohl/terzaghi_abc.py,sha256=P6pCmDK-a2ZFL06dTkVUJ2jlE4CGEvgVAk5nToCZqy0,3270
+geolysis/bearing_capacity/ubc/__init__.py,sha256=yaFFsmOb4q88-nfzilOcgYmb1_x2D2Tg2Po3XTKc52g,4483
+geolysis/bearing_capacity/ubc/_core.py,sha256=oXt11GeMRbsRVMC0zNpIQDspb0W4RYKRxOm5K35Po_E,6114
+geolysis/bearing_capacity/ubc/_hansen_ubc.py,sha256=_VmTUD3hlAylNnLWQW0wwhEEz17EM1WPGtfb9LtnrBk,5559
+geolysis/bearing_capacity/ubc/_terzaghi_ubc.py,sha256=Vo1GXBTJWxfE3QZ1u6hMfw1P3VkHGKxlEdvLBr8h-7A,5272
+geolysis/bearing_capacity/ubc/_vesic_ubc.py,sha256=ThyPHXRGbLHyhThMkUUp5ABknYj0K_xkwNiML_Ua0sM,5752
+geolysis-0.11.0.dist-info/licenses/LICENSE.txt,sha256=ap6sMs3lT7ICbEXBhgihwH1BTCVcjmCQkIkwVnil1Ak,1065
+geolysis-0.11.0.dist-info/METADATA,sha256=_03ifJZXSKZAdjP3HoazS_yqhYfueYBmlNRFKLkp7DI,6814
+geolysis-0.11.0.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
+geolysis-0.11.0.dist-info/top_level.txt,sha256=9mnQgOaCRr11dtXff8X-q3FfXjRONd6kHseSy5q2y8g,9
+geolysis-0.11.0.dist-info/RECORD,,

geolysis-0.10.3.dist-info/RECORD

@@ -1,22 +0,0 @@
-geolysis/__init__.py,sha256=5bIKjaVsOXYGZBsGc7vW_34hN_VEYPOV6XU_AD3cR2w,161
-geolysis/foundation.py,sha256=khmZCa8V-UEqp7A4WlIwt8Oy5tVQdT0UsaLMuxEbDQU,12819
-geolysis/soil_classifier.py,sha256=gPOl9Fr18r4aDtVBFK5KdWdsLIvpTLLMTt7YU49noSA,27442
-geolysis/spt.py,sha256=_AWfs5Ho5ScCwPlVDNh6cuhcLOR4-u7Dr7UoagRlDoM,18620
-geolysis/utils.py,sha256=UnfRaz0MXxBxipcyezYMsxl5LuUTPl_kTztNQ94B8gA,2461
-geolysis/bearing_capacity/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-geolysis/bearing_capacity/abc/__init__.py,sha256=QCSni6_QI059y3JF5UU9Gd_wAyVLmVEMR7ajq_EZQRg,518
-geolysis/bearing_capacity/abc/_cohl/__init__.py,sha256=M1EBn2WMgtG-Dg-LT7N-OVke6upwL6plqyPCn3ebR0M,4110
-geolysis/bearing_capacity/abc/_cohl/_core.py,sha256=YhU6wDVaMOxMUGQ0QHKCeD0eHHTj3la_R3iBBF1-hl0,1932
-geolysis/bearing_capacity/abc/_cohl/bowles_abc.py,sha256=AC0OslIUZBxC5ClB0HNvLoVDwnt982l8OGPuxyE2uZ0,3153
-geolysis/bearing_capacity/abc/_cohl/meyerhof_abc.py,sha256=Zf4X6YVrPMH5Sgm0bORbWe4RgfO-jVJBdeRWl8jBRH8,3056
-geolysis/bearing_capacity/abc/_cohl/terzaghi_abc.py,sha256=za5Altz8uzIqY0RJML8FTCIIyRSyHN04j7y80zop6JA,4300
-geolysis/bearing_capacity/ubc/__init__.py,sha256=5EtGLFW0vwCfUGxQDKPQJ687C9AKRlbYEPYb2aY2AgA,4578
-geolysis/bearing_capacity/ubc/_core.py,sha256=GfE0ZzPqC5VJ8PakR5ZiFvsfSwuEYrEzuPOuVdLnz_Q,6570
-geolysis/bearing_capacity/ubc/_hansen_ubc.py,sha256=aVu40WFCtvstWNq3x65Klb9am4UfJq00MtfaJYIwifI,6995
-geolysis/bearing_capacity/ubc/_terzaghi_ubc.py,sha256=U9mt92glUuooXnd_NPOFDpEdG15bTdb_KPPXLu5zjPw,5503
-geolysis/bearing_capacity/ubc/_vesic_ubc.py,sha256=a8TvlJCZ4AMU_YEVE0DEXb_Eo75uVOtOLDg-mC3zYlc,7034
-geolysis-0.10.3.dist-info/licenses/LICENSE.txt,sha256=ap6sMs3lT7ICbEXBhgihwH1BTCVcjmCQkIkwVnil1Ak,1065
-geolysis-0.10.3.dist-info/METADATA,sha256=YwAjtFsVSnX73jsroehg9CdhG9foeHNvMZjZMC2uUtk,6814
-geolysis-0.10.3.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
-geolysis-0.10.3.dist-info/top_level.txt,sha256=9mnQgOaCRr11dtXff8X-q3FfXjRONd6kHseSy5q2y8g,9
-geolysis-0.10.3.dist-info/RECORD,,