geolysis 0.18.0__py3-none-any.whl → 0.20.0__py3-none-any.whl

geolysis/__init__.py

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

geolysis/bearing_capacity/abc/_cohl/_core.py

@@ -1,26 +1,24 @@
 from abc import ABC, abstractmethod
 from dataclasses import dataclass
-from typing import Annotated
+from typing import Annotated, Optional
 
 from func_validator import (
     validate_params,
-    MustBePositive,
     MustBeNonNegative,
     MustBeLessThanOrEqual,
 )
 
 from geolysis.foundation import Foundation
-from geolysis.utils import round_, add_repr
+from geolysis.utils import round_
 
 
 @dataclass
 class AllowableBearingCapacityResult:
     allowable_bearing_capacity: float
     depth_factor: float
-    water_correction_factor: float = 1.0
+    water_correction_factor: Optional[float] = None
 
 
-@add_repr
 class AllowableBearingCapacity(ABC):
     #: Maximum tolerable foundation settlement (mm).
     MAX_TOL_SETTLEMENT = 25.4
@@ -44,7 +42,7 @@ class AllowableBearingCapacity(ABC):
     @validate_params
     def corrected_spt_n_value(
             self,
-            corrected_spt_n_value: Annotated[float, MustBeNonNegative],
+            corrected_spt_n_value: Annotated[float, MustBeNonNegative()],
     ):
         self._corrected_spt_n_value = corrected_spt_n_value
 
@@ -58,7 +56,8 @@ class AllowableBearingCapacity(ABC):
     def tol_settlement(
             self,
             tol_settlement: Annotated[
-                float, MustBePositive, MustBeLessThanOrEqual(25.4)],
+                float, MustBeNonNegative(), MustBeLessThanOrEqual(25.4)
+            ],
     ):
         self._tol_settlement = tol_settlement
 
@@ -90,6 +89,7 @@ class AllowableBearingCapacity(ABC):
         """
         return self._bearing_capacity()
 
+    @round_(ndigits=1)
     def allowable_applied_load(self) -> float:
         """Calculate the allowable applied load on the foundation."""
         return self._bearing_capacity() * self.foundation_size.foundation_area()

geolysis/bearing_capacity/ubc/__init__.py

@@ -53,20 +53,20 @@ ubc_classes = {
 
 @validate_params
 def create_ubc_4_all_soil_types(
-        friction_angle: float,
-        cohesion: float,
-        moist_unit_wgt: float,
-        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,
-        load_angle: float = 0.0,
-        apply_local_shear: bool = False,
-        shape: Shape | str = "square",
-        ubc_type: Annotated[UBCType | str, MustBeMemberOf(UBCType)] = "vesic",
+    friction_angle: float,
+    cohesion: float,
+    moist_unit_wgt: float,
+    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,
+    load_angle: float = 0.0,
+    apply_local_shear: bool = False,
+    shape: Shape | str = "square",
+    ubc_type: Annotated[UBCType | str, MustBeMemberOf(UBCType)] = "vesic",
 ) -> UltimateBearingCapacity:
     r"""A factory function that encapsulate the creation of ultimate
     bearing capacity.

geolysis/bearing_capacity/ubc/_core.py

