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

geolysis/core/utils.py

@@ -1,113 +0,0 @@
-import functools
-import math
-from math import exp, isclose, log, log10, pi, sqrt
-from statistics import fmean
-from typing import Callable, SupportsRound
-
-from .constants import DECIMAL_PLACES
-
-__all__ = [
-    "deg2rad",
-    "rad2deg",
-    "tan",
-    "cot",
-    "sin",
-    "cos",
-    "arctan",
-    "round_",
-]
-
-PI = pi
-mean = fmean
-
-
-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 shoud support the ``__round__`` dunder
-    method and should be a numeric value. ``ndigits`` can either be an int
-    which will indicates the number of decimal places to round to or a callable,
-    which by default rounds the returned value to 4 decimal places.
-
-    TypeError is raised when ``ndigits`` is neither an int or a callable.
-
-    Examples
-    --------
-    >>> @round_(ndigits=2)
-    ... def area_of_circle(radius: float):
-    ...   return PI * (radius ** 2)
-
-    >>> area_of_circle(radius=2.0)
-    12.57
-
-    By default the function is rounded to 4 decimal places.
-
-    >>> @round_
-    ... def area_of_circle(radius: float):
-    ...   return PI * (radius ** 2)
-
-    >>> area_of_circle(radius=2.0)
-    12.5664
-
-    >>> @round_(ndigits=2.0)
-    ... def area_of_square(width: float):
-    ...   return width ** 2
-    Traceback (most recent call last):
-        ...
-    TypeError: ndigits should be an int or a callable.
-    """
-
-    def dec(func, ndigits=DECIMAL_PLACES):
-        @functools.wraps(func)
-        def wrapper(*args, **kwargs) -> float:
-            return round(func(*args, **kwargs), ndigits=ndigits)
-
-        return wrapper
-
-    # See if we're being called as @round_ or @round_().
-    if isinstance(ndigits, int):
-        # We're called with parens.
-        return functools.partial(dec, ndigits=ndigits)
-    if callable(ndigits):
-        # We're called as @round_ without parens.
-        f = ndigits
-        return dec(f)
-    else:
-        err_msg = "ndigits should be an int or a callable."
-        raise TypeError(err_msg)

geolysis-0.3.0.dist-info/METADATA

@@ -1,223 +0,0 @@
-Metadata-Version: 2.1
-Name: geolysis
-Version: 0.3.0
-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: Repository, https://github.com/patrickboateng/geolysis
-Project-URL: Changelog, https://github.com/patrickboateng/geolysis/blob/main/CHANGELOG.md
-Project-URL: Issue Tracker, https://github.com/patrickboateng/geolysis/issues
-Project-URL: Discussions, https://github.com/patrickboateng/geolysis/discussions
-Keywords: discrete-element-method,geotechnical-engineering,soil-classification,settlement-analysis,bearing-capacity-analysis
-Classifier: Development Status :: 3 - Alpha
-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.10
-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.10
-Description-Content-Type: text/markdown
-License-File: LICENSE.txt
-Provides-Extra: dev
-Requires-Dist: black ; extra == 'dev'
-Requires-Dist: pytest ; extra == 'dev'
-Requires-Dist: mypy ; extra == 'dev'
-Requires-Dist: pytest-cov ; extra == 'dev'
-Requires-Dist: coverage ; extra == 'dev'
-
-[code_of_conduct_url]: https://github.com/patrickboateng/geolysis/blob/main/CODE_OF_CONDUCT.md/
-[contributing_url]: https://github.com/patrickboateng/geolysis/blob/main/docs/CONTRIBUTING.md#how-to-contribute
-[license_url]: https://github.com/patrickboateng/geolysis/blob/main/LICENSE.txt
-
-# geolysis
-
-<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)
-[![Unit-Tests](https://github.com/patrickboateng/geolysis/actions/workflows/unit-tests.yml/badge.svg)](https://github.com/patrickboateng/geolysis/actions/workflows/unit-tests.yml)
-[![Pkg Build](https://github.com/patrickboateng/geolysis/actions/workflows/pkg_build.yml/badge.svg)](https://github.com/patrickboateng/geolysis/actions/workflows/pkg_build.yml)
-[![Documentation Status](https://readthedocs.org/projects/geolysis/badge/?version=latest)](https://geolysis.readthedocs.io/en/latest/?badge=latest)
-
-</div>
-
-#
-
-`geolysis` is your one-stop shop for all your geotechnical engineering
-solutions, ranging from site investigation and laboratory test analysis
-to advanced geotechnical designs.
-
-`geolysis` is divided into four (4) main parts:
-
-1. `geolyis.core (Python Package)`
-
-   `geolysis.core` is an open-source Python package that provides features
-   for analyzing geotechnical results obtained from field and laboratory
-   tests. `geolysis.core` is designed specifically to assist developers
-   in building applications that can solve complex geotechnical
-   problems.
-
-   Whether you're working on soil mechanics, rock mechanics, or any other
-   geotechnical field, `geolysis.core` provides a powerful set of tools
-   that can help you design and develop robust solutions. With an
-   intuitive API and a wide range of features, this software is an
-   essential tool for anyone who needs to work with geotechnical data on
-   a regular basis. Whether you're a seasoned geotechnical engineer or a
-   new developer just getting started in the field, `geolysis.core` is
-   the ideal solution for all your software development needs.
-
-   Some of the features implemented so far include soil classification,
-   standard penetration test analysis (such as SPT N-design and SPT
-   N-value corrections), and calculating the allowable bearing capacity of
-   soils from Standard Penetration Test N-values. There are more features
-   underway, which include settlement analysis, ultimate bearing capacity
-   analysis, etc.
-
-   `geolysis.core` is the foundation application on which other parts of the
-   application will depend. Developers can also use `geolysis.core` to power
-   their applications.
-
-1. `geolysis.ui (Qt, PySide6)`
-
-   `geolysis.ui` is a Graphical User Interface (GUI) which will enable
-   users to graphically interact with `geolysis`. User will be able to
-   input data and view generated plots, such as `PSD` curves,
-   `Atterberg Limits` plots, `Compaction` curves, etc within the application.
-
-1. `geolysis.excel (Javascript & Others)`
-
-   `geolysis.excel` provides a Microsoft Excel add-in for simple geotechnical
-   analysis. _More on this later._
-
-1. `geolysis.ai (Python, Pytorch & Others)`
-
-   `geolysis.ai` explores the use of Artificial Intelligence (**AI**) in
-   enhancing productivity in Geotechnical Engineering.
-
-## Project Links
-
-- [Documentation](https://geolysis.readthedocs.org/en/latest)
-- [Repo](https://github.com/patrickboateng/geolysis)
-- [PyPi](https://pypi.org/project/geolysis/)
-- [Bug Reports](https://github.com/patrickboateng/geolysis/issues)
-- [Discussions](https://github.com/patrickboateng/geolysis/discussions)
-
-<!-- > [!IMPORTANT]
-> Project documentation is underway -->
-
-## Table of Contents
-
-- [Motivation](#motivation)
-- [Installation](#installation)
-- [Getting Started](#getting-started)
-  - [Soil Classification Example](#soil-classification-example)
-- [Release History](#release-history)
-- [Code of Conduct](#code-of-conduct)
-- [Contributing](#contributing)
-- [License](#license)
-- [Governance of this project](#governance-of-this-project)
-- [Contact Information](#contact-information)
-
-## Motivation
-
-`geolysis` is a software solution that aims to support geotechnical
-engineers in their daily work by providing a set of tools that makes
-them perform their tasks in a more efficient and effective manner.
-Moreover, the platform is designed to educate civil engineering
-students, especially those who specialize in geotechnical engineering,
-by exposing them to industry-relevant tools and techniques that will
-help them become industry-ready professionals as soon as they graduate.
-With `geolysis`, users will be better equipped to handle geotechnical
-challenges, make informed decisions, and improve their overall
-productivity.
-
-## Installation
-
-```shell
-pip install geolysis
-```
-
-## Getting Started
-
-### Soil Classification Example
-
-AASHTO classification
-
-```python
-
->>> from geolysis.core.soil_classifier import AASHTO
->>> aashto_cls = AASHTO(liquid_limit=30.2, plasticity_index=6.3, fines=11.18)
->>> aashto_cls.soil_class
-'A-2-4(0)'
->>> aashto_cls.soil_desc
-'Silty or clayey gravel and sand'
-
-```
-
-USCS Classification
-
-```python
-
->>> from geolysis.core.soil_classifier import USCS
->>> uscs_cls = USCS(liquid_limit=34.1, plastic_limit=21.1,
-...                 fines=47.88, sand=37.84, gravel=14.8)
->>> uscs_cls.soil_class
-'SC'
->>> uscs_cls.soil_desc
-'Clayey sands'
->>> uscs_cls = USCS(liquid_limit=30.8, plastic_limit=20.7, fines=10.29,
-...                 sand=81.89, gravel=7.83, d_10=0.07, d_30=0.3, d_60=0.8)
->>> uscs_cls.soil_class
-'SW-SC'
->>> uscs_cls.soil_desc
-'Well graded sand with clay'
-
-```
-
-<!-- See the [Quick start section] of the docs for more examples. -->
-
-## Release History
-
-Check out the [release notes](https://geolysis.rtfd.io/en/latest/release_notes/index.html)
-for features.
-
-## Code of Conduct
-
-This project has a [code of conduct][code_of_conduct_url] that
-we expect all contributors to adhere to. Please read and follow
-it when participating in this project.
-
-## Contributing
-
-If you would like to contribute to this project, please read
-the [contributing guidelines][contributing_url]
-
-## License
-
-Distributed under the [**MIT**][license_url] license. By using,
-distributing, or contributing to this project, you agree to the
-terms and conditions of this license.
-
-## Governance of this project
-
-`geolysis.core` is still developing relatively rapidly, so please
-be patient if things change or features iterate and change quickly.
-Once `geolysis.core` hits `1.0.0`, it will slow down considerably.
-
-## Contact Information
-
-- [**LinkedIn**](https://linkedin.com/in/patrickboateng/)
-
-> [!IMPORTANT]
-> For questions or comments about `geolysis`, please ask them in the
-> [discussions forum](https://github.com/patrickboateng/geolysis/discussions)

geolysis-0.3.0.dist-info/RECORD

@@ -1,14 +0,0 @@
-geolysis/__init__.py,sha256=zx-qiZgxpqlBnRhbSC3Atn4wTeLI-j3ZfaowNSvMkio,45
-geolysis/core/__init__.py,sha256=T5IlKVd6bNn-QDNpccpTm-H8UUVXTjj-R6HpNYqJODo,149
-geolysis/core/abc_4_cohl_soils.py,sha256=UuIlFqQ222bOdFUf_1_Iign7oJum8dQqlOIMSEtmYVc,15401
-geolysis/core/constants.py,sha256=zUZHKG5JlP-2LTg60C8wMK2sNaqVMs3PodH7ilu8ByQ,991
-geolysis/core/estimators.py,sha256=U9oJsJuEZmxWRzVQYUmH_xm4zYtn9SAdkZMxHrzcJIA,13324
-geolysis/core/foundation.py,sha256=iG5ClXNDOd9TZHr9-gRrTF9jdbRbf92wrL1cAK0yHk4,13692
-geolysis/core/soil_classifier.py,sha256=epViYXXe4VseiZpglVFFOVLUVhm5iJl7zg1_dBLBWwM,28201
-geolysis/core/spt.py,sha256=Cd3nD4vNO115qLwUUJJDcjVR7p3lAKUnf3LQoYe_whU,17109
-geolysis/core/utils.py,sha256=YKsWhp_q4rKS6XefbyuV_i_WLex65yrvYcHws_j2GmE,3070
-geolysis-0.3.0.dist-info/LICENSE.txt,sha256=IeI21JgXY_KBFnrGG2YJmzozgQMM7tLvlikBlsyBLh8,1086
-geolysis-0.3.0.dist-info/METADATA,sha256=FK4JUSvChmcM9O-zEOxgcTsPrHis-rcykIbYNdq5hkQ,9012
-geolysis-0.3.0.dist-info/WHEEL,sha256=GJ7t_kWBFywbagK5eo9IoUwLW6oyOeTKmQ-9iHFVNxQ,92
-geolysis-0.3.0.dist-info/top_level.txt,sha256=9mnQgOaCRr11dtXff8X-q3FfXjRONd6kHseSy5q2y8g,9
-geolysis-0.3.0.dist-info/RECORD,,