geolysis 0.15.0__py3-none-any.whl → 0.17.0__py3-none-any.whl

geolysis/__init__.py

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

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/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/soil_classifier.py

@@ -4,7 +4,7 @@ from typing import Annotated, Sequence
 
 from func_validator import validate_params, MustBeNonNegative
 
-from .utils import isclose, round_, nan, isnan
+from .utils import isclose, round_
 
 __all__ = [
     "AtterbergLimits",
@@ -269,7 +269,8 @@ class AtterbergLimits:
 
     @plastic_limit.setter
     @validate_params
-    def plastic_limit(self, plastic_limit: Annotated[float, MustBeNonNegative]):
+    def plastic_limit(self,
+                      plastic_limit: Annotated[float, MustBeNonNegative]):
         if self.liquid_limit < plastic_limit:
             msg = (
                 f"plastic_limit: {plastic_limit} cannot be greater than "
@@ -363,7 +364,7 @@ class _SizeDistribution:
 
     @property
     def coeff_of_curvature(self) -> float:
-        return (self.d_30**2.0) / (self.d_60 * self.d_10)
+        return (self.d_30 ** 2.0) / (self.d_60 * self.d_10)
 
     @property
     def coeff_of_uniformity(self) -> float:
@@ -391,9 +392,7 @@ class _SizeDistribution:
 
     def has_particle_sizes(self) -> bool:
         """Checks if particle sizes are provided."""
-        if isnan(self.d_10) or isnan(self.d_30) or isnan(self.d_60):
-            return False
-        return True
+        return all((self.d_10, self.d_30, self.d_60))
 
 
 class PSD:
@@ -402,12 +401,12 @@ class PSD:
     """
 
     def __init__(
-        self,
-        fines: float,
-        sand: float,
-        d_10: float = nan,
-        d_30: float = nan,
-        d_60: float = nan,
+            self,
+            fines: float,
+            sand: float,
+            d_10: float | None = None,
+            d_30: float | None = None,
+            d_60: float | None = None,
     ):
         """
         :param fines: Percentage of fines in soil sample (%) i.e. The
@@ -654,10 +653,10 @@ class USCS:
     """
 
     def __init__(
-        self,
-        atterberg_limits: AtterbergLimits,
-        psd: PSD,
-        organic=False,
+            self,
+            atterberg_limits: AtterbergLimits,
+            psd: PSD,
+            organic=False,
     ):
         """
         :param atterberg_limits: Atterberg limits of the soil.
@@ -785,9 +784,9 @@ class USCS:
 
 
 def create_aashto_classifier(
-    liquid_limit: float,
-    plastic_limit: float,
-    fines: float,
+        liquid_limit: float,
+        plastic_limit: float,
+        fines: float,
 ) -> AASHTO:
     """A helper function that encapsulates the creation of a AASHTO
     classifier.
@@ -810,14 +809,14 @@ def create_aashto_classifier(
 
 
 def create_uscs_classifier(
-    liquid_limit: float,
-    plastic_limit: float,
-    fines: float,
-    sand: float,
-    d_10: float = nan,
-    d_30: float = nan,
-    d_60: float = nan,
-    organic: bool = False,
+        liquid_limit: float,
+        plastic_limit: float,
+        fines: float,
+        sand: float,
+        d_10: float | None = None,
+        d_30: float | None = None,
+        d_60: float | None = None,
+        organic: bool = False,
 ):
     """A helper function that encapsulates the creation of a USCS
     classifier.

{geolysis-0.15.0.dist-info → geolysis-0.17.0.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: geolysis
-Version: 0.15.0
+Version: 0.17.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.15.0.dist-info → geolysis-0.17.0.dist-info}/RECORD

@@ -1,7 +1,7 @@
-geolysis/__init__.py,sha256=PT-PneT0JdgV5KOvFMVjC3ELQLwIL5VF8yNitl5ZfkM,161
+geolysis/__init__.py,sha256=0ryfEZKyHIC8ENVj_VLYnxWIgJN7PmxCrCLBI8HpBaM,161
 geolysis/exceptions.py,sha256=NocUF7-vaFsBJyi0QmH2EBFCpO2RT90RLEB66BCW_X0,74
-geolysis/foundation.py,sha256=9o21R14Pm-HimSuQYqJXvbqQrWgS-z0XFjzjdyEIQ7Y,13319
-geolysis/soil_classifier.py,sha256=TII5tlI6Z5sKvMFkyEqAAvH9KUdFTGcpTQH9pqF82EI,27674
+geolysis/foundation.py,sha256=IlNm-Wnujug_NdiKTejlzlFxXtlpiGGrOvaqkFEHYnU,13188
+geolysis/soil_classifier.py,sha256=4P0l-zpjdcB2Q6NbjBCNTv1reK_-8uQiZnEH-y_ZKvY,27758
 geolysis/spt.py,sha256=7xa4KkzBjbtSFo0zoZleCCCyeE81w4d2eicjlFy3p28,17273
 geolysis/bearing_capacity/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 geolysis/bearing_capacity/abc/__init__.py,sha256=nycD68gdA116n2VX5fT_hq7ZZz3CF4OVuU3DIgnlnZw,518
@@ -10,14 +10,14 @@ geolysis/bearing_capacity/abc/_cohl/_core.py,sha256=jFJAzFpd78QvzwMRSMr9HOwb8Hq6
 geolysis/bearing_capacity/abc/_cohl/bowles_abc.py,sha256=frjZXiVGTR53gRjYNYfYMlx-q9TLltyPHbJFpN7XOiY,2414
 geolysis/bearing_capacity/abc/_cohl/meyerhof_abc.py,sha256=vXDdtFwYzmD2vOXEQxSQb-jp1bPlB4blmcfNi1zAk78,2377
 geolysis/bearing_capacity/abc/_cohl/terzaghi_abc.py,sha256=D8-t9fKCnA4y_cSXk2dCfXPrkeUdNizAf8CDhOCLL0Y,3297
-geolysis/bearing_capacity/ubc/__init__.py,sha256=EVfydz9_UeLTYOKSioJESiv14mjecA2wQiNfqD4N6oQ,4233
+geolysis/bearing_capacity/ubc/__init__.py,sha256=y7CknadZ5BKGNptl-VglhMXV_vh2wjYLFWQ9GfSy4E0,4362
 geolysis/bearing_capacity/ubc/_core.py,sha256=WZUSzgC-RhPTR3t1ECh3A934SMRWeuPyytlNqwpE-0s,8126
 geolysis/bearing_capacity/ubc/_terzaghi_ubc.py,sha256=3g1kyugpuNy4lvcG_uZBOd3PWIkVJ_-VJWZxkrqX-p4,4322
 geolysis/bearing_capacity/ubc/_vesic_ubc.py,sha256=yZS1RH1NfHoYk9UNCKFSjjEOok-mLkStt2rg5X_zG7Y,6810
 geolysis/utils/__init__.py,sha256=T4B8itFH9971MMFpOaAbOMzkIPfrAkZQtGa6jcaI_mY,1768
 geolysis/utils/math.py,sha256=Nqg6SFIy3peSC-n-rq0KjryOdWTqh9jCF2L_qvx5Yg8,1231
-geolysis-0.15.0.dist-info/licenses/LICENSE.txt,sha256=ap6sMs3lT7ICbEXBhgihwH1BTCVcjmCQkIkwVnil1Ak,1065
-geolysis-0.15.0.dist-info/METADATA,sha256=NmH4ukG2MvZ15FqWJhpE5k2ZUMRCCJZxj8VOWwjViFA,6833
-geolysis-0.15.0.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
-geolysis-0.15.0.dist-info/top_level.txt,sha256=9mnQgOaCRr11dtXff8X-q3FfXjRONd6kHseSy5q2y8g,9
-geolysis-0.15.0.dist-info/RECORD,,
+geolysis-0.17.0.dist-info/licenses/LICENSE.txt,sha256=ap6sMs3lT7ICbEXBhgihwH1BTCVcjmCQkIkwVnil1Ak,1065
+geolysis-0.17.0.dist-info/METADATA,sha256=78qrdyhZp_vOs_Eu1d8wkJ9eIny9U81i1xwhwfqx6LA,6833
+geolysis-0.17.0.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
+geolysis-0.17.0.dist-info/top_level.txt,sha256=9mnQgOaCRr11dtXff8X-q3FfXjRONd6kHseSy5q2y8g,9
+geolysis-0.17.0.dist-info/RECORD,,