reformatted code files using black and isort

Author: patrickboateng

README.md

@@ -85,7 +85,7 @@ $ pip install geolysis
 - **Ultimate Bearing Capacity (UBC)**
 
   ```python
-  from geolysis.bearing_capacity.ubc import create_ubc_4_all_soil_types
+  from geolysis.bearing_capacity.ubc import create_ubc_4_all_soils
   ```
 
 ### Foundation

docs/index.md

@@ -68,7 +68,7 @@ from geolysis.bearing_capacity.abc import create_abc_4_cohesionless_soils
 #### Ultimate Bearing Capacity (UBC)
 
 ```python
-from geolysis.bearing_capacity.ubc import create_ubc_4_all_soil_types
+from geolysis.bearing_capacity.ubc import create_ubc_4_all_soils
 ```
 
 ### Foundation

docs/user_guide/ultimate-bearing-capacity.md

@@ -5,14 +5,14 @@ correlation:
 
 ```python
 
->>> from geolysis.bearing_capacity.ubc import create_ubc_4_all_soil_types
->>> hansen_ubc = create_ubc_4_all_soil_types(friction_angle=20.0,
-...                                          cohesion=20.0,
-...                                          moist_unit_wgt=18.0,
-...                                          depth=1.5,
-...                                          width=2.0,
-...                                          shape="square",
-...                                          ubc_type="vesic")
+>>> from geolysis.bearing_capacity.ubc import create_ubc_4_all_soils
+>>> hansen_ubc = create_ubc_4_all_soils(friction_angle=20.0,
+...                                     cohesion=20.0,
+...                                     moist_unit_wgt=18.0,
+...                                     depth=1.5,
+...                                     width=2.0,
+...                                     shape="square",
+...                                     ubc_type="vesic")
 >>> hansen_ubc.ultimate_bearing_capacity()
 893.2
 

geolysis/bearing_capacity/abc/__init__.py

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

geolysis/bearing_capacity/abc/_cohl/__init__.py

@@ -1,5 +1,5 @@
 import enum
-from typing import Optional, Annotated
+from typing import Annotated, Optional
 
 from func_validator import MustBeMemberOf, validate_params
 

geolysis/bearing_capacity/abc/_cohl/_core.py

@@ -2,11 +2,7 @@
 from dataclasses import dataclass
 from typing import Annotated, Optional
 
-from func_validator import (
-    validate_params,
-    MustBeNonNegative,
-    MustBeLessThanOrEqual,
-)
+from func_validator import MustBeLessThanOrEqual, MustBeNonNegative, validate_params
 
 from geolysis.foundation import Foundation
 from geolysis.utils import round_
@@ -24,10 +20,10 @@ class AllowableBearingCapacity(ABC):
     MAX_TOL_SETTLEMENT = 25.4
 
     def __init__(
-            self,
-            corrected_spt_n_value: float,
-            tol_settlement: float,
-            foundation_size: Foundation,
+        self,
+        corrected_spt_n_value: float,
+        tol_settlement: float,
+        foundation_size: Foundation,
     ) -> None:
         self.corrected_spt_n_value = corrected_spt_n_value
         self.tol_settlement = tol_settlement
@@ -41,8 +37,8 @@ def corrected_spt_n_value(self) -> float:
     @corrected_spt_n_value.setter
     @validate_params
     def corrected_spt_n_value(
-            self,
-            corrected_spt_n_value: Annotated[float, MustBeNonNegative()],
+        self,
+        corrected_spt_n_value: Annotated[float, MustBeNonNegative()],
     ):
         self._corrected_spt_n_value = corrected_spt_n_value
 
@@ -54,10 +50,10 @@ def tol_settlement(self) -> float:
     @tol_settlement.setter
     @validate_params
     def tol_settlement(
-            self,
-            tol_settlement: Annotated[
-                float, MustBeNonNegative(), MustBeLessThanOrEqual(25.4)
-            ],
+        self,
+        tol_settlement: Annotated[
+            float, MustBeNonNegative(), MustBeLessThanOrEqual(25.4)
+        ],
     ):
         self._tol_settlement = tol_settlement
 

geolysis/bearing_capacity/abc/_cohl/terzaghi_abc.py

@@ -1,5 +1,5 @@
 from geolysis.foundation import Foundation
-from geolysis.utils import round_, isinf
+from geolysis.utils import isinf, round_
 
 from ._core import AllowableBearingCapacity, AllowableBearingCapacityResult
 

geolysis/bearing_capacity/ubc/__init__.py

@@ -1,5 +1,5 @@
 import enum
-from typing import Optional, Annotated
+from typing import Annotated, Optional
 
 from func_validator import MustBeMemberOf, validate_params
 
@@ -22,7 +22,7 @@
     "TerzaghiUBC4SquareFooting",
     "VesicUltimateBearingCapacity",
     "UBCType",
-    "create_ubc_4_all_soil_types",
+    "create_ubc_4_all_soils",
 ]
 
 
@@ -52,7 +52,7 @@ class UBCType(AbstractStrEnum):
 
 
 @validate_params
-def create_ubc_4_all_soil_types(
+def create_ubc_4_all_soils(
     friction_angle: float,
     cohesion: float,
     moist_unit_wgt: float,
@@ -98,6 +98,7 @@ def create_ubc_4_all_soil_types(
     :raises ValidationError: Raised when length is not provided for a
                              rectangular footing.
     """
+
     ubc_type = UBCType(ubc_type)
 
     # exception from create_foundation will automatically propagate

geolysis/bearing_capacity/ubc/_core.py

@@ -2,14 +2,10 @@
 from dataclasses import dataclass
 from typing import Annotated
 
-from func_validator import (
-    validate_params,
-    MustBeNonNegative,
-    MustBePositive,
-)
+from func_validator import MustBeNonNegative, MustBePositive, validate_params
 
 from geolysis.foundation import Foundation
-from geolysis.utils import arctandeg, round_, tandeg, isinf
+from geolysis.utils import arctandeg, isinf, round_, tandeg
 
 
 @dataclass(frozen=True, slots=True)
@@ -181,6 +177,7 @@ def _surcharge_term(self) -> float:
         if not isinf(water_level):
             if water_level < depth:
                 d_1 = water_level
+                # d2 is the distance from the footing base to water level
                 d_2 = depth - d_1
                 unit_wgt = self.saturated_unit_wgt - 9.81
                 eop = self.moist_unit_wgt * d_1 + unit_wgt * d_2
@@ -199,6 +196,7 @@ def _embedment_term(self, coef: float = 0.5) -> float:
             if water_level < depth:
                 unit_wgt = wgt
             else:
+                # d is the distance from the footing base to water level
                 d = water_level - depth
                 if d <= width:
                     unit_wgt = wgt + (d / width) * (self.moist_unit_wgt - wgt)

geolysis/bearing_capacity/ubc/_terzaghi_ubc.py

@@ -1,13 +1,5 @@
-from geolysis.utils import (
-    cosdeg,
-    cotdeg,
-    deg2rad,
-    exp,
-    isclose,
-    pi,
-    round_,
-    tandeg,
-)
+from geolysis.utils import cosdeg, cotdeg, deg2rad, exp, isclose, pi, round_, tandeg
+
 from ._core import UltimateBearingCapacity
 
 __all__ = [
@@ -26,7 +18,7 @@ def n_c(friction_angle: float) -> float:
         if isclose(friction_angle, 0.0):
             return 5.7
         return cotdeg(friction_angle) * (
-                TerzaghiBearingCapacityFactors.n_q(friction_angle) - 1.0
+            TerzaghiBearingCapacityFactors.n_q(friction_angle) - 1.0
         )
 
     @staticmethod
@@ -39,8 +31,7 @@ def n_q(friction_angle: float) -> float:
     @staticmethod
     @round_(ndigits=2)
     def n_gamma(friction_angle: float) -> float:
-        return (TerzaghiBearingCapacityFactors.n_q(
-            friction_angle) - 1.0) * tandeg(
+        return (TerzaghiBearingCapacityFactors.n_q(friction_angle) - 1.0) * tandeg(
             1.4 * friction_angle
         )
 
@@ -75,9 +66,9 @@ class TerzaghiUBC4StripFooting(TerzaghiUltimateBearingCapacity):
     def _bearing_capacity(self) -> float:
         """Calculates ultimate bearing capacity for strip footing."""
         return (
-                self._cohesion_term(1.0)
-                + self._surcharge_term()
-                + self._embedment_term(0.5)
+            self._cohesion_term(1.0)
+            + self._surcharge_term()
+            + self._embedment_term(0.5)
         )
 
 
@@ -93,9 +84,9 @@ class TerzaghiUBC4CircularFooting(TerzaghiUltimateBearingCapacity):
     def _bearing_capacity(self) -> float:
         """Calculates ultimate bearing capacity for circular footing."""
         return (
-                self._cohesion_term(1.3)
-                + self._surcharge_term()
-                + self._embedment_term(0.3)
+            self._cohesion_term(1.3)
+            + self._surcharge_term()
+            + self._embedment_term(0.3)
         )
 
 
@@ -110,9 +101,9 @@ class TerzaghiUBC4SquareFooting(TerzaghiUltimateBearingCapacity):
     def _bearing_capacity(self):
         """Calcalates ultimate bearing capacity for square footing."""
         return (
-                self._cohesion_term(1.3)
-                + self._surcharge_term()
-                + self._embedment_term(0.4)
+            self._cohesion_term(1.3)
+            + self._surcharge_term()
+            + self._embedment_term(0.4)
         )
 
 
@@ -133,7 +124,7 @@ def _bearing_capacity(self) -> float:
         emb_coef = (1.0 - 0.2 * (width / length)) / 2.0
 
         return (
-                self._cohesion_term(coh_coef)
-                + self._surcharge_term()
-                + self._embedment_term(emb_coef)
+            self._cohesion_term(coh_coef)
+            + self._surcharge_term()
+            + self._embedment_term(emb_coef)
         )