geolysis 0.4.3__py3-none-any.whl → 0.4.4__py3-none-any.whl

geolysis/utils/validators.py

@@ -0,0 +1,80 @@
+"""validators"""
+import operator
+from typing import Callable, TypeAlias
+
+Number: TypeAlias = int | float
+
+
+def _num_validator(bound: float, /, *,
+                   compare_symbol: str,
+                   compare_fn: Callable,
+                   err_msg: str,
+                   exc_type: Callable):
+    def dec(fn):
+        def wrapper(obj, val):
+            if not compare_fn(val, bound):
+                msg = f"{fn.__name__} must be {compare_symbol} {bound}"
+                raise exc_type(err_msg if err_msg else msg)
+            fn(obj, val)
+
+        return wrapper
+
+    return dec
+
+
+def _len_validator(bound: float, /, *,
+                   compare_symbol: str,
+                   compare_fn: Callable,
+                   err_msg: str,
+                   exc_type: Callable):
+    def dec(fn):
+        def wrapper(obj, val):
+            _len = len(val)
+            if not compare_fn(_len, bound):
+                msg = f"Length of '{fn.__name__}' must be {compare_symbol} {bound}"
+                raise exc_type(err_msg if err_msg else msg)
+            return fn(obj, val)
+
+        return wrapper
+
+    return dec
+
+
+def min_len(m_len: int, /, *, exc_type=ValueError, err_msg=None):
+    return _len_validator(m_len, compare_symbol=">=",
+                          compare_fn=operator.ge,
+                          err_msg=err_msg,
+                          exc_type=exc_type)
+
+
+# def lt(val: Number, /, *, exc_type=ValueError, err_msg=None):
+#     return _NumberValidator(val, "<", operator.lt, exc_type, err_msg)
+
+
+def le(val: Number, /, *, exc_type=ValueError, err_msg=None):
+    return _num_validator(val, compare_symbol="<=",
+                          compare_fn=operator.le,
+                          err_msg=err_msg,
+                          exc_type=exc_type)
+
+
+# def eq(val: Number, /, *, exc_type=ValueError, err_msg=None):
+#     return _NumberValidator(val, "==", operator.eq, exc_type, err_msg)
+
+
+# def ne(val: Number, /, *, exc_type=ValueError, err_msg=None):
+#     return _NumberValidator(val, "!=", operator.ne, exc_type, err_msg)
+
+
+def ge(val: Number, /, *, exc_type=ValueError, err_msg=None):
+    return _num_validator(val, compare_symbol=">=",
+                          compare_fn=operator.ge,
+                          err_msg=err_msg,
+                          exc_type=exc_type)
+
+
+def gt(val: Number, /, *, exc_type=ValueError, err_msg=None):
+    return _num_validator(val, compare_symbol=">",
+                          compare_fn=operator.gt,
+                          err_msg=err_msg,
+                          exc_type=exc_type)

