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

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_func_args
     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:
         sum_wgts = 0.0
 
         for i, corr_spt_n_val in enumerate(vals, start=1):
-            wgt = 1 / i ** 2
+            wgt = 1 / i**2
             sum_total += wgt * corr_spt_n_val
             sum_wgts += 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,7 @@ class EnergyCorrection:
     @recorded_spt_n_value.setter
     @validate_func_args
     def recorded_spt_n_value(
-            self,
-            val: Annotated[int, MustBeBetween(min_value=0, max_value=100)]
+        self, val: Annotated[int, MustBeBetween(min_value=0, max_value=100)]
     ) -> None:
         self._recorded_spt_value = val
 
@@ -267,8 +266,7 @@ class EnergyCorrection:
     @energy_percentage.setter
     @validate_func_args
     def energy_percentage(
-            self,
-            val: Annotated[float, MustBeBetween(min_value=0.0, max_value=1.0)]
+        self, val: Annotated[float, MustBeBetween(min_value=0.0, max_value=1.0)]
     ) -> None:
         self._energy_percentage = val
 
@@ -280,8 +278,7 @@ class EnergyCorrection:
     @borehole_diameter.setter
     @validate_func_args
     def borehole_diameter(
-            self, val: Annotated[
-                float, MustBeBetween(min_value=65.0, max_value=200.0)]
+        self, val: Annotated[float, MustBeBetween(min_value=65.0, max_value=200.0)]
     ) -> None:
         self._borehole_diameter = val
 
@@ -302,8 +299,7 @@ class EnergyCorrection:
     @hammer_type.setter
     @validate_func_args
     def hammer_type(
-            self,
-            hammer_type: Annotated[HammerType, MustBeMemberOf(HammerType)]
+        self, hammer_type: Annotated[HammerType, MustBeMemberOf(HammerType)]
     ):
         self._hammer_type = hammer_type
 
@@ -313,8 +309,7 @@ class EnergyCorrection:
 
     @sampler_type.setter
     @validate_func_args
-    def sampler_type(self,
-                     val: Annotated[SamplerType, MustBeMemberOf(SamplerType)]):
+    def sampler_type(self, val: Annotated[SamplerType, MustBeMemberOf(SamplerType)]):
         self._sampler_type = val
 
     @property
@@ -362,10 +357,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
 
@@ -406,8 +401,7 @@ class OPC:
     @std_spt_n_value.setter
     @validate_func_args
     def std_spt_n_value(
-            self, val: Annotated[
-                float, MustBeBetween(min_value=0.0, max_value=100.0)]
+        self, val: Annotated[float, MustBeBetween(min_value=0.0, max_value=100.0)]
     ):
         self._std_spt_n_value = val
 
@@ -436,8 +430,7 @@ class GibbsHoltzOPC(OPC):
 
     @eop.setter
     @validate_func_args
-    def eop(self, val: Annotated[
-        float, MustBeBetween(min_value=0.0, max_value=280.0)]):
+    def eop(self, val: Annotated[float, MustBeBetween(min_value=0.0, max_value=280.0)]):
         self._eop = val
 
     def correction(self) -> float:
@@ -529,8 +522,7 @@ class DilatancyCorrection:
     @corr_spt_n_value.setter
     @validate_func_args
     def corr_spt_n_value(
-            self, val: Annotated[
-                float, MustBeBetween(min_value=0.0, max_value=100.0)]
+        self, val: Annotated[float, MustBeBetween(min_value=0.0, max_value=100.0)]
     ):
         self._corr_spt_n_value = val
 
@@ -576,9 +568,9 @@ _opctypes = {
 
 @validate_func_args
 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.py → utils/__init__.py}

@@ -1,31 +1,12 @@
 import enum
 import functools
-import math
-from math import exp, inf, isclose, log10, pi, sqrt
-from statistics import fmean as mean
 from typing import Callable
 
 from func_validator import ValidationError
 
-__all__ = [
-    "AbstractStrEnum",
-    "ValidationError",
-    "inf",
-    "pi",
-    "deg2rad",
-    "rad2deg",
-    "tan",
-    "cot",
-    "sin",
-    "cos",
-    "arctan",
-    "round_",
-    "mean",
-    "exp",
-    "isclose",
-    "log10",
-    "sqrt",
-]
+from .math import *
+
+__all__ = ["AbstractStrEnum", "ValidationError", "add_repr", "round_"]
 
 
 class StrEnumMeta(enum.EnumMeta):
