geolysis 0.16.0__tar.gz → 0.18.0__tar.gz

{geolysis-0.16.0 → geolysis-0.18.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: geolysis
-Version: 0.16.0
+Version: 0.18.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.16.0 → geolysis-0.18.0}/geolysis/__init__.py

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

{geolysis-0.16.0 → geolysis-0.18.0}/geolysis/bearing_capacity/abc/_cohl/_core.py

@@ -4,6 +4,7 @@ from typing import Annotated
 
 from func_validator import (
     validate_params,
+    MustBePositive,
     MustBeNonNegative,
     MustBeLessThanOrEqual,
 )
@@ -25,10 +26,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
@@ -42,8 +43,8 @@ class AllowableBearingCapacity(ABC):
     @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
 
@@ -55,8 +56,9 @@ class AllowableBearingCapacity(ABC):
     @tol_settlement.setter
     @validate_params
     def tol_settlement(
-        self,
-        tol_settlement: Annotated[float, MustBeLessThanOrEqual(25.4)],
+            self,
+            tol_settlement: Annotated[
+                float, MustBePositive, MustBeLessThanOrEqual(25.4)],
     ):
         self._tol_settlement = tol_settlement
 

{geolysis-0.16.0 → geolysis-0.18.0}/geolysis/bearing_capacity/ubc/__init__.py

@@ -59,6 +59,7 @@ def create_ubc_4_all_soil_types(
         depth: float,
         width: float,
         length: Optional[float] = None,
+        factor_of_safety: float = 3.0,
         saturated_unit_wgt: float = 20.5,
         eccentricity: float = 0.0,
         ground_water_level: Optional[float] = inf,
@@ -78,6 +79,7 @@ def create_ubc_4_all_soil_types(
     :param depth: Depth of foundation (m).
     :param width: Width of foundation footing (m).
     :param length: Length of foundation footing (m).
+    :param factor_of_safety: Factor of safety.
     :param saturated_unit_wgt: Saturated unit weight of soil ($kN/m^3$).
     :param eccentricity: The deviation of the foundation load from the
                          center of gravity of the foundation footing.
@@ -118,6 +120,7 @@ def create_ubc_4_all_soil_types(
         friction_angle=friction_angle,
         cohesion=cohesion,
         moist_unit_wgt=moist_unit_wgt,
+        factor_of_safety=factor_of_safety,
         saturated_unit_wgt=saturated_unit_wgt,
         foundation_size=fnd_size,
         apply_local_shear=apply_local_shear,

{geolysis-0.16.0 → geolysis-0.18.0}/geolysis/foundation.py

@@ -191,7 +191,7 @@ class CircularFooting(FootingSize):
 
     def area(self) -> float:
         """Area of circular footing ($m^2$)."""
-        return pi * self.diameter ** 2 / 4
+        return pi * self.diameter**2 / 4
 
 
 @add_repr
@@ -227,7 +227,7 @@ class SquareFooting(FootingSize):
 
     def area(self) -> float:
         """Area of square footing ($m^2$)."""
-        return self.width ** 2
+        return self.width**2
 
 
 @add_repr
@@ -272,13 +272,13 @@ class Foundation:
     """A simple class representing a foundation structure."""
 
     def __init__(
-            self,
-            depth: float,
-            footing_size: FootingSize,
-            eccentricity: float = 0.0,
-            load_angle: float = 0.0,
-            ground_water_level: Optional[float] = inf,
-            foundation_type: FoundationType = FoundationType.PAD,
+        self,
+        depth: float,
+        footing_size: FootingSize,
+        eccentricity: float = 0.0,
+        load_angle: float = 0.0,
+        ground_water_level: Optional[float] = inf,
+        foundation_type: FoundationType = FoundationType.PAD,
     ) -> None:
         r"""
         :param depth: Depth of foundation (m).
@@ -342,8 +342,7 @@ class Foundation:
 
     @eccentricity.setter
     @validate_params
-    def eccentricity(self, eccentricity: Annotated[
-        float, MustBeNonNegative]) -> None:
+    def eccentricity(self, eccentricity: Annotated[float, MustBeNonNegative]) -> None:
         self._eccentricity = eccentricity
 
     @property
@@ -354,9 +353,8 @@ class Foundation:
     @load_angle.setter
     @validate_params
     def load_angle(
-            self,
-            load_angle: Annotated[
-                float, MustBeBetween(min_value=0.0, max_value=90.0)],
+        self,
+        load_angle: Annotated[float, MustBeBetween(min_value=0.0, max_value=90.0)],
     ) -> None:
         self._load_angle = load_angle
 
@@ -368,8 +366,8 @@ class Foundation:
     @ground_water_level.setter
     @validate_params
     def ground_water_level(
-            self,
-            ground_water_level: Annotated[float, MustBePositive],
+        self,
+        ground_water_level: Annotated[float, MustBePositive],
     ):
         self._ground_water_level = ground_water_level
 
@@ -381,9 +379,8 @@ class Foundation:
     @foundation_type.setter
     @validate_params
     def foundation_type(
-            self,
-            foundation_type: Annotated[
-                FoundationType, MustBeMemberOf(FoundationType)],
+        self,
+        foundation_type: Annotated[FoundationType, MustBeMemberOf(FoundationType)],
     ):
         self._foundation_type = foundation_type
 
@@ -415,14 +412,14 @@ class Foundation:
 
 @validate_params
 def create_foundation(
-        depth: float,
-        width: float,
-        length: Annotated[float, DependsOn(shape=Shape.RECTANGLE)] = None,
-        eccentricity: float = 0.0,
-        load_angle: float = 0.0,
-        ground_water_level: Optional[float] = inf,
-        foundation_type: FoundationType = "pad",
-        shape: Annotated[Shape | str, MustBeMemberOf(Shape)] = "square",
+    depth: float,
+    width: float,
+    length: Annotated[float, DependsOn(shape=Shape.RECTANGLE)] = None,
+    eccentricity: float = 0.0,
+    load_angle: float = 0.0,
+    ground_water_level: Optional[float] = inf,
+    foundation_type: FoundationType = "pad",
+    shape: Annotated[Shape | str, MustBeMemberOf(Shape)] = "square",
 ) -> Foundation:
     r"""A factory function that encapsulate the creation of a foundation.
 

{geolysis-0.16.0 → geolysis-0.18.0}/geolysis.egg-info/PKG-INFO

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