geolysis 0.10.0__py3-none-any.whl → 0.10.2__py3-none-any.whl

geolysis/__init__.py

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

geolysis/bearing_capacity/abc/_cohl/_core.py

@@ -15,10 +15,10 @@ class AllowableBearingCapacity(ABC):
     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,7 +42,7 @@ 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
 
@@ -56,5 +56,11 @@ class AllowableBearingCapacity(ABC):
         width = self.foundation_size.width
         return min(1.0 + 0.33 * depth / width, 1.33)
 
+    def bearing_capacity_results(self) -> dict:
+        return {
+            "bearing_capacity": self.bearing_capacity(),
+            "depth_factor": self._fd(),
+        }
+
     @abstractmethod
     def bearing_capacity(self): ...

geolysis/bearing_capacity/abc/_cohl/terzaghi_abc.py

@@ -103,6 +103,11 @@ class TerzaghiABC4PadFoundation(AllowableBearingCapacity):
                 * self._sr()
         )
 
+    def bearing_capacity_results(self) -> dict:
+        res = super().bearing_capacity_results()
+        res["water_correction_factor"] = self._cw()
+        return res
+
 
 class TerzaghiABC4MatFoundation(TerzaghiABC4PadFoundation):
     r"""Allowable bearing capacity for mat foundation on cohesionless

geolysis/bearing_capacity/ubc/_core.py

@@ -195,6 +195,23 @@ class UltimateBearingCapacity(ABC):
                 + self._embedment_term(0.5)
         )
 
+    def bearing_capacity_results(self) -> dict:
+        return {
+            "bearing_capacity": self.bearing_capacity(),
+            "n_c": self.n_c,
+            "n_q": self.n_q,
+            "n_gamma": self.n_gamma,
+            "s_c": self.s_c,
+            "s_q": self.s_q,
+            "s_gamma": self.s_gamma,
+            "d_c": self.d_c,
+            "d_q": self.d_q,
+            "d_gamma": self.d_gamma,
+            "i_c": self.i_c,
+            "i_q": self.i_q,
+            "i_gamma": self.i_gamma,
+        }
+
     @property
     @abstractmethod
     def n_c(self) -> float:

geolysis/soil_classifier.py

@@ -657,9 +657,7 @@ class USCS:
     ):
         """
         :param atterberg_limits: Atterberg limits of the soil.
-
         :param psd: Particle size distribution of the soil.