@@ -46,39 +27,21 @@ class AbstractStrEnum(enum.StrEnum, metaclass=StrEnumMeta):
     """
 
 
-def deg2rad(x: float, /) -> float:
-    """Convert angle x from degrees to radians."""
-    return math.radians(x)
-
-
-def rad2deg(x: float, /) -> float:
-    """Convert angle x from radians to degrees."""
-    return math.degrees(x)
-
-
-def tan(x: float, /) -> float:
-    """Return the tangent of x (measured in degrees)."""
-    return math.tan(deg2rad(x))
-
-
-def cot(x: float, /) -> float:
-    """Return the cotangent of x (measured in degrees)."""
-    return 1 / tan(x)
-
-
-def sin(x: float, /) -> float:
-    """Return the sine of x (measured in degrees)."""
-    return math.sin(deg2rad(x))
+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 cos(x: float, /) -> float:
-    """Return the cosine of x (measured in degrees)."""
-    return math.cos(deg2rad(x))
+    def __str__(self) -> str:
+        return repr(self)
 
+    cls.__repr__ = __repr__
+    cls.__str__ = __str__
 
-def arctan(x: float, /) -> float:
-    """Return the arc tangent (measured in degrees) of x."""
-    return rad2deg(math.atan(x))
+    return cls
 
 
 def round_(ndigits: int) -> Callable:

geolysis/utils/math.py

@@ -0,0 +1,57 @@
+import math
+from math import exp, inf, isclose, log10, pi, sqrt, isinf, atan
+from statistics import fmean as mean
+
+__all__ = [
+    "atan",
+    "inf",
+    "isinf",
+    "pi",
+    "deg2rad",
+    "rad2deg",
+    "tandeg",
+    "cotdeg",
+    "sindeg",
+    "cosdeg",
+    "arctandeg",
+    "mean",
+    "exp",
+    "isclose",
+    "log10",
+    "sqrt",
+]
+
+
+def deg2rad(x: float, /) -> float:
+    """Convert angle x from degrees to radians."""
+    return math.radians(x)
+
+
+def rad2deg(x: float, /) -> float:
+    """Convert angle x from radians to degrees."""
+    return math.degrees(x)
+
+
+def tandeg(x: float, /) -> float:
+    """Return the tangent of x (measured in degrees)."""
+    return math.tan(deg2rad(x))
+
+
+def cotdeg(x: float, /) -> float:
+    """Return the cotangent of x (measured in degrees)."""
+    return 1 / tandeg(x)
+
+
+def sindeg(x: float, /) -> float:
+    """Return the sine of x (measured in degrees)."""
+    return math.sin(deg2rad(x))
+
+
+def cosdeg(x: float, /) -> float:
+    """Return the cosine of x (measured in degrees)."""
+    return math.cos(deg2rad(x))
+
+
+def arctandeg(x: float, /) -> float:
+    """Return the arc tangent (measured in degrees) of x."""
+    return rad2deg(math.atan(x))

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

@@ -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.12.0.dist-info/RECORD

@@ -0,0 +1,23 @@
+geolysis/__init__.py,sha256=YeQEtgF2PcR6s7EYEqNbirBHSK4wkpkD0tu2P_JKe-w,161
+geolysis/foundation.py,sha256=F1PcVpwQLtdfuhF8qzsoTrDRBNd8G3dac3YVj0kUDNk,13677
+geolysis/soil_classifier.py,sha256=kbvfOSm6gtde0jTxY70FB0cfgVCEHeChrZErWkjJMW8,27334
+geolysis/spt.py,sha256=19FmnG3UNHbnJatZf3oZ2UazCb_a-knIvII67IonaIg,16940
+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=QtedY1gUAM5U3pyndxmQl2hMVL1obAAEBwQX1tiEoo0,2591
+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=Juenai6DJtQraeNmwQcr9V3L_TQgds89cJNIaCBac58,3236
+geolysis/bearing_capacity/ubc/__init__.py,sha256=6bZJ5pGgBIJkNOkrXE6ezkLXCu05mhrXiqIPFo6xW1o,4739
+geolysis/bearing_capacity/ubc/_core.py,sha256=gY1a73_fIrPu0y9MxuoSTdvMk4BZ2bLkPPqgy5VaRwg,8016
+geolysis/bearing_capacity/ubc/_hansen_ubc.py,sha256=IfH_dbHC0LGCyALw5qAuIaXxYEYloA0hlX6KIaXD46g,5630
+geolysis/bearing_capacity/ubc/_terzaghi_ubc.py,sha256=GvSN0u_RTejl6oaQrlHj9y3dZVWn2Y89bNRZLpFjrBk,4223
+geolysis/bearing_capacity/ubc/_vesic_ubc.py,sha256=z0F0t-AYTvcjkqrNKky7nMsRHsvLfPoMHrDptGpAoHM,6636
+geolysis/utils/__init__.py,sha256=r2CoOK29ucbQ7GGsWJg-qDsXBgzAeGv8LastI29b5ys,1795
+geolysis/utils/math.py,sha256=7_ipjdcQft3-8wTPNj-2wRq8Z7KEm_C2ymkraSrKuYw,1195
+geolysis-0.12.0.dist-info/licenses/LICENSE.txt,sha256=ap6sMs3lT7ICbEXBhgihwH1BTCVcjmCQkIkwVnil1Ak,1065
+geolysis-0.12.0.dist-info/METADATA,sha256=9waPtBu0xS4HDyhpe8VP7zBrsAZRhuif18k6MGTQKZw,6831
+geolysis-0.12.0.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
+geolysis-0.12.0.dist-info/top_level.txt,sha256=9mnQgOaCRr11dtXff8X-q3FfXjRONd6kHseSy5q2y8g,9
+geolysis-0.12.0.dist-info/RECORD,,

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,,