@@ -33,14 +33,14 @@ class UltimateBearingCapacityResult:
 
 class UltimateBearingCapacity(ABC):
     def __init__(
-        self,
-        friction_angle: float,
-        cohesion: float,
-        moist_unit_wgt: float,
-        foundation_size: Foundation,
-        saturated_unit_wgt: float = 20.5,
-        apply_local_shear: bool = False,
-        factor_of_safety: float = 3.0,
+            self,
+            friction_angle: float,
+            cohesion: float,
+            moist_unit_wgt: float,
+            foundation_size: Foundation,
+            saturated_unit_wgt: float = 20.5,
+            apply_local_shear: bool = False,
+            factor_of_safety: float = 3.0,
     ) -> None:
         r"""
         :param friction_angle: Internal angle of friction for general
@@ -82,8 +82,8 @@ class UltimateBearingCapacity(ABC):
     @friction_angle.setter
     @validate_params
     def friction_angle(
-        self,
-        friction_angle: Annotated[float, MustBeNonNegative],
+            self,
+            friction_angle: Annotated[float, MustBeNonNegative()],
     ):
         self._friction_angle = friction_angle
 
@@ -102,7 +102,7 @@ class UltimateBearingCapacity(ABC):
 
     @cohesion.setter
     @validate_params
-    def cohesion(self, cohesion: Annotated[float, MustBeNonNegative]):
+    def cohesion(self, cohesion: Annotated[float, MustBeNonNegative()]):
         self._cohesion = cohesion
 
     @property
@@ -112,7 +112,8 @@ class UltimateBearingCapacity(ABC):
 
     @moist_unit_wgt.setter
     @validate_params
-    def moist_unit_wgt(self, moist_unit_wgt: Annotated[float, MustBePositive]):
+    def moist_unit_wgt(self,
+                       moist_unit_wgt: Annotated[float, MustBePositive()]):
         self._moist_unit_wgt = moist_unit_wgt
 
     @property
@@ -123,8 +124,8 @@ class UltimateBearingCapacity(ABC):
     @saturated_unit_wgt.setter
     @validate_params
     def saturated_unit_wgt(
-        self,
-        saturated_unit_wgt: Annotated[float, MustBePositive],
+            self,
+            saturated_unit_wgt: Annotated[float, MustBePositive()],
     ):
         self._saturated_unit_wgt = saturated_unit_wgt
 
@@ -184,6 +185,7 @@ class UltimateBearingCapacity(ABC):
                 d_2 = depth - d_1
                 unit_wgt = self.saturated_unit_wgt - 9.81
                 eop = self.moist_unit_wgt * d_1 + unit_wgt * d_2
+
         return eop * self.n_q * self.s_q * self.d_q * self.i_q
 
     def _embedment_term(self, coef: float = 0.5) -> float:
@@ -203,20 +205,20 @@ class UltimateBearingCapacity(ABC):
                     unit_wgt = wgt + (d / width) * (self.moist_unit_wgt - wgt)
 
         return (
-            coef
-            * unit_wgt
-            * width
-            * self.n_gamma
-            * self.s_gamma
-            * self.d_gamma
-            * self.i_gamma
+                coef
+                * unit_wgt
+                * width
+                * self.n_gamma
+                * self.s_gamma
+                * self.d_gamma
+                * self.i_gamma
         )
 
     def _bearing_capacity(self) -> float:
         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)
         )
 
     def bearing_capacity_results(self) -> UltimateBearingCapacityResult:
@@ -270,12 +272,15 @@ class UltimateBearingCapacity(ABC):
 
     @property
     @abstractmethod
-    def n_c(self) -> float: ...
+    def n_c(self) -> float:
+        ...
 
     @property
     @abstractmethod
-    def n_q(self) -> float: ...
+    def n_q(self) -> float:
+        ...
 
     @property
     @abstractmethod
-    def n_gamma(self) -> float: ...
+    def n_gamma(self) -> float:
+        ...

geolysis/bearing_capacity/ubc/_terzaghi_ubc.py

@@ -7,7 +7,6 @@ from geolysis.utils import (
     pi,
     round_,
     tandeg,
-    add_repr,
 )
 from ._core import UltimateBearingCapacity
 
@@ -27,7 +26,7 @@ class TerzaghiBearingCapacityFactors:
         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
@@ -40,12 +39,12 @@ class TerzaghiBearingCapacityFactors:
     @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
         )
 
 
-@add_repr
 class TerzaghiUltimateBearingCapacity(UltimateBearingCapacity):
 
     @property
@@ -76,9 +75,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)
         )
 
 
@@ -94,9 +93,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)
         )
 
 
@@ -111,9 +110,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)
         )
 
 
@@ -134,7 +133,7 @@ class TerzaghiUBC4RectangularFooting(TerzaghiUltimateBearingCapacity):
         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)
         )

geolysis/bearing_capacity/ubc/_vesic_ubc.py

@@ -5,7 +5,6 @@ from geolysis.utils import (
     sindeg,
     tandeg,
     atan,
-    add_repr,
     cotdeg,
     exp,
     pi,
@@ -23,7 +22,7 @@ class VesicBearingCapacityFactors:
         if isclose(friction_angle, 0.0):
             return 5.14
         return cotdeg(friction_angle) * (
-            VesicBearingCapacityFactors.n_q(friction_angle) - 1.0
+                VesicBearingCapacityFactors.n_q(friction_angle) - 1.0
         )
 
     @staticmethod
@@ -37,9 +36,9 @@ class VesicBearingCapacityFactors:
     @round_(ndigits=2)
     def n_gamma(friction_angle: float) -> float:
         return (
-            2.0
-            * (VesicBearingCapacityFactors.n_q(friction_angle) + 1.0)
-            * tandeg(friction_angle)
+                2.0
+                * (VesicBearingCapacityFactors.n_q(friction_angle) + 1.0)
+                * tandeg(friction_angle)
         )
 
 
@@ -47,10 +46,10 @@ class VesicShapeFactors:
     @staticmethod
     @round_(ndigits=3)
     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)
@@ -63,10 +62,10 @@ class VesicShapeFactors:
     @staticmethod
     @round_(ndigits=3)
     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
@@ -118,18 +117,19 @@ class VesicDepthFactors:
                 _d_q = 1.0
             else:
                 _d_q = (
-                    1.0
-                    + 2
-                    * tandeg(friction_angle)
-                    * (1 - sindeg(friction_angle)) ** 2
-                    * d2w
+                        1.0
+                        + 2
+                        * tandeg(friction_angle)
+                        * (1 - sindeg(friction_angle)) ** 2
+                        * d2w
                 )
         else:
             if isclose(friction_angle, 0.0):
                 _d_q = 1.0
             else:
                 _d_q = 1.0 + (
-                    2.0 * tandeg(friction_angle) * (1 - sindeg(friction_angle)) ** 2
+                        2.0 * tandeg(friction_angle) * (
+                            1 - sindeg(friction_angle)) ** 2
                 ) * atan(d2w)
         return _d_q
 
@@ -158,7 +158,6 @@ class VesicInclinationFactors:
         return (1.0 - load_angle / friction_angle) ** 2.0
 
 
-@add_repr
 class VesicUltimateBearingCapacity(UltimateBearingCapacity):
     """Ultimate bearing capacity for soils according to `Vesic (1973)`.
 
