geolysis 0.11.0__tar.gz → 0.12.0__tar.gz

{geolysis-0.11.0 → geolysis-0.12.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: geolysis
-Version: 0.11.0
+Version: 0.12.0
 Summary: geolysis is an opensource software for geotechnical engineering analysis and modeling.
 Author-email: Patrick Boateng <boatengpato.pb@gmail.com>
 License: MIT License
@@ -57,7 +57,8 @@ The `geolysis` python package is among three other projects, `geolysis.excel`,
 `geolysis.gui`, and `geolysis.ai`. More details about these projects are
 provided [here](https://github.com/geolysis-dev).
 
-`geolysis` has only one project dependency which is [func-validator](https://github.com/patrickboateng/func-validator/)
+`geolysis` has only one project dependency which
+is [func-validator](https://github.com/patrickboateng/func-validator/)
 for validating `function` (and `method`) arguments.
 
 The rest of this **README** provides an overview of the `geolysis` python
@@ -83,58 +84,64 @@ $ pip install geolysis
 
 ## API Reference
 
-- [Python API](https://docs.geolysis.io/en/latest/reference/) 
-    - [geolysis.bearing_capacity.abc](https://docs.geolysis.io/en/latest/reference/allowable_bearing_capacity/) - _Allowable bearing capacity
+- [Python API](https://docs.geolysis.io/en/latest/reference/)
+    - [geolysis.bearing_capacity.abc](https://docs.geolysis.io/en/latest/reference/allowable_bearing_capacity/) -
+      _Allowable bearing capacity
       estimation_
-    - [geolysis.bearing_capacity.ubc](https://docs.geolysis.io/en/latest/reference/ultimate_bearing_capacity/) - _Ultimate bearing capacity
+    - [geolysis.bearing_capacity.ubc](https://docs.geolysis.io/en/latest/reference/ultimate_bearing_capacity/) -
+      _Ultimate bearing capacity
       estimation_
-    - [geolysis.foundation](https://docs.geolysis.io/en/latest/reference/foundation/) - _Foundation Representation_
-    - [geolysis.soil_classifier](https://docs.geolysis.io/en/latest/reference/soil_classifier/) - _Soil classification_
-    - [geolysis.spt](https://docs.geolysis.io/en/latest/reference/spt/) - _Standard Penetration Test (SPT) Analysis_
-    - [geolysis.utils](https://docs.geolysis.io/en/latest/reference/utils/) - _Utilities_
-
+    - [geolysis.foundation](https://docs.geolysis.io/en/latest/reference/foundation/) -
+      _Foundation Representation_
+    - [geolysis.soil_classifier](https://docs.geolysis.io/en/latest/reference/soil_classifier/) -
+      _Soil classification_
+    - [geolysis.spt](https://docs.geolysis.io/en/latest/reference/spt/) -
+      _Standard Penetration Test (SPT) Analysis_
+    - [geolysis.utils](https://docs.geolysis.io/en/latest/reference/utils/) -
+      _Utilities_
 
 ## Imports
 
-- **Bearing Capacity**
-
-    - **Allowable Bearing Capacity (ABC)**
-     
-      ```python
-      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
-      ```
-
-- **Foundation**
- 
-  ```python
-  from geolysis.foundation import create_foundation
-  ```
+### Bearing Capacity
+
+- **Allowable Bearing Capacity (ABC)**
+
+    ```python
+    from geolysis.bearing_capacity.abc import create_abc_4_cohesionless_soils
+    ```
 
+- **Ultimate Bearing Capacity (UBC)**
 
-- **Soil Classification**
- 
   ```python
-  from geolysis.soil_classifier import create_uscs_classifier
-  from geolysis.soil_classifier import create_aashto_classifier
+  from geolysis.bearing_capacity.ubc import create_ubc_4_all_soil_types
   ```
- 
-- **Standard Penetration Test (SPT) Analysis**
- 
+
+### Foundation
+
+```python
+from geolysis.foundation import create_foundation
+```
+
+### Soil Classification
+
+```python
+from geolysis.soil_classifier import create_uscs_classifier
+from geolysis.soil_classifier import create_aashto_classifier
+```
+
+### Standard Penetration Test (SPT) Analysis
+
   ```python
   from geolysis.spt import DilatancyCorrection
   from geolysis.spt import EnergyCorrection
   from geolysis.spt import SPT
   from geolysis.spt import create_overburden_pressure_correction
   ```
-  
+
 ## Project Structure
 
+These are the main components of the project structure
+
     .
     ├── .github            # GitHub Actions
     ├── docs               # Documentation files
@@ -171,7 +178,8 @@ Check out the full [documentation](https://docs.geolysis.io/en/latest/).
 
 ## Contributing
 
-Check out the [contribution guidelines](https://docs.geolysis.io/en/latest/dev_guide/)
+Check out
+the [contribution guidelines](https://docs.geolysis.io/en/latest/dev_guide/)
 
 ## License
 

{geolysis-0.11.0 → geolysis-0.12.0}/README.md

@@ -24,7 +24,8 @@ The `geolysis` python package is among three other projects, `geolysis.excel`,
 `geolysis.gui`, and `geolysis.ai`. More details about these projects are
 provided [here](https://github.com/geolysis-dev).
 
-`geolysis` has only one project dependency which is [func-validator](https://github.com/patrickboateng/func-validator/)
+`geolysis` has only one project dependency which
+is [func-validator](https://github.com/patrickboateng/func-validator/)
 for validating `function` (and `method`) arguments.
 
 The rest of this **README** provides an overview of the `geolysis` python
@@ -50,58 +51,64 @@ $ pip install geolysis
 
 ## API Reference
 
-- [Python API](https://docs.geolysis.io/en/latest/reference/) 
-    - [geolysis.bearing_capacity.abc](https://docs.geolysis.io/en/latest/reference/allowable_bearing_capacity/) - _Allowable bearing capacity
+- [Python API](https://docs.geolysis.io/en/latest/reference/)
+    - [geolysis.bearing_capacity.abc](https://docs.geolysis.io/en/latest/reference/allowable_bearing_capacity/) -
+      _Allowable bearing capacity
       estimation_
-    - [geolysis.bearing_capacity.ubc](https://docs.geolysis.io/en/latest/reference/ultimate_bearing_capacity/) - _Ultimate bearing capacity
+    - [geolysis.bearing_capacity.ubc](https://docs.geolysis.io/en/latest/reference/ultimate_bearing_capacity/) -
+      _Ultimate bearing capacity
       estimation_
-    - [geolysis.foundation](https://docs.geolysis.io/en/latest/reference/foundation/) - _Foundation Representation_
-    - [geolysis.soil_classifier](https://docs.geolysis.io/en/latest/reference/soil_classifier/) - _Soil classification_
-    - [geolysis.spt](https://docs.geolysis.io/en/latest/reference/spt/) - _Standard Penetration Test (SPT) Analysis_
-    - [geolysis.utils](https://docs.geolysis.io/en/latest/reference/utils/) - _Utilities_
-
+    - [geolysis.foundation](https://docs.geolysis.io/en/latest/reference/foundation/) -
+      _Foundation Representation_
+    - [geolysis.soil_classifier](https://docs.geolysis.io/en/latest/reference/soil_classifier/) -
+      _Soil classification_
+    - [geolysis.spt](https://docs.geolysis.io/en/latest/reference/spt/) -
+      _Standard Penetration Test (SPT) Analysis_
+    - [geolysis.utils](https://docs.geolysis.io/en/latest/reference/utils/) -
+      _Utilities_
 
 ## Imports
 
-- **Bearing Capacity**
-
-    - **Allowable Bearing Capacity (ABC)**
-     
-      ```python
-      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
-      ```
-
-- **Foundation**
- 
-  ```python
-  from geolysis.foundation import create_foundation
-  ```
+### Bearing Capacity
+
+- **Allowable Bearing Capacity (ABC)**
+
+    ```python
+    from geolysis.bearing_capacity.abc import create_abc_4_cohesionless_soils
+    ```
 
+- **Ultimate Bearing Capacity (UBC)**
 
-- **Soil Classification**
- 
   ```python
-  from geolysis.soil_classifier import create_uscs_classifier
-  from geolysis.soil_classifier import create_aashto_classifier
+  from geolysis.bearing_capacity.ubc import create_ubc_4_all_soil_types
   ```
- 
-- **Standard Penetration Test (SPT) Analysis**
- 
+
+### Foundation
+
+```python
+from geolysis.foundation import create_foundation
+```
+
+### Soil Classification
+
+```python
+from geolysis.soil_classifier import create_uscs_classifier
+from geolysis.soil_classifier import create_aashto_classifier
+```
+
+### Standard Penetration Test (SPT) Analysis
+
   ```python
   from geolysis.spt import DilatancyCorrection
   from geolysis.spt import EnergyCorrection
   from geolysis.spt import SPT
   from geolysis.spt import create_overburden_pressure_correction
   ```
-  
+
 ## Project Structure
 
+These are the main components of the project structure
+
     .
     ├── .github            # GitHub Actions
     ├── docs               # Documentation files
@@ -138,7 +145,8 @@ Check out the full [documentation](https://docs.geolysis.io/en/latest/).
 
 ## Contributing
 
-Check out the [contribution guidelines](https://docs.geolysis.io/en/latest/dev_guide/)
+Check out
+the [contribution guidelines](https://docs.geolysis.io/en/latest/dev_guide/)
 
 ## License
 

{geolysis-0.11.0 → geolysis-0.12.0}/geolysis/__init__.py

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

{geolysis-0.11.0 → geolysis-0.12.0}/geolysis/bearing_capacity/abc/_cohl/_core.py

@@ -1,4 +1,5 @@
 from abc import ABC, abstractmethod
+from dataclasses import dataclass
 from typing import Annotated
 
 from func_validator import (
@@ -8,17 +9,26 @@ from func_validator import (
 )
 
 from geolysis.foundation import Foundation
+from geolysis.utils import round_, add_repr
 
 
+@dataclass
+class AllowableBearingCapacityResult:
+    allowable_bearing_capacity: float
+    depth_factor: float
+    water_correction_factor: float = 1.0
+
+
+@add_repr
 class AllowableBearingCapacity(ABC):
     #: Maximum tolerable foundation settlement (mm).
     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 +52,8 @@ class AllowableBearingCapacity(ABC):
     @tol_settlement.setter
     @validate_func_args
     def tol_settlement(
-            self,
-            tol_settlement: Annotated[float, MustBeLessThanOrEqual(25.4)],
+        self,
+        tol_settlement: Annotated[float, MustBeLessThanOrEqual(25.4)],
     ):
         self._tol_settlement = tol_settlement
 
@@ -57,17 +67,24 @@ class AllowableBearingCapacity(ABC):
         width = self.foundation_size.width
         return min(1.0 + 0.33 * depth / width, 1.33)
 
-    def bearing_capacity_results(self) -> dict:
+    def bearing_capacity_results(self) -> AllowableBearingCapacityResult:
         """Return a dictionary of bearing capacity results with
         intermediate calculations.
 
         !!! info "Added in v0.11.0"
+        """
+        return AllowableBearingCapacityResult(
+            allowable_bearing_capacity=self.allowable_bearing_capacity(),
+            depth_factor=self._fd(),
+        )
+
+    @round_(ndigits=1)
+    def allowable_bearing_capacity(self):
+        """Calculates the allowable bearing capacity.
 
+        !!! info "Added in v0.12.0"
         """
-        return {
-            "bearing_capacity": self.bearing_capacity(),
-            "depth_factor": self._fd(),
-        }
+        return self._bearing_capacity()
 
     @abstractmethod
-    def bearing_capacity(self): ...
+    def _bearing_capacity(self): ...

{geolysis-0.11.0 → geolysis-0.12.0}/geolysis/bearing_capacity/abc/_cohl/bowles_abc.py

@@ -14,10 +14,10 @@ class BowlesABC4PadFoundation(AllowableBearingCapacity):
     """
 
     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:
         """
         :param corrected_spt_n_value: Statistical average of corrected
@@ -35,7 +35,7 @@ class BowlesABC4PadFoundation(AllowableBearingCapacity):
         )
 
     @round_(ndigits=2)
-    def bearing_capacity(self) -> float:
+    def _bearing_capacity(self) -> float:
         """
         Calculate the allowable bearing capacity of the pad foundation.
         """
@@ -46,11 +46,11 @@ class BowlesABC4PadFoundation(AllowableBearingCapacity):
             return 19.16 * n_corr * self._fd() * self._sr()
 
         return (
-                11.98
-                * n_corr
-                * ((3.28 * width + 1) / (3.28 * width)) ** 2
-                * self._fd()
-                * self._sr()
+            11.98
+            * n_corr
+            * ((3.28 * width + 1) / (3.28 * width)) ** 2
+            * self._fd()
+            * self._sr()
         )
 
 
@@ -64,7 +64,7 @@ class BowlesABC4MatFoundation(BowlesABC4PadFoundation):
     """
 
     @round_(ndigits=2)
-    def bearing_capacity(self) -> float:
+    def _bearing_capacity(self) -> float:
         """
         Calculate the allowable bearing capacity of the mat foundation.
         """

{geolysis-0.11.0 → geolysis-0.12.0}/geolysis/bearing_capacity/abc/_cohl/meyerhof_abc.py

@@ -14,10 +14,10 @@ class MeyerhofABC4PadFoundation(AllowableBearingCapacity):
     """
 
     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,
     ):
         """
         :param corrected_spt_n_value: Average uncorrected SPT N-value
@@ -35,7 +35,7 @@ class MeyerhofABC4PadFoundation(AllowableBearingCapacity):
         )
 
     @round_(ndigits=2)
-    def bearing_capacity(self):
+    def _bearing_capacity(self):
         """
         Calculates the allowable bearing capacity of the pad foundation.
         """
@@ -46,11 +46,11 @@ class MeyerhofABC4PadFoundation(AllowableBearingCapacity):
             return 12 * n_corr * self._fd() * self._sr()
 
         return (
-                8
-                * n_corr
-                * ((3.28 * width + 1) / (3.28 * width)) ** 2
-                * self._fd()
-                * self._sr()
+            8
+            * n_corr
+            * ((3.28 * width + 1) / (3.28 * width)) ** 2
+            * self._fd()
+            * self._sr()
         )
 
 
@@ -64,7 +64,7 @@ class MeyerhofABC4MatFoundation(MeyerhofABC4PadFoundation):
     """
 
     @round_(ndigits=2)
-    def bearing_capacity(self):
+    def _bearing_capacity(self):
         """Calculate the allowable bearing capacity of the mat foundation."""
         n_corr = self.corrected_spt_n_value
         return 8 * n_corr * self._fd() * self._sr()

{geolysis-0.11.0 → geolysis-0.12.0}/geolysis/bearing_capacity/abc/_cohl/terzaghi_abc.py

@@ -14,10 +14,10 @@ class TerzaghiABC4PadFoundation(AllowableBearingCapacity):
     """
 
     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:
         """
         :param corrected_spt_n_value: Lowest (or average) uncorrected
@@ -57,7 +57,7 @@ class TerzaghiABC4PadFoundation(AllowableBearingCapacity):
         return min(cw, 2.0)
 
     @round_(ndigits=2)
-    def bearing_capacity(self):
+    def _bearing_capacity(self):
         """
         Calculates the allowable bearing capacity of the pad foundation.
         """
@@ -68,11 +68,11 @@ class TerzaghiABC4PadFoundation(AllowableBearingCapacity):
             return 12 * n_corr * (1 / (self._cw() * self._fd())) * self._sr()
 
         return (
-                8
-                * n_corr
-                * ((3.28 * width + 1) / (3.28 * width)) ** 2
-                * (1 / (self._cw() * self._fd()))
-                * self._sr()
+            8
+            * n_corr
+            * ((3.28 * width + 1) / (3.28 * width)) ** 2
+            * (1 / (self._cw() * self._fd()))
+            * self._sr()
         )
 
     def bearing_capacity_results(self) -> dict:
@@ -91,7 +91,7 @@ class TerzaghiABC4MatFoundation(TerzaghiABC4PadFoundation):
     """
 
     @round_(ndigits=2)
-    def bearing_capacity(self):
+    def _bearing_capacity(self):
         """
         Calculates the allowable bearing capacity of the mat foundation.
         """

{geolysis-0.11.0 → geolysis-0.12.0}/geolysis/bearing_capacity/ubc/__init__.py

@@ -46,18 +46,19 @@ class UBCType(AbstractStrEnum):
 
 @validate_func_args
 def create_ubc_4_all_soil_types(
-    friction_angle: float,
-    cohesion: float,
-    moist_unit_wgt: float,
-    depth: float,
-    width: float,
-    length: Optional[float] = None,
-    eccentricity: float = 0.0,
-    ground_water_level: Optional[float] = None,
-    load_angle: float = 0.0,
-    apply_local_shear: bool = False,
-    shape: Shape | str = "square",
-    ubc_type: Annotated[UBCType | str, MustBeMemberOf(UBCType)] = "hansen",
+        friction_angle: float,
+        cohesion: float,
+        moist_unit_wgt: float,
+        depth: float,
+        width: float,
+        length: Optional[float] = None,
+        saturated_unit_wgt: float = 20.5,
+        eccentricity: float = 0.0,
+        ground_water_level: Optional[float] = None,
+        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.
@@ -70,6 +71,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 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.
     :param ground_water_level: Depth of water below ground level (m).
@@ -101,12 +103,14 @@ def create_ubc_4_all_soil_types(
         shape=shape,
     )
 
-    ubc_class = _get_ultimate_bearing_capacity(ubc_type, fnd_size.footing_shape)
+    ubc_class = _get_ultimate_bearing_capacity(ubc_type,
+                                               fnd_size.footing_shape)
 
     return ubc_class(
         friction_angle=friction_angle,
         cohesion=cohesion,
         moist_unit_wgt=moist_unit_wgt,
+        saturated_unit_wgt=saturated_unit_wgt,
         foundation_size=fnd_size,
         apply_local_shear=apply_local_shear,
     )