geolysis 0.12.0__py3-none-any.whl → 0.13.0__py3-none-any.whl

geolysis/spt.py

@@ -3,7 +3,7 @@ from abc import abstractmethod
 from typing import Annotated, Final, Sequence
 
 from func_validator import (
-    validate_func_args,
+    validate_params,
     MustBeBetween,
     MustBePositive,
     MustBeMemberOf,
@@ -80,7 +80,7 @@ class SPT:
         return self._corrected_spt_n_values
 
     @corrected_spt_n_values.setter
-    @validate_func_args
+    @validate_params
     def corrected_spt_n_values(
         self,
         corrected_spt_n_values: Annotated[
@@ -96,9 +96,9 @@ class SPT:
         return self._method
 
     @method.setter
-    @validate_func_args
-    def method(self, val: Annotated[str, MustBeMemberOf(SPTDesignMethod)]):
-        self._method = val
+    @validate_params
+    def method(self, method: Annotated[str, MustBeMemberOf(SPTDesignMethod)]):
+        self._method = method
 
     @staticmethod
     def _avg_spt_n_design(vals) -> float:
@@ -111,15 +111,15 @@ class SPT:
     @staticmethod
     def _wgt_spt_n_design(vals):
 
-        sum_total = 0.0
-        sum_wgts = 0.0
+        total_wgted_spt = 0.0
+        total_wgt = 0.0
 
         for i, corr_spt_n_val in enumerate(vals, start=1):
             wgt = 1 / i**2
-            sum_total += wgt * corr_spt_n_val
-            sum_wgts += wgt
+            total_wgted_spt += wgt * corr_spt_n_val
+            total_wgt += wgt
 
-        return sum_total / sum_wgts
+        return total_wgted_spt / total_wgt
 
     @round_(ndigits=1)
     def n_design(self):
@@ -252,11 +252,12 @@ class EnergyCorrection:
         return self._recorded_spt_value
 
     @recorded_spt_n_value.setter
-    @validate_func_args
+    @validate_params
     def recorded_spt_n_value(
-        self, val: Annotated[int, MustBeBetween(min_value=0, max_value=100)]
+        self,
+        recorded_spt_n_value: Annotated[int, MustBeBetween(min_value=0, max_value=100)],
     ) -> None:
-        self._recorded_spt_value = val
+        self._recorded_spt_value = recorded_spt_n_value
 
     @property
     def energy_percentage(self) -> float:
@@ -264,11 +265,14 @@ class EnergyCorrection:
         return self._energy_percentage
 
     @energy_percentage.setter
-    @validate_func_args
+    @validate_params
     def energy_percentage(
-        self, val: Annotated[float, MustBeBetween(min_value=0.0, max_value=1.0)]
+        self,
+        energy_percentage: Annotated[
+            float, MustBeBetween(min_value=0.0, max_value=1.0)
+        ],
     ) -> None:
-        self._energy_percentage = val
+        self._energy_percentage = energy_percentage
 
     @property
     def borehole_diameter(self) -> float:
@@ -276,11 +280,14 @@ class EnergyCorrection:
         return self._borehole_diameter
 
     @borehole_diameter.setter
-    @validate_func_args
+    @validate_params
     def borehole_diameter(
-        self, val: Annotated[float, MustBeBetween(min_value=65.0, max_value=200.0)]
+        self,
+        borehole_diameter: Annotated[
+            float, MustBeBetween(min_value=65.0, max_value=200.0)
+        ],
     ) -> None:
-        self._borehole_diameter = val
+        self._borehole_diameter = borehole_diameter
 
     @property
     def rod_length(self) -> float:
@@ -288,18 +295,19 @@ class EnergyCorrection:
         return self._rod_length
 
     @rod_length.setter
-    @validate_func_args
-    def rod_length(self, val: Annotated[float, MustBePositive]):
-        self._rod_length = val
+    @validate_params
+    def rod_length(self, rod_length: Annotated[float, MustBePositive]):
+        self._rod_length = rod_length
 
     @property
     def hammer_type(self) -> HammerType:
         return self._hammer_type
 
     @hammer_type.setter
-    @validate_func_args
+    @validate_params
     def hammer_type(
-        self, hammer_type: Annotated[HammerType, MustBeMemberOf(HammerType)]
+        self,
+        hammer_type: Annotated[HammerType, MustBeMemberOf(HammerType)],
     ):
         self._hammer_type = hammer_type
 
@@ -308,9 +316,11 @@ class EnergyCorrection:
         return self._sampler_type
 
     @sampler_type.setter
-    @validate_func_args
-    def sampler_type(self, val: Annotated[SamplerType, MustBeMemberOf(SamplerType)]):
-        self._sampler_type = val
+    @validate_params
+    def sampler_type(
+        self, sampler_type: Annotated[SamplerType, MustBeMemberOf(SamplerType)]
+    ):
+        self._sampler_type = sampler_type
 
     @property
     def hammer_efficiency(self) -> float:
@@ -388,10 +398,10 @@ class OPC:
         return self._eop
 
     @eop.setter
-    @validate_func_args
-    def eop(self, val: Annotated[float, MustBeNonNegative]):
+    @validate_params
+    def eop(self, eop: Annotated[float, MustBeNonNegative]):
         """Effective overburden pressure ($kPa$)."""
-        self._eop = val
+        self._eop = eop
 
     @property
     def std_spt_n_value(self) -> float:
@@ -399,11 +409,14 @@ class OPC:
         return self._std_spt_n_value
 
     @std_spt_n_value.setter
-    @validate_func_args
+    @validate_params
     def std_spt_n_value(
-        self, val: Annotated[float, MustBeBetween(min_value=0.0, max_value=100.0)]
+        self,
+        std_spt_n_value: Annotated[
+            float, MustBeBetween(min_value=0.0, max_value=100.0)
+        ],
     ):
-        self._std_spt_n_value = val
+        self._std_spt_n_value = std_spt_n_value
 
     @round_(ndigits=1)
     def corrected_spt_n_value(self) -> float:
@@ -429,9 +442,12 @@ class GibbsHoltzOPC(OPC):
         return self._eop
 
     @eop.setter
-    @validate_func_args
-    def eop(self, val: Annotated[float, MustBeBetween(min_value=0.0, max_value=280.0)]):
-        self._eop = val
+    @validate_params
+    def eop(
+        self,
+        eop: Annotated[float, MustBeBetween(min_value=0.0, max_value=280.0)],
+    ):
+        self._eop = eop
 
     def correction(self) -> float:
         r"""SPT Correction."""
@@ -469,9 +485,9 @@ class PeckOPC(OPC):
         return self._eop
 
     @eop.setter
-    @validate_func_args
-    def eop(self, val: Annotated[float, MustBeGreaterThanOrEqual(24.0)]):
-        self._eop = val
+    @validate_params
+    def eop(self, eop: Annotated[float, MustBeGreaterThanOrEqual(24.0)]):
+        self._eop = eop
 
     def correction(self) -> float:
         r"""SPT Correction."""
@@ -520,11 +536,14 @@ class DilatancyCorrection:
         return self._corr_spt_n_value
 
     @corr_spt_n_value.setter
-    @validate_func_args
+    @validate_params
     def corr_spt_n_value(
-        self, val: Annotated[float, MustBeBetween(min_value=0.0, max_value=100.0)]
+        self,
+        corr_spt_n_value: Annotated[
+            float, MustBeBetween(min_value=0.0, max_value=100.0)
+        ],
     ):
-        self._corr_spt_n_value = val
+        self._corr_spt_n_value = corr_spt_n_value
 
     @round_(ndigits=1)
     def corrected_spt_n_value(self) -> float:
@@ -566,7 +585,7 @@ _opctypes = {
 }
 
 
-@validate_func_args
+@validate_params
 def create_overburden_pressure_correction(
     std_spt_n_value: float,
     eop: float,

geolysis/utils/__init__.py

@@ -2,11 +2,10 @@ import enum
 import functools
 from typing import Callable
 
-from func_validator import ValidationError
-
 from .math import *
+from . import math as m
 
-__all__ = ["AbstractStrEnum", "ValidationError", "add_repr", "round_"]
+__all__ = ["AbstractStrEnum", "ValidationError", "add_repr", "round_"] + m.__all__
 
 
 class StrEnumMeta(enum.EnumMeta):

geolysis/utils/math.py

@@ -1,5 +1,5 @@
 import math
-from math import exp, inf, isclose, log10, pi, sqrt, isinf, atan
+from math import exp, inf, isclose, log10, pi, sqrt, isinf, atan, nan, isnan
 from statistics import fmean as mean
 
 __all__ = [
@@ -19,6 +19,8 @@ __all__ = [
     "isclose",
     "log10",
     "sqrt",
+    "nan",
+    "isnan",
 ]
 
 

{geolysis-0.12.0.dist-info → geolysis-0.13.0.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: geolysis
-Version: 0.12.0
+Version: 0.13.0
 Summary: geolysis is an opensource software for geotechnical engineering analysis and modeling.
 Author-email: Patrick Boateng <boatengpato.pb@gmail.com>
 License: MIT License
@@ -161,7 +161,7 @@ These are the main components of the project structure
 >>> clf = aashto_clf.classify()
 >>> clf.symbol
 'A-6(4)'
->>> clf.symbol_no_grp_idx
+>>> clf.symbol_no_group_idx
 'A-6'
 >>> clf.group_index
 '4'

geolysis-0.13.0.dist-info/RECORD

@@ -0,0 +1,22 @@
+geolysis/__init__.py,sha256=EyKIJ9MKUYf9yVr8OjAgDdXwk75Gt6ChVTRk4kSEsDU,161
+geolysis/foundation.py,sha256=9o21R14Pm-HimSuQYqJXvbqQrWgS-z0XFjzjdyEIQ7Y,13319
+geolysis/soil_classifier.py,sha256=TII5tlI6Z5sKvMFkyEqAAvH9KUdFTGcpTQH9pqF82EI,27674
+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
+geolysis/bearing_capacity/abc/_cohl/__init__.py,sha256=eelKtboxHhzq1uBcaW5liUqSUUpiWoDeg5ufO2beRHY,3351
+geolysis/bearing_capacity/abc/_cohl/_core.py,sha256=jFJAzFpd78QvzwMRSMr9HOwb8Hq62gxNCoJdznRqPMM,2834
+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=_ig85iPMuBxIp1l6hF-ZLqgkE7P_BqsWL7PVAUos0LY,4276
+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=U52nDxgnjMB4sJ8kORZz2r6aPjh7N26J0QmTSwjoRAc,1787
+geolysis/utils/math.py,sha256=Nqg6SFIy3peSC-n-rq0KjryOdWTqh9jCF2L_qvx5Yg8,1231
+geolysis-0.13.0.dist-info/licenses/LICENSE.txt,sha256=ap6sMs3lT7ICbEXBhgihwH1BTCVcjmCQkIkwVnil1Ak,1065
+geolysis-0.13.0.dist-info/METADATA,sha256=9tTw_CUBOxWz2t-k6-q42fLgIAMbVr4dkKemTGZiGFA,6833
+geolysis-0.13.0.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
+geolysis-0.13.0.dist-info/top_level.txt,sha256=9mnQgOaCRr11dtXff8X-q3FfXjRONd6kHseSy5q2y8g,9
+geolysis-0.13.0.dist-info/RECORD,,

geolysis/bearing_capacity/ubc/_hansen_ubc.py

@@ -1,200 +0,0 @@
-from geolysis.foundation import Shape
-from geolysis.utils import (
-    cosdeg,
-    cotdeg,
-    exp,
-    isclose,
-    pi,
-    round_,
-    sindeg,
-    tandeg,
-    add_repr,
-)
-
-from ._core import UltimateBearingCapacity
-
-__all__ = ["HansenUltimateBearingCapacity"]
-
-
-class HansenBearingCapacityFactors:
-
-    @staticmethod
-    @round_(ndigits=2)
-    def n_c(friction_angle: float) -> float:
-        if isclose(friction_angle, 0.0):
-            return 5.14
-        return cotdeg(friction_angle) * (
-            HansenBearingCapacityFactors.n_q(friction_angle) - 1.0
-        )
-
-    @staticmethod
-    @round_(ndigits=2)
-    def n_q(friction_angle: float) -> float:
-        return tandeg(45.0 + friction_angle / 2.0) ** 2.0 * exp(
-            pi * tandeg(friction_angle)
-        )
-
-    @staticmethod
-    @round_(ndigits=2)
-    def n_gamma(friction_angle: float) -> float:
-        return (
-            1.8
-            * (HansenBearingCapacityFactors.n_q(friction_angle) - 1.0)
-            * tandeg(friction_angle)
-        )
-
-
-class HansenShapeFactors:
-
-    @staticmethod
-    @round_(ndigits=2)
-    def s_c(f_width: float, f_length: float, f_shape: Shape) -> float:
-        if f_shape == Shape.STRIP:
-            return 1.0
-        elif f_shape == Shape.RECTANGLE:
-            return 1.0 + 0.2 * f_width / f_length
-        else:  # SQUARE & CIRCLE
-            return 1.3
-
-    @staticmethod
-    @round_(ndigits=2)
-    def s_q(f_width: float, f_length: float, f_shape: Shape) -> float:
-        if f_shape == Shape.STRIP:
-            return 1.0
-        elif f_shape == Shape.RECTANGLE:
-            return 1.0 + 0.2 * f_width / f_length
-        else:  # SQUARE & CIRCLE
-            return 1.2
-
-    @staticmethod
-    @round_(ndigits=2)
-    def s_gamma(f_width: float, f_length: float, f_shape: Shape) -> float:
-        if f_shape == Shape.STRIP:
-            return 1.0
-        elif f_shape == Shape.RECTANGLE:
-            return 1.0 - 0.4 * f_width / f_length
-        elif f_shape == Shape.SQUARE:
-            return 0.8
-        else:  # CIRCLE
-            return 0.6
-
-
-class HansenDepthFactors:
-
-    @staticmethod
-    @round_(ndigits=2)
-    def d_c(f_depth: float, f_width: float) -> float:
-        return 1.0 + 0.35 * f_depth / f_width
-
-    @staticmethod
-    @round_(ndigits=2)
-    def d_q(f_depth: float, f_width: float) -> float:
-        return HansenDepthFactors.d_c(f_depth, f_width)
-
-    @staticmethod
-    @round_(ndigits=2)
-    def d_gamma() -> float:
-        return 1.0
-
-
-class HansenInclinationFactors:
-
-    @staticmethod
-    @round_(ndigits=2)
-    def i_c(
-        cohesion: float,
-        load_angle: float,
-        f_width: float,
-        f_length: float,
-    ) -> float:
-        return 1.0 - sindeg(load_angle) / (2.0 * cohesion * f_width * f_length)
-
-    @staticmethod
-    @round_(ndigits=2)
-    def i_q(load_angle: float) -> float:
-        return 1.0 - (1.5 * sindeg(load_angle)) / cosdeg(load_angle)
-
-    @staticmethod
-    @round_(ndigits=2)
-    def i_gamma(load_angle: float) -> float:
-        return HansenInclinationFactors.i_q(load_angle) ** 2.0
-
-
-@add_repr
-class HansenUltimateBearingCapacity(UltimateBearingCapacity):
-    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$."""
-        return HansenBearingCapacityFactors.n_c(self.friction_angle)
-
-    @property
-    def n_q(self) -> float:
-        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}$."""
-        return HansenBearingCapacityFactors.n_gamma(self.friction_angle)
-
-    @property
-    def s_c(self) -> float:
-        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$."""
-        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}$."""
-        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$."""
-        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$."""
-        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}$."""
-        return HansenDepthFactors.d_gamma()
-
-    @property
-    def i_c(self) -> float:
-        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
-        )
-
-    @property
-    def i_q(self) -> float:
-        r"""Inclination factor $I_q$."""
-        return HansenInclinationFactors.i_q(self.load_angle)
-
-    @property
-    def i_gamma(self) -> float:
-        r"""Inclination factor $I_{\gamma}$."""
-        return HansenInclinationFactors.i_gamma(self.load_angle)

geolysis-0.12.0.dist-info/RECORD

@@ -1,23 +0,0 @@
-geolysis/__init__.py,sha256=YeQEtgF2PcR6s7EYEqNbirBHSK4wkpkD0tu2P_JKe-w,161
-geolysis/foundation.py,sha256=F1PcVpwQLtdfuhF8qzsoTrDRBNd8G3dac3YVj0kUDNk,13677
-geolysis/soil_classifier.py,sha256=kbvfOSm6gtde0jTxY70FB0cfgVCEHeChrZErWkjJMW8,27334
-geolysis/spt.py,sha256=19FmnG3UNHbnJatZf3oZ2UazCb_a-knIvII67IonaIg,16940
-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=QtedY1gUAM5U3pyndxmQl2hMVL1obAAEBwQX1tiEoo0,2591
-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=Juenai6DJtQraeNmwQcr9V3L_TQgds89cJNIaCBac58,3236
-geolysis/bearing_capacity/ubc/__init__.py,sha256=6bZJ5pGgBIJkNOkrXE6ezkLXCu05mhrXiqIPFo6xW1o,4739
-geolysis/bearing_capacity/ubc/_core.py,sha256=gY1a73_fIrPu0y9MxuoSTdvMk4BZ2bLkPPqgy5VaRwg,8016
-geolysis/bearing_capacity/ubc/_hansen_ubc.py,sha256=IfH_dbHC0LGCyALw5qAuIaXxYEYloA0hlX6KIaXD46g,5630
-geolysis/bearing_capacity/ubc/_terzaghi_ubc.py,sha256=GvSN0u_RTejl6oaQrlHj9y3dZVWn2Y89bNRZLpFjrBk,4223
-geolysis/bearing_capacity/ubc/_vesic_ubc.py,sha256=z0F0t-AYTvcjkqrNKky7nMsRHsvLfPoMHrDptGpAoHM,6636
-geolysis/utils/__init__.py,sha256=r2CoOK29ucbQ7GGsWJg-qDsXBgzAeGv8LastI29b5ys,1795
-geolysis/utils/math.py,sha256=7_ipjdcQft3-8wTPNj-2wRq8Z7KEm_C2ymkraSrKuYw,1195
-geolysis-0.12.0.dist-info/licenses/LICENSE.txt,sha256=ap6sMs3lT7ICbEXBhgihwH1BTCVcjmCQkIkwVnil1Ak,1065
-geolysis-0.12.0.dist-info/METADATA,sha256=9waPtBu0xS4HDyhpe8VP7zBrsAZRhuif18k6MGTQKZw,6831
-geolysis-0.12.0.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
-geolysis-0.12.0.dist-info/top_level.txt,sha256=9mnQgOaCRr11dtXff8X-q3FfXjRONd6kHseSy5q2y8g,9
-geolysis-0.12.0.dist-info/RECORD,,