{geolysis-0.4.3.dist-info → geolysis-0.4.4.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.2
 Name: geolysis
-Version: 0.4.3
+Version: 0.4.4
 Summary: geolysis is an opensource software for geotechnical engineering analysis and modeling.
 Author-email: Patrick Boateng <boatengpato.pb@gmail.com>
 License: MIT License
@@ -159,18 +159,45 @@ SoilClf(symbol='A-6(4)', description='Clayey soils')
 
 ```
 
+Check out more examples
+[here](https://docs.geolysis.io/en/latest/user_guide/getting_started.html#quick-start)
+
 ## Features
 
-|                                              |                                       |
-|----------------------------------------------|---------------------------------------|
-| **Soil Classification**                      | AASHTO Classification System          |
-|                                              | Unified Soil Classification System    |
-| **Standard Penetration Test (SPT) Analysis** | SPT Energy Correction                 |
-|                                              | SPT Overburden Pressure Correction    |
-|                                              | Dilatancy Correction                  |
-|                                              | SPT N-Design Calculation              |
-| **Bearing Capacity Estimation**              | Allowable Bearing Capacity Estimation |
-|                                              | Ultimate Bearing Capacity Estimation  |
+<table>
+    <tr>
+        <td><strong>Soil Classification</strong></td>
+        <td>AASHTO Classification System</td>
+    </tr>
+    <tr>
+        <td></td>
+        <td>Unified Soil Classification System</td>
+    </tr>
+    <tr>
+        <td><strong>Standard Penetration Test (SPT) Analysis</strong></td>
+        <td>SPT Energy Correction</td>
+    </tr>
+    <tr>
+        <td></td>
+        <td>SPT Overburden Pressure Correction</td>
+    </tr>
+    <tr>
+        <td></td>
+        <td>Dilatancy Correction</td>
+    </tr>
+    <tr>
+        <td></td>
+        <td>SPT N-Design Calculation</td>
+    </tr>
+    <tr>
+        <td><strong>Bearing Capacity Estimation</strong></td>
+        <td>Allowable Bearing Capacity Estimation</td>
+    </tr>
+    <tr>
+        <td></td>
+        <td>Ultimate Bearing Capacity Estimation</td>
+    </tr>
+</table>
 
 ## Documentation
 

geolysis-0.4.4.dist-info/RECORD

@@ -0,0 +1,21 @@
+geolysis/__init__.py,sha256=MyIge95T6RDI2zo-8gn3ewgjx3Bs986rvy55fek6UV4,122
+geolysis/foundation.py,sha256=M6m8Pb7Bn7jdfD_77_RSXpAzZVpAiyQoWu1jJi_LVDE,10149
+geolysis/soil_classifier.py,sha256=vvO4OrxcXAqLe3a3c8jhkfIZWV375BnyefCXHNhQAaU,26760
+geolysis/spt.py,sha256=WI2KhaljsZ17qNhi99pFLswgZ167N1rR1udTcs_Czvc,14232
+geolysis/bearing_capacity/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+geolysis/bearing_capacity/abc/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+geolysis/bearing_capacity/abc/cohl/__init__.py,sha256=fqG8lxcFUWUpaP3kAk4zFLmFdSWfKuZsU1H6QM5z5nQ,6922
+geolysis/bearing_capacity/abc/cohl/bowles_abc.py,sha256=2S0EFRW-C2s5e3MF8wz-9JWov7NzNuWqJ4HlSuqMrS4,4231
+geolysis/bearing_capacity/abc/cohl/meyerhof_abc.py,sha256=wdWYn58NG7sYc-8ML-Yf7kS4PZnpOqghu6gwaH7UFsg,4197
+geolysis/bearing_capacity/abc/cohl/terzaghi_abc.py,sha256=SRawtG8M0jGGMmzEqOvu_nV1tJ-8wJCJQo4GepDREd8,5448
+geolysis/bearing_capacity/ubc/__init__.py,sha256=BgByVUK3t_EH5MXnEkd0IQOxqJqabYJZ02EoJq3zIac,11126
+geolysis/bearing_capacity/ubc/hansen_ubc.py,sha256=DM3gnF6OueUDbQq4L82bR7i2vFusr2x1uh3vmYfAKk4,7222
+geolysis/bearing_capacity/ubc/terzaghi_ubc.py,sha256=-mgSgqhceKaEzR0_zOQ2-wJTDPNpi-VQ3gg_lTxcqm0,6710
+geolysis/bearing_capacity/ubc/vesic_ubc.py,sha256=41TKVQf_5wsHTEuR08u4FS-Rtdc2WomV1JC9fBubKVY,7482
+geolysis/utils/__init__.py,sha256=Q3eBBOi_JKnydu6su-TswdI2bIT4PZ7V43NIIGaTj2w,2616
+geolysis/utils/validators.py,sha256=ETvqwXtBFE17keDE5plYcSOztFNbSuJVqB6M6SmxBaQ,2556
+geolysis-0.4.4.dist-info/LICENSE.txt,sha256=ap6sMs3lT7ICbEXBhgihwH1BTCVcjmCQkIkwVnil1Ak,1065
+geolysis-0.4.4.dist-info/METADATA,sha256=8X06eJ1edfSgMt4htbXtylGUrsdtvIoLmTYYVRYFffY,7444
+geolysis-0.4.4.dist-info/WHEEL,sha256=52BFRY2Up02UkjOa29eZOS2VxUrpPORXg1pkohGGUS8,91
+geolysis-0.4.4.dist-info/top_level.txt,sha256=9mnQgOaCRr11dtXff8X-q3FfXjRONd6kHseSy5q2y8g,9
+geolysis-0.4.4.dist-info/RECORD,,

geolysis-0.4.3.dist-info/RECORD

@@ -1,9 +0,0 @@
-geolysis/__init__.py,sha256=Nyg0pmk5ea9-SLCAFEIF96ByFx4-TJFtrqYPN-Zn6g4,22
-geolysis/foundation.py,sha256=KIZewS9-l_tSDtgy9Ym5ADHETTuho3GJPBguh3Y28fw,10149
-geolysis/soil_classifier.py,sha256=GsT7qNwfXjZh0zo1O2e7iTN35ywdvzEs4vgaaqYA7Lo,26786
-geolysis/spt.py,sha256=E8rg6wKL4jbX8Xz-p9KdyfGxcQr8TdoZR4ZA9eUU4aI,14246
-geolysis-0.4.3.dist-info/LICENSE.txt,sha256=ap6sMs3lT7ICbEXBhgihwH1BTCVcjmCQkIkwVnil1Ak,1065
-geolysis-0.4.3.dist-info/METADATA,sha256=-hGWQ3izaFfDhQ44lc7ZSM83WmllA-RbbQYuKqWKWUQ,7394
-geolysis-0.4.3.dist-info/WHEEL,sha256=52BFRY2Up02UkjOa29eZOS2VxUrpPORXg1pkohGGUS8,91
-geolysis-0.4.3.dist-info/top_level.txt,sha256=9mnQgOaCRr11dtXff8X-q3FfXjRONd6kHseSy5q2y8g,9
-geolysis-0.4.3.dist-info/RECORD,,