geolysis 0.2.0__py3-none-any.whl → 0.4.2__py3-none-any.whl

geolysis/utils.py

@@ -1,106 +1,78 @@
-import functools
-import math
-from math import ceil, exp, isclose, log10
-from math import pi as PI
-from math import sqrt
-from statistics import fmean as mean
-from typing import Callable, TypeAlias
-
-__all__ = [
-    "deg2rad",
-    "rad2deg",
-    "tan",
-    "cot",
-    "sin",
-    "cos",
-    "arctan",
-    "round_",
-]
-
-FloatOrInt: TypeAlias = float | int
-
-
-def deg2rad(__x: FloatOrInt, /) -> float:
-    """
-    Convert angle x from degrees to radians.
-    """
-    return math.radians(__x)
-
-
-def rad2deg(__x: FloatOrInt, /) -> float:
-    """
-    Convert angle x from radians to degrees.
-    """
-    return math.degrees(__x)
-
-
-def tan(__x: FloatOrInt, /) -> float:
-    """
-    Return the tangent of x (measured in degrees).
-    """
-    return math.tan(deg2rad(__x))
-
-
-def cot(__x: FloatOrInt, /) -> float:
-    """
-    Return the cotangent of x (measured in degrees).
-    """
-    return 1 / tan(__x)
-
-
-def sin(__x: FloatOrInt, /) -> float:
-    """
-    Return the sine of x (measured in degrees).
-    """
-    return math.sin(deg2rad(__x))
-
-
-def cos(__x: FloatOrInt, /) -> float:
-    """
-    Return the cosine of x (measured in degrees).
-    """
-    return math.cos(deg2rad(__x))
-
-
-def arctan(__x: FloatOrInt, /) -> float:
-    """
-    Return the arc tangent (measured in degrees) of x.
-    """
-    return rad2deg(math.atan(__x))
-
-
-def round_(ndigits: int) -> Callable:
-    """
-    A decorator that rounds the result of a function to a specified number of
-    decimal places.
-
-    :param int ndigits: The number of decimal places to round to.
-
-    :return: A decorator that rounds the result of the wrapped function.
-    :rtype: Callable[..., float]
-
-    :raises TypeError: If precision is not an int.
-
-    .. note::
-
-        This decorator can only be used with functions that return a float or a
-        datatype that implements ``__round__``.
-    """
-
-    def dec(
-        func: Callable[..., float],
-        /,
-        *,
-        ndigits: int,
-    ) -> Callable[..., float]:
-        @functools.wraps(func)
-        def wrapper(*args, **kwargs) -> float:
-            return round(func(*args, **kwargs), ndigits=ndigits)
-
-        return wrapper
-
-    if isinstance(ndigits, int):
-        return functools.partial(dec, ndigits=ndigits)  # return decorator
-
-    err_msg = "ndigits should be an int."
-    raise TypeError(err_msg)
+import functools
+import math
+from math import exp, inf, isclose, log10, pi, sqrt
+from statistics import fmean as mean
+from typing import Callable, SupportsRound
+
+__all__ = ["inf", "pi", "deg2rad", "rad2deg", "tan", "cot", "sin", "cos",
+           "arctan", "round_", "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 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 cos(x: float, /) -> float:
+    """Return the cosine of x (measured in degrees)."""
+    return math.cos(deg2rad(x))
+
+
+def arctan(x: float, /) -> float:
+    """Return the arc tangent (measured in degrees) of x."""
+    return rad2deg(math.atan(x))
+
+
+def round_(ndigits: int | Callable[..., SupportsRound]) -> Callable:
+    """A decorator that rounds the result of a callable to a specified number
+    of decimal places.
+
+    The returned value of the callable should support the ``__round__`` dunder
+    method and should be a numeric value. ``ndigits`` can either be an int
+    which will indicate the number of decimal places to round to or a
+    callable. If ``ndigits`` is callable the default decimal places is 2.
+
+    TypeError is raised when ``ndigits`` is neither an int nor a callable.
+    """
+
+    default_dp = 2
+
+    def dec(fn) -> Callable[..., float]:
+        @functools.wraps(fn)
+        def wrapper(*args, **kwargs) -> float:
+            dp = ndigits if not callable(ndigits) else default_dp
+            res = fn(*args, **kwargs)
+            return round(res, ndigits=dp)
+
+        return wrapper
+
+    # See if we're being called as @round_ or @round_().
+    # We're called with parens.
+    if isinstance(ndigits, int):
+        return dec
+
+    # We're called as @round_ without parens.
+    if callable(ndigits):
+        return dec(ndigits)
+
+    raise TypeError("ndigits must be an int or a callable")

geolysis/validators.py

@@ -0,0 +1,54 @@
+import operator
+from typing import Callable, TypeAlias
+
+
+class _NumberValidator:
+    def __init__(self, bound: float,
+                 compare_op: str,
+                 compare_fn: Callable,
+                 exc_type=ValueError,
+                 err_msg=None) -> None:
+        self.bound = bound
+        self.compare_op = compare_op
+        self.compare_fn = compare_fn
+        self.exc_type = exc_type
+        self.err_msg = err_msg
+
+    def __call__(self, fn):
+        def wrapper(obj, val):
+            if not self.compare_fn(val, self.bound):
+                if self.err_msg:
+                    msg = self.err_msg
+                else:
+                    msg = f"{fn.__name__} must be {self.compare_op} {self.bound}"
+                raise self.exc_type(msg)
+            return fn(obj, val)
+
+        return wrapper
+
+
+Number: TypeAlias = int | float
+
+
+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 _NumberValidator(val, "<=", operator.le, exc_type, err_msg)
+
+
+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 _NumberValidator(val, ">=", operator.ge, exc_type, err_msg)
+
+
+def gt(val: Number, /, *, exc_type=ValueError, err_msg=None):
+    return _NumberValidator(val, ">", operator.gt, exc_type, err_msg)

{geolysis-0.2.0.dist-info → geolysis-0.4.2.dist-info}/LICENSE.txt

@@ -1,21 +1,21 @@
-MIT License
-
-Copyright (c) 2023 geolysis
-
-Permission is hereby granted, free of charge, to any person obtaining a copy
-of this software and associated documentation files (the "Software"), to deal
-in the Software without restriction, including without limitation the rights
-to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-copies of the Software, and to permit persons to whom the Software is
-furnished to do so, subject to the following conditions:
-
-The above copyright notice and this permission notice shall be included in all
-copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
-SOFTWARE.
+MIT License
+
+Copyright (c) 2024 geolysis
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

geolysis-0.4.2.dist-info/METADATA

@@ -0,0 +1,228 @@
+Metadata-Version: 2.2
+Name: geolysis
+Version: 0.4.2
+Summary: geolysis.core is an opensource software for geotechnical engineering analysis and modeling.
+Author-email: Patrick Boateng <boatengpato.pb@gmail.com>
+License: MIT License
+Project-URL: Homepage, https://github.com/patrickboateng/geolysis
+Project-URL: Documentation, https://geolysis.readthedocs.org
+Project-URL: Repository, https://github.com/patrickboateng/geolysis
+Project-URL: Discussions, https://github.com/patrickboateng/geolysis/discussions
+Project-URL: Issue Tracker, https://github.com/patrickboateng/geolysis/issues
+Keywords: geotechnical-engineering,soil-classification,settlement-analysis,bearing-capacity-analysis
+Classifier: Development Status :: 4 - Beta
+Classifier: Intended Audience :: Developers
+Classifier: Intended Audience :: Education
+Classifier: Intended Audience :: Science/Research
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Natural Language :: English
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: Implementation :: CPython
+Classifier: Topic :: Scientific/Engineering
+Requires-Python: >=3.11
+Description-Content-Type: text/markdown
+License-File: LICENSE.txt
+Provides-Extra: dev
+Requires-Dist: pytest; extra == "dev"
+Requires-Dist: pytest-cov; extra == "dev"
+Requires-Dist: coverage; extra == "dev"
+
+<h1 align="center">
+<img src="https://raw.githubusercontent.com/patrickboateng/geolysis/dev/docs/source/_static/branding/geolysislogo.svg" 
+alt="geolysislogo" width="75%" />
+</h1><br>
+
+<div align="center">
+
+[![PyPI Latest Release](https://img.shields.io/pypi/v/geolysis?style=flat&logo=pypi)](https://pypi.org/project/geolysis/)
+[![PyPI pyversions](https://img.shields.io/pypi/pyversions/geolysis.svg?logo=python&style=flat)](https://pypi.python.org/pypi/geolysis/)
+[![license](https://img.shields.io/pypi/l/geolysis?style=flat&logo=opensourceinitiative)](https://opensource.org/license/mit/)
+
+![Coveralls Status](https://img.shields.io/coverallsCoverage/github/patrickboateng/geolysis?logo=coveralls)
+[![Codacy Badge](https://app.codacy.com/project/badge/Grade/17f88084c6a84a08a20f9d8da1438107)](https://app.codacy.com/gh/patrickboateng/geolysis/dashboard?utm_source=gh&utm_medium=referral&utm_content=&utm_campaign=Badge_grade)
+[![Unit-Tests](https://github.com/patrickboateng/geolysis/actions/workflows/geolysis-unit-tests.yml/badge.svg)](https://github.com/patrickboateng/geolysis/actions/workflows/unit-tests.yml)
+[![Documentation Status](https://readthedocs.org/projects/geolysis/badge/?version=latest)](https://geolysis.readthedocs.io/en/latest/?badge=latest)
+
+</div>
+
+`geolysis` is an open-source library for geotechnical analysis and modeling.
+It offers tools for soil classification, Standard Penetration Test (SPT)
+analysis, and bearing capacity estimation, among others.
+
+The `geolysis` library is among four main projects: `geolysis.gui`,
+`geolysis.excel`, and `geolysis.ai`. The geolysis library powers all of these
+projects.
+
+**_The `geolysis` projects are currently under developement and not yet
+publicly available_**.
+
+**_Active development of `geolysis` occurs on the `dev` branch. For more
+information on the latest features of `geolysis`, switch to the
+`dev` branch_**.
+
+Here are brief descriptions of these projects:
+
+<table>
+  <tr>
+    <td>
+    <strong>geolysis.gui</strong>
+    </td>
+    <td>A graphical user interface that allows users to interact with the
+     geolysis library. Through this interface, users can view generated reports
+     and visualizations, such as Particle Size Distribution (PSD) curves,
+     Atterberg Limits plots, and Compaction curves, among others.
+     Additionally, it enables users to conduct foundation analysis and
+     design, among other functionalities.
+    </td>
+  </tr>
+  <tr>
+    <td>
+    <strong>geolysis.excel</strong>
+    </td>
+    <td>An add-in for Microsoft Excel that performs simple geotechnical
+     analysis. It offers some features similar to <code>geolysis.gui</code>
+     within Microsoft Excel.
+    </td>
+  </tr>
+  <tr>
+    <td>
+    <strong>geolysis.ai</strong>
+    </td>
+    <td>Offers machine learning models that are trained using geotechnical data.
+    </td>
+  </tr>
+</table>
+
+## Project Structure
+
+    .
+    ├── .github        # GitHub Actions
+    ├── docs           # Documentation files
+    ├── geolysis       # Source files
+    ├── tests          # Automated tests
+    └── README.md
+
+## Table of Contents
+
+- [Installation](#installation)
+- [Usage Example](#usage-example)
+- [Features](#features)
+- [Documentation](#documentation)
+- [Contributing](#contributing)
+- [License](#license)
+- [Contact](#contact)
+
+## Installation
+
+**_Note: Work on the latest update is still in progress, so the usage example
+below
+will not function if installed._**
+
+```shell
+   pip install geolysis
+```
+
+## Usage Example
+
+```python
+
+>> > from geolysis.soil_classifier import create_soil_classifier
+>> > uscs_clf = create_soil_classifier(liquid_limit=34.1,
+                                       ...
+plastic_limit = 21.1,
+...
+fines = 47.88,
+...
+sand = 37.84,
+...
+clf_type = "USCS")
+>> > clf = uscs_clf.classify()
+>> > clf
+SoilClf(symbol='SC', description='Clayey sands')
+>> > clf.symbol
+'SC'
+>> > clf.description
+'Clayey sands'
+
+```
+
+```python
+
+>> > from geolysis.soil_classifier import create_soil_classifier
+>> > aashto_clf = create_soil_classifier(liquid_limit=34.1,
+                                         ...
+plastic_limit = 21.1,
+...
+fines = 47.88,
+...
+sand = 37.84,  # Sand is optional for AASHTO classification
+...
+clf_type = "AASHTO")
+>> > clf = aashto_clf.classify()
+>> > clf
+SoilClf(symbol='A-6(4)', description='Clayey soils')
+>> > clf.symbol
+'A-6(4)'
+>> > clf.description
+'Clayey soils'
+
+```
+
+## Features
+
+<table>
+  <tr>
+    <td rowspan="2">
+    <strong>Soil Classification</strong>
+    </td>
+    <td>AASHTO Classification System</td>
+  </tr>
+  <tr>
+    <td>Unified Soil Classification System</td>
+  </tr>
+  <tr>
+    <td rowspan="4">
+    <strong>Standard Penetration Test (SPT) Analysis</strong>
+    </td>
+    <td>SPT Energy Correction</td>
+  </tr>
+  <tr>
+    <td>SPT Overburden Pressure Correction</td>
+  </tr>
+  <tr>
+    <td>Dilatancy Correction</td>
+  </tr>
+  <tr>
+    <td>SPT N-Design Calculation</td>
+  </tr>
+  <tr>
+    <td rowspan="2">
+    <strong>Bearing Capacity Estimation</strong>
+    </td>
+    <td>Allowable Bearing Capacity Estimation</td>
+  </tr>
+  <tr>
+    <td>Ultimate Bearing Capacity Estimation</td>
+  </tr>
+</table>
+
+## Documentation
+
+Full documentation is available [here](https://www.geolysis.readthedocs.io)
+
+**_Note: Work on the latest documentation is still ongoing._**
+
+## Contributing
+
+## License
+
+This project is licensed under the MIT License - see the
+[LICENSE](https://github.com/patrickboateng/geolysis/blob/main/LICENSE.txt)
+file for more details.
+
+## Contact
+
+For questions or feedback, please contact us at
+[boatengpato.pb@gmail.com](mailto:boatengpato.pb@gmail.com)

geolysis-0.4.2.dist-info/RECORD

@@ -0,0 +1,11 @@
+geolysis/__init__.py,sha256=XZTtMHzfsLe7mt08DNl_2Qui1xPYU8f504pS-Q8yKzY,77
+geolysis/foundation.py,sha256=aZVLOrRSx1ALwJwQwrnCQOMc4fQf4gAoBmHjI0tyNLo,9548
+geolysis/soil_classifier.py,sha256=FhfWYEo5dIQ1QWL83u5lX19AfMCCsnf0Klb67ekOLHc,26133
+geolysis/spt.py,sha256=jlO2gIGpM-sKhBQRSaCe3iNFZ8xKq9XiZnxVcxzhyBg,13647
+geolysis/utils.py,sha256=lonWt3VIB-zQjplCTzwUSIBxah4sB4fBh1l92iXE-NY,2313
+geolysis/validators.py,sha256=j6ek90_si4caeVmPMEPTvSxBh0LnxiqXWKzUjF0Htbc,1662
+geolysis-0.4.2.dist-info/LICENSE.txt,sha256=ap6sMs3lT7ICbEXBhgihwH1BTCVcjmCQkIkwVnil1Ak,1065
+geolysis-0.4.2.dist-info/METADATA,sha256=yjsbp0sU4JTVH_S63ncjIyCruTBs1eucjd6ktoUIzNs,7059
+geolysis-0.4.2.dist-info/WHEEL,sha256=In9FTNxeP60KnTkGw7wk6mJPYd_dQSjEZmXdBdMCI-8,91
+geolysis-0.4.2.dist-info/top_level.txt,sha256=9mnQgOaCRr11dtXff8X-q3FfXjRONd6kHseSy5q2y8g,9
+geolysis-0.4.2.dist-info/RECORD,,

{geolysis-0.2.0.dist-info → geolysis-0.4.2.dist-info}/WHEEL

@@ -1,5 +1,5 @@
 Wheel-Version: 1.0
-Generator: bdist_wheel (0.42.0)
+Generator: setuptools (75.8.0)
 Root-Is-Purelib: true
 Tag: py3-none-any
 

geolysis/bearing_capacity/__init__.py

@@ -1 +0,0 @@
-from . import abc