-
         :param organic: Indicates whether soil is organic or not.
         """
         self.atterberg_limits = atterberg_limits
@@ -782,7 +780,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.

{geolysis-0.10.0.dist-info → geolysis-0.10.2.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: geolysis
-Version: 0.10.0
+Version: 0.10.2
 Summary: geolysis is an opensource software for geotechnical engineering analysis and modeling.
 Author-email: Patrick Boateng <boatengpato.pb@gmail.com>
 License: MIT License
@@ -24,6 +24,7 @@ Classifier: Topic :: Scientific/Engineering
 Requires-Python: >=3.11
 Description-Content-Type: text/markdown
 License-File: LICENSE.txt
+Requires-Dist: func-validator
 Provides-Extra: dev
 Requires-Dist: pytest; extra == "dev"
 Requires-Dist: pytest-cov; extra == "dev"
@@ -56,6 +57,9 @@ 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/)
+for validating `function` (and `method`) arguments.
+
 The rest of this **README** provides an overview of the `geolysis` python
 package.
 

{geolysis-0.10.0.dist-info → geolysis-0.10.2.dist-info}/RECORD

@@ -1,22 +1,22 @@
-geolysis/__init__.py,sha256=_BzryYcgDYjfkWn75IfellVNRi3uyzQcTD4P8z7pElE,161
+geolysis/__init__.py,sha256=KhU464V_BkITyZRQohK6zh_d5Lt3y2sQ57B1hXvMlko,161
 geolysis/foundation.py,sha256=khmZCa8V-UEqp7A4WlIwt8Oy5tVQdT0UsaLMuxEbDQU,12819
-geolysis/soil_classifier.py,sha256=rScsrMR7mNOkKuWWiduJzsakibyYR2S0-tLrXbYSobQ,27427
+geolysis/soil_classifier.py,sha256=gPOl9Fr18r4aDtVBFK5KdWdsLIvpTLLMTt7YU49noSA,27442
 geolysis/spt.py,sha256=_AWfs5Ho5ScCwPlVDNh6cuhcLOR4-u7Dr7UoagRlDoM,18620
 geolysis/utils.py,sha256=hgAeuMoGxL_GRbzYD3jZHglFxAmeqUa8FBqM0sm40lc,2394
 geolysis/bearing_capacity/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 geolysis/bearing_capacity/abc/__init__.py,sha256=QCSni6_QI059y3JF5UU9Gd_wAyVLmVEMR7ajq_EZQRg,518
 geolysis/bearing_capacity/abc/_cohl/__init__.py,sha256=M1EBn2WMgtG-Dg-LT7N-OVke6upwL6plqyPCn3ebR0M,4110
-geolysis/bearing_capacity/abc/_cohl/_core.py,sha256=Ix6bSkTlP0zxN6CuH_lHT1B3ug9ZvbGjOImlU4IABOU,1739
+geolysis/bearing_capacity/abc/_cohl/_core.py,sha256=YhU6wDVaMOxMUGQ0QHKCeD0eHHTj3la_R3iBBF1-hl0,1932
 geolysis/bearing_capacity/abc/_cohl/bowles_abc.py,sha256=AC0OslIUZBxC5ClB0HNvLoVDwnt982l8OGPuxyE2uZ0,3153
 geolysis/bearing_capacity/abc/_cohl/meyerhof_abc.py,sha256=Zf4X6YVrPMH5Sgm0bORbWe4RgfO-jVJBdeRWl8jBRH8,3056
-geolysis/bearing_capacity/abc/_cohl/terzaghi_abc.py,sha256=KKutVHYRFlS5SFFRVJEMKOfROFPk5MnCgQ6LmIdv1ow,4131
+geolysis/bearing_capacity/abc/_cohl/terzaghi_abc.py,sha256=za5Altz8uzIqY0RJML8FTCIIyRSyHN04j7y80zop6JA,4300
 geolysis/bearing_capacity/ubc/__init__.py,sha256=5EtGLFW0vwCfUGxQDKPQJ687C9AKRlbYEPYb2aY2AgA,4578
-geolysis/bearing_capacity/ubc/_core.py,sha256=Fbp5AXdixDUAL4YRz-BP92AHhYL1ROBOX_FEVUGxEaw,6057
+geolysis/bearing_capacity/ubc/_core.py,sha256=GfE0ZzPqC5VJ8PakR5ZiFvsfSwuEYrEzuPOuVdLnz_Q,6570
 geolysis/bearing_capacity/ubc/_hansen_ubc.py,sha256=aVu40WFCtvstWNq3x65Klb9am4UfJq00MtfaJYIwifI,6995
 geolysis/bearing_capacity/ubc/_terzaghi_ubc.py,sha256=U9mt92glUuooXnd_NPOFDpEdG15bTdb_KPPXLu5zjPw,5503
 geolysis/bearing_capacity/ubc/_vesic_ubc.py,sha256=a8TvlJCZ4AMU_YEVE0DEXb_Eo75uVOtOLDg-mC3zYlc,7034
-geolysis-0.10.0.dist-info/licenses/LICENSE.txt,sha256=ap6sMs3lT7ICbEXBhgihwH1BTCVcjmCQkIkwVnil1Ak,1065
-geolysis-0.10.0.dist-info/METADATA,sha256=l5am6GR_xC1gpLUEVO-Ase9kCGXrBxocPLiVcMtkXYg,6611
-geolysis-0.10.0.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
-geolysis-0.10.0.dist-info/top_level.txt,sha256=9mnQgOaCRr11dtXff8X-q3FfXjRONd6kHseSy5q2y8g,9
-geolysis-0.10.0.dist-info/RECORD,,
+geolysis-0.10.2.dist-info/licenses/LICENSE.txt,sha256=ap6sMs3lT7ICbEXBhgihwH1BTCVcjmCQkIkwVnil1Ak,1065
+geolysis-0.10.2.dist-info/METADATA,sha256=C7k4XQDahVEox37SMS8gCtjLjKMFeJZMlZzgGj-aWM0,6814
+geolysis-0.10.2.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
+geolysis-0.10.2.dist-info/top_level.txt,sha256=9mnQgOaCRr11dtXff8X-q3FfXjRONd6kHseSy5q2y8g,9
+geolysis-0.10.2.dist-info/RECORD,,