@@ -229,4 +228,5 @@ class VesicUltimateBearingCapacity(UltimateBearingCapacity):
     @property
     def i_gamma(self) -> float:
         r"""Inclination factor $I_{\gamma}$."""
-        return VesicInclinationFactors.i_gamma(self.friction_angle, self.load_angle)
+        return VesicInclinationFactors.i_gamma(self.friction_angle,
+                                               self.load_angle)

geolysis/foundation.py

@@ -1,6 +1,6 @@
 import enum
 from abc import ABC, abstractmethod
-from typing import Optional, TypeAlias, TypeVar, Annotated
+from typing import Optional, TypeVar, Annotated
 
 from func_validator import (
     validate_params,
@@ -11,7 +11,7 @@ from func_validator import (
     DependsOn,
 )
 
-from .utils import AbstractStrEnum, inf, isclose, pi, round_, add_repr, isinf
+from .utils import AbstractStrEnum, inf, isclose, pi, round_, isinf
 
 __all__ = [
     "create_foundation",
@@ -102,7 +102,6 @@ class FootingSize(ABC):
         return self._SHAPE
 
 
-@add_repr
 class StripFooting(FootingSize):
     """A class representation of strip footing."""
 
@@ -141,7 +140,6 @@ class StripFooting(FootingSize):
         return self.width * self.length
 
 
-@add_repr
 class CircularFooting(FootingSize):
     """A class representation of circular footing.
 
@@ -191,10 +189,9 @@ 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
 class SquareFooting(FootingSize):
     """A class representation of square footing."""
 
@@ -227,10 +224,9 @@ class SquareFooting(FootingSize):
 
     def area(self) -> float:
         """Area of square footing ($m^2$)."""
-        return self.width**2
+        return self.width ** 2
 
 
-@add_repr
 class RectangularFooting(FootingSize):
     """A class representation of rectangular footing."""
 
@@ -267,18 +263,17 @@ class RectangularFooting(FootingSize):
         return self.width * self.length
 
 
-@add_repr
 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).
@@ -307,7 +302,7 @@ class Foundation:
 
     @depth.setter
     @validate_params
-    def depth(self, depth: Annotated[float, MustBePositive]) -> None:
+    def depth(self, depth: Annotated[float, MustBePositive()]) -> None:
         self._depth = depth
 
     @property
@@ -316,7 +311,7 @@ class Foundation:
         return self.footing_size.width
 
     @width.setter
-    def width(self, width: Annotated[float, MustBePositive]):
+    def width(self, width: Annotated[float, MustBePositive()]):
         self.footing_size.width = width
 
     @property
@@ -325,7 +320,7 @@ class Foundation:
         return self.footing_size.length
 
     @length.setter
-    def length(self, length: Annotated[float, MustBePositive]):
+    def length(self, length: Annotated[float, MustBePositive()]):
         self.footing_size.length = length
 
     @property
@@ -342,7 +337,8 @@ 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
@@ -353,8 +349,9 @@ 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
 
@@ -366,8 +363,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
 
@@ -379,8 +376,9 @@ 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
 
@@ -412,14 +410,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

@@ -1,8 +1,12 @@
 import enum
 from dataclasses import dataclass
-from typing import Annotated, Sequence
+from typing import Annotated, Sequence, Optional
 
-from func_validator import validate_params, MustBeNonNegative
+from func_validator import (
+    validate_params,
+    MustBeNonNegative,
+    MustBePositive,
+)
 
 from .utils import isclose, round_
 
@@ -257,7 +261,8 @@ class AtterbergLimits:
 
     @liquid_limit.setter
     @validate_params
-    def liquid_limit(self, liquid_limit: Annotated[float, MustBeNonNegative]):
+    def liquid_limit(self,
+                     liquid_limit: Annotated[float, MustBeNonNegative()]):
         self._liquid_limit = liquid_limit
 
     @property
@@ -270,7 +275,7 @@ class AtterbergLimits:
     @plastic_limit.setter
     @validate_params
     def plastic_limit(self,
-                      plastic_limit: Annotated[float, MustBeNonNegative]):
+                      plastic_limit: Annotated[float, MustBeNonNegative()]):
         if self.liquid_limit < plastic_limit:
             msg = (
                 f"plastic_limit: {plastic_limit} cannot be greater than "
@@ -533,7 +538,7 @@ class AASHTO:
 
     @fines.setter
     @validate_params
-    def fines(self, fines: Annotated[float, MustBeNonNegative]):
+    def fines(self, fines: Annotated[float, MustBeNonNegative()]):
         self._fines = fines
 
     @round_(ndigits=0)
@@ -808,14 +813,15 @@ def create_aashto_classifier(
     return AASHTO(atterberg_limits, fines)
 
 
+@validate_params
 def create_uscs_classifier(
         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,
+        d_10: Annotated[Optional[float], MustBePositive()] = None,
+        d_30: Annotated[Optional[float], MustBePositive()] = None,
+        d_60: Annotated[Optional[float], MustBePositive()] = None,
         organic: bool = False,
 ):
     """A helper function that encapsulates the creation of a USCS

geolysis/spt.py

@@ -61,9 +61,9 @@ class SPT:
     """
 
     def __init__(
-        self,
-        corrected_spt_n_values: Sequence[float],
-        method: SPTDesignMethod.WEIGHTED = "wgt",
+            self,
+            corrected_spt_n_values: Sequence[float],
+            method: SPTDesignMethod.WEIGHTED = "wgt",
     ):
         """
         :param corrected_spt_n_values: Corrected SPT N-values within the
@@ -82,12 +82,12 @@ class SPT:
     @corrected_spt_n_values.setter
     @validate_params
     def corrected_spt_n_values(
-        self,
-        corrected_spt_n_values: Annotated[
-            Sequence[float],
-            MustHaveLengthGreaterThan(1),
-            MustHaveValuesBetween(min_value=1.0, max_value=100.0),
-        ],
+            self,
+            corrected_spt_n_values: Annotated[
+                Sequence[float],
+                MustHaveLengthGreaterThan(1),
+                MustHaveValuesBetween(min_value=1.0, max_value=100.0),
+            ],
     ) -> None:
         self._corrected_spt_n_values = corrected_spt_n_values
 
@@ -115,7 +115,7 @@ class SPT:
         total_wgt = 0.0
 
         for i, corr_spt_n_val in enumerate(vals, start=1):
-            wgt = 1 / i**2
+            wgt = 1 / i ** 2
             total_wgted_spt += wgt * corr_spt_n_val
             total_wgt += wgt
 
@@ -220,14 +220,14 @@ class EnergyCorrection:
     }
 
     def __init__(
-        self,
-        recorded_spt_n_value: int,
-        *,
-        energy_percentage=0.6,
-        borehole_diameter=65.0,
-        rod_length=3.0,
-        hammer_type=HammerType.DONUT_1,
-        sampler_type=SamplerType.STANDARD,
+            self,
+            recorded_spt_n_value: int,
+            *,
+            energy_percentage=0.6,
+            borehole_diameter=65.0,
+            rod_length=3.0,
+            hammer_type=HammerType.DONUT_1,
+            sampler_type=SamplerType.STANDARD,
     ):
         """
         :param recorded_spt_n_value: Recorded SPT N-value from field.
@@ -254,8 +254,9 @@ class EnergyCorrection:
     @recorded_spt_n_value.setter
     @validate_params
     def recorded_spt_n_value(
-        self,
-        recorded_spt_n_value: 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 = recorded_spt_n_value
 
@@ -267,10 +268,10 @@ class EnergyCorrection:
     @energy_percentage.setter
     @validate_params
     def energy_percentage(
-        self,
-        energy_percentage: 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 = energy_percentage
 
@@ -282,10 +283,10 @@ class EnergyCorrection:
     @borehole_diameter.setter
     @validate_params
     def borehole_diameter(
-        self,
-        borehole_diameter: 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 = borehole_diameter
 
@@ -296,7 +297,7 @@ class EnergyCorrection:
 
     @rod_length.setter
     @validate_params
-    def rod_length(self, rod_length: Annotated[float, MustBePositive]):
+    def rod_length(self, rod_length: Annotated[float, MustBePositive()]):
         self._rod_length = rod_length
 
     @property
@@ -306,8 +307,8 @@ class EnergyCorrection:
     @hammer_type.setter
     @validate_params
     def hammer_type(
-        self,
-        hammer_type: Annotated[HammerType, MustBeMemberOf(HammerType)],
+            self,
+            hammer_type: Annotated[HammerType, MustBeMemberOf(HammerType)],
     ):
         self._hammer_type = hammer_type
 
@@ -318,7 +319,8 @@ class EnergyCorrection:
     @sampler_type.setter
     @validate_params
     def sampler_type(
-        self, sampler_type: Annotated[SamplerType, MustBeMemberOf(SamplerType)]
+            self,
+            sampler_type: Annotated[SamplerType, MustBeMemberOf(SamplerType)]
     ):
         self._sampler_type = sampler_type
 
@@ -367,10 +369,10 @@ class EnergyCorrection:
         `ENERGY`: 0.6, 0.55, etc
         """
         numerator = (
-            self.hammer_efficiency
-            * self.borehole_diameter_correction
-            * self.sampler_correction
-            * self.rod_length_correction
+                self.hammer_efficiency
+                * self.borehole_diameter_correction
+                * self.sampler_correction
+                * self.rod_length_correction
         )
         return numerator / self.energy_percentage
 
@@ -399,7 +401,7 @@ class OPC:
 
     @eop.setter
     @validate_params
-    def eop(self, eop: Annotated[float, MustBeNonNegative]):
+    def eop(self, eop: Annotated[float, MustBeNonNegative()]):
         """Effective overburden pressure ($kPa$)."""
         self._eop = eop
 
@@ -411,10 +413,10 @@ class OPC:
     @std_spt_n_value.setter
     @validate_params
     def std_spt_n_value(
-        self,
-        std_spt_n_value: 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 = std_spt_n_value
 
@@ -444,8 +446,9 @@ class GibbsHoltzOPC(OPC):
     @eop.setter
     @validate_params
     def eop(
-        self,
-        eop: Annotated[float, MustBeBetween(min_value=0.0, max_value=280.0)],
+            self,
+            eop: Annotated[
+                float, MustBeBetween(min_value=0.0, max_value=280.0)],
     ):
         self._eop = eop
 
@@ -538,10 +541,10 @@ class DilatancyCorrection:
     @corr_spt_n_value.setter
     @validate_params
     def corr_spt_n_value(
-        self,
-        corr_spt_n_value: 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 = corr_spt_n_value
 
@@ -587,9 +590,9 @@ _opctypes = {
 
 @validate_params
 def create_overburden_pressure_correction(
-    std_spt_n_value: float,
-    eop: float,
-    opc_type: Annotated[OPCType | str, MustBeMemberOf(OPCType)] = "gibbs",
+        std_spt_n_value: float,
+        eop: float,
+        opc_type: Annotated[OPCType | str, MustBeMemberOf(OPCType)] = "gibbs",
 ):
     """A factory function that encapsulates the creation of overburden
     pressure correction.

geolysis/utils/__init__.py

@@ -5,7 +5,7 @@ from typing import Callable
 from .math import *
 from . import math as m
 
-__all__ = ["AbstractStrEnum", "add_repr", "round_"] + m.__all__
+__all__ = ["AbstractStrEnum", "round_"] + m.__all__
 
 
 class StrEnumMeta(enum.EnumMeta):
@@ -26,23 +26,6 @@ class AbstractStrEnum(enum.StrEnum, metaclass=StrEnumMeta):
     """
 
 
-def add_repr(cls):
-    """A class decorator that adds a __repr__ method to the class."""
-
-    def __repr__(self) -> str:
-        inst_attrs = self.__dict__
-        attrs = (f"{key.strip('_')}={val}" for key, val in inst_attrs.items())
-        return f"{type(self).__name__}({', '.join(attrs)})"
-
-    def __str__(self) -> str:
-        return repr(self)
-
-    cls.__repr__ = __repr__
-    cls.__str__ = __str__
-
-    return cls
-
-
 def round_(ndigits: int) -> Callable:
     """A decorator that rounds the result of a callable to a specified
     number of decimal places.

{geolysis-0.18.0.dist-info → geolysis-0.20.0.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: geolysis
-Version: 0.18.0
+Version: 0.20.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.20.0.dist-info/RECORD

@@ -0,0 +1,23 @@
+geolysis/__init__.py,sha256=rYeTl8-JY-5Tj1wQlcLuXeKWx3Iw_y-_ZJyE4VP6ynY,161
+geolysis/exceptions.py,sha256=NocUF7-vaFsBJyi0QmH2EBFCpO2RT90RLEB66BCW_X0,74
+geolysis/foundation.py,sha256=bJ3TtJXSJ7ckjhhZhDE4KS8XAmh4NacFa3y4YHwo-G4,13258
+geolysis/soil_classifier.py,sha256=bZl8f7mMiRWHqdftzLbBok8RoP13W1AgQiRUeqrbef0,27941
+geolysis/spt.py,sha256=DEYdOjIg2JcfcR-UqL8sSW_Sj6GsrzjaioITol2tFQE,17513
+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=kwWGekawMUnMzFrgKhnKsohFBOEzZ3a0MIfb_vy5g_o,2943
+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=olc5EYJ761wSMTfhxd59PX_lSjQnIMH-VgziaNyOYE8,4306
+geolysis/bearing_capacity/ubc/_core.py,sha256=HRjDxXCR6DdtwJhRx9ZDNJjfYiuf3ELdUlmlrQzlq2g,8270
+geolysis/bearing_capacity/ubc/_terzaghi_ubc.py,sha256=3xroPeHvDgb7h6HytUHbtkK5f8lkPraUNHvbqUkgvIw,4363
+geolysis/bearing_capacity/ubc/_vesic_ubc.py,sha256=FvtLBUvR0t9O4N6WYuM6VqWuj55O7sZBZ2_RT1RkijM,6934
+geolysis/utils/__init__.py,sha256=_KUctxGCiI9I-faB1iXMy-H1BQeU2LW9TmSpdDNy0Yw,1331
+geolysis/utils/math.py,sha256=Nqg6SFIy3peSC-n-rq0KjryOdWTqh9jCF2L_qvx5Yg8,1231
+geolysis-0.20.0.dist-info/licenses/LICENSE.txt,sha256=ap6sMs3lT7ICbEXBhgihwH1BTCVcjmCQkIkwVnil1Ak,1065
+geolysis-0.20.0.dist-info/METADATA,sha256=MGAevwbhepXtJJhluB6bc37LW19AobiZuiyKt_7DQI8,6833
+geolysis-0.20.0.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
+geolysis-0.20.0.dist-info/top_level.txt,sha256=9mnQgOaCRr11dtXff8X-q3FfXjRONd6kHseSy5q2y8g,9
+geolysis-0.20.0.dist-info/RECORD,,

geolysis-0.18.0.dist-info/RECORD

@@ -1,23 +0,0 @@
-geolysis/__init__.py,sha256=7N_ThGwXWmtndvNkpcgc08s6wzi7BSfOI8q87D8p9Ak,161
-geolysis/exceptions.py,sha256=NocUF7-vaFsBJyi0QmH2EBFCpO2RT90RLEB66BCW_X0,74
-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
-geolysis/bearing_capacity/abc/_cohl/__init__.py,sha256=eelKtboxHhzq1uBcaW5liUqSUUpiWoDeg5ufO2beRHY,3351
-geolysis/bearing_capacity/abc/_cohl/_core.py,sha256=99l3RuK5eq7VSjdu4gfMfxSqkX72pgVz5qpZosshsnc,2919
-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=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.18.0.dist-info/licenses/LICENSE.txt,sha256=ap6sMs3lT7ICbEXBhgihwH1BTCVcjmCQkIkwVnil1Ak,1065
-geolysis-0.18.0.dist-info/METADATA,sha256=qcGkhtECL4tHi2yZwKMsbwOBhLc0TbKEZ0tEXjxswNU,6833
-geolysis-0.18.0.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
-geolysis-0.18.0.dist-info/top_level.txt,sha256=9mnQgOaCRr11dtXff8X-q3FfXjRONd6kHseSy5q2y8g,9
-geolysis-0.18.0.dist-info/RECORD,,