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

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

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: geolysis
-Version: 0.11.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
@@ -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
@@ -154,7 +161,7 @@ $ pip install geolysis
 >>> 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'
@@ -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.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,188 +0,0 @@
-from geolysis.foundation import Shape
-from geolysis.utils import cos, cot, exp, isclose, pi, round_, sin, tan
-
-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 cot(friction_angle) * (
-                HansenBearingCapacityFactors.n_q(friction_angle) - 1.0
-        )
-
-    @staticmethod
-    @round_(ndigits=2)
-    def n_q(friction_angle: float) -> float:
-        return tan(45.0 + friction_angle / 2.0) ** 2.0 * exp(
-            pi * tan(friction_angle))
-
-    @staticmethod
-    @round_(ndigits=2)
-    def n_gamma(friction_angle: float) -> float:
-        return (
-                1.8
-                * (HansenBearingCapacityFactors.n_q(friction_angle) - 1.0)
-                * tan(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 - sin(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 * sin(load_angle)) / cos(load_angle)
-
-    @staticmethod
-    @round_(ndigits=2)
-    def i_gamma(load_angle: float) -> float:
-        return HansenInclinationFactors.i_q(load_angle) ** 2.0
-
-
-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.11.0.dist-info/RECORD

@@ -1,22 +0,0 @@
-geolysis/__init__.py,sha256=ZeA59xkCLwiAA8wj2WyZEBkQlW1_JDu8nNCjTzJq96I,161
-geolysis/foundation.py,sha256=khmZCa8V-UEqp7A4WlIwt8Oy5tVQdT0UsaLMuxEbDQU,12819
-geolysis/soil_classifier.py,sha256=Rv1LiJID4DalpZPT0s0ulOkwR_1aZh2px8k8xpG6w-4,27437
-geolysis/spt.py,sha256=GfFf4j2AilqQCrAOeJJBmk0vXcOCJ8XorUilsC1X13Y,17179
-geolysis/utils.py,sha256=UnfRaz0MXxBxipcyezYMsxl5LuUTPl_kTztNQ94B8gA,2461
-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=1YeOe2YYUr6UHdaOjNQoy_PcZo8VTdouz-j2kpdEVqU,2094
-geolysis/bearing_capacity/abc/_cohl/bowles_abc.py,sha256=70SCvyxKVtjE-gPO5YxnQ_098mkBBUjjQ3F_BQZYGVY,2448
-geolysis/bearing_capacity/abc/_cohl/meyerhof_abc.py,sha256=mIvqXoMLJ9z7JDEUQYPV1n2Ssn0z6CYL8qFNU2PcKqk,2411
-geolysis/bearing_capacity/abc/_cohl/terzaghi_abc.py,sha256=P6pCmDK-a2ZFL06dTkVUJ2jlE4CGEvgVAk5nToCZqy0,3270
-geolysis/bearing_capacity/ubc/__init__.py,sha256=yaFFsmOb4q88-nfzilOcgYmb1_x2D2Tg2Po3XTKc52g,4483
-geolysis/bearing_capacity/ubc/_core.py,sha256=oXt11GeMRbsRVMC0zNpIQDspb0W4RYKRxOm5K35Po_E,6114
-geolysis/bearing_capacity/ubc/_hansen_ubc.py,sha256=_VmTUD3hlAylNnLWQW0wwhEEz17EM1WPGtfb9LtnrBk,5559
-geolysis/bearing_capacity/ubc/_terzaghi_ubc.py,sha256=Vo1GXBTJWxfE3QZ1u6hMfw1P3VkHGKxlEdvLBr8h-7A,5272
-geolysis/bearing_capacity/ubc/_vesic_ubc.py,sha256=ThyPHXRGbLHyhThMkUUp5ABknYj0K_xkwNiML_Ua0sM,5752
-geolysis-0.11.0.dist-info/licenses/LICENSE.txt,sha256=ap6sMs3lT7ICbEXBhgihwH1BTCVcjmCQkIkwVnil1Ak,1065
-geolysis-0.11.0.dist-info/METADATA,sha256=_03ifJZXSKZAdjP3HoazS_yqhYfueYBmlNRFKLkp7DI,6814
-geolysis-0.11.0.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
-geolysis-0.11.0.dist-info/top_level.txt,sha256=9mnQgOaCRr11dtXff8X-q3FfXjRONd6kHseSy5q2y8g,9
-geolysis-0.11.0.dist-info/RECORD,,