geolysis 0.7.0__tar.gz → 0.7.2__tar.gz

{geolysis-0.7.0 → geolysis-0.7.2}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: geolysis
-Version: 0.7.0
+Version: 0.7.2
 Summary: geolysis is an opensource software for geotechnical engineering analysis and modeling.
 Author-email: Patrick Boateng <boatengpato.pb@gmail.com>
 License: MIT License
@@ -49,53 +49,77 @@ alt="geolysislogo" width="75%" />
 
 </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>
+`geolysis` is an open-source python package (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` package is among three other projects, `geolysis.gui`,
+`geolysis.excel`, and `geolysis.ai`.
+
+Here are brief descriptions of the `geolysis` projects:
+
+1. `geolysis`
+
+   A python package (library) which provides the core functionalities for
+   `geolysis.gui` and the `geolysis.excel` applications. Current features
+   provided by the `geolysis` package are shown in the table below.
+
+   <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>SPT 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>
+
+2. `geolysis.gui`
+
+   A graphical user interface that allows users to interact with the `geolysis`
+   package. 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.
+
+3. `geolysis.excel`
+
+   An add-in for Microsoft Excel that performs simple geotechnical analysis.
+   It offers some features similar to `geolysis.gui` within Microsoft Excel.
+   Below is an example of the Microsoft Excel addin.
+
+   <div align="center">
+    <img src="https://raw.githubusercontent.com/patrickboateng/geolysis/main/docs/_static/geolysis_excel_example.gif" 
+    alt="geolysis excel example" width="100%" />
+   </div><br>
+
+4. `geolysis.ai`
+
+   Offers machine learning models that are trained using geotechnical data.
 
 ## Project Structure
 
@@ -162,43 +186,6 @@ 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
-
-<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
 
 Full documentation is available [here](https://docs.geolysis.io/en/latest/)
@@ -216,5 +203,5 @@ file for more details.
 
 ## Contact
 
-For questions or feedback, please contact us at
-[boatengpato.pb@gmail.com](mailto:boatengpato.pb@gmail.com)
+For questions or feedback, please
+contact [boatengpato.pb@gmail.com](mailto:boatengpato.pb@gmail.com)

{geolysis-0.7.0 → geolysis-0.7.2}/README.md

@@ -17,53 +17,77 @@ alt="geolysislogo" width="75%" />
 
 </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>
+`geolysis` is an open-source python package (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` package is among three other projects, `geolysis.gui`,
+`geolysis.excel`, and `geolysis.ai`.
+
+Here are brief descriptions of the `geolysis` projects:
+
+1. `geolysis`
+
+   A python package (library) which provides the core functionalities for
+   `geolysis.gui` and the `geolysis.excel` applications. Current features
+   provided by the `geolysis` package are shown in the table below.
+
+   <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>SPT 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>
+
+2. `geolysis.gui`
+
+   A graphical user interface that allows users to interact with the `geolysis`
+   package. 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.
+
+3. `geolysis.excel`
+
+   An add-in for Microsoft Excel that performs simple geotechnical analysis.
+   It offers some features similar to `geolysis.gui` within Microsoft Excel.
+   Below is an example of the Microsoft Excel addin.
+
+   <div align="center">
+    <img src="https://raw.githubusercontent.com/patrickboateng/geolysis/main/docs/_static/geolysis_excel_example.gif" 
+    alt="geolysis excel example" width="100%" />
+   </div><br>
+
+4. `geolysis.ai`
+
+   Offers machine learning models that are trained using geotechnical data.
 
 ## Project Structure
 
@@ -130,43 +154,6 @@ 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
-
-<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
 
 Full documentation is available [here](https://docs.geolysis.io/en/latest/)
@@ -184,5 +171,5 @@ file for more details.
 
 ## Contact
 
-For questions or feedback, please contact us at
-[boatengpato.pb@gmail.com](mailto:boatengpato.pb@gmail.com)
+For questions or feedback, please
+contact [boatengpato.pb@gmail.com](mailto:boatengpato.pb@gmail.com)

{geolysis-0.7.0 → geolysis-0.7.2}/geolysis/__init__.py

@@ -1,5 +1,5 @@
 from . import foundation, soil_classifier, spt
 
-__version__ = "0.7.0"
+__version__ = "0.7.2"
 
 __all__ = ["foundation", "soil_classifier", "spt"]

{geolysis-0.7.0 → geolysis-0.7.2}/geolysis/foundation.py

@@ -320,7 +320,9 @@ class FoundationSize:
         """Returns the :attr:`effective_width`, :attr:`length`, and
         :attr:`footing_shape` of the foundation footing.
         """
-        width, length, shape = self.effective_width, self.length, self.footing_shape
+        width, length, shape = (self.effective_width,
+                                self.length,
+                                self.footing_shape)
 
         if not isclose(width, length) and shape != Shape.STRIP:
             shape = Shape.RECTANGLE
@@ -374,7 +376,8 @@ def create_foundation(depth: float,
     try:
         shape = Shape(str(shape).casefold())
     except ValueError as e:
-        msg = EnumErrorMsg(param_name="shape", param_value=shape,
+        msg = EnumErrorMsg(param_name="shape",
+                           param_value=shape,
                            param_type=Shape)
         raise ValueError(msg) from e
 

{geolysis-0.7.0 → geolysis-0.7.2}/geolysis/utils/validators.py

@@ -1,6 +1,7 @@
 """validators"""
 import operator
 from typing import Callable, TypeAlias, Optional
+from functools import wraps
 
 from .exceptions import ValidationError
 
@@ -13,6 +14,7 @@ def _num_validator(bound: float, /, *,
                    exc_type: Callable,
                    err_msg: str):
     def dec(fn):
+        @wraps(fn)
         def wrapper(obj, val):
             if not compare_fn(val, bound):
                 msg = f"{fn.__name__} must be {compare_symbol} {bound}"
@@ -30,6 +32,7 @@ def _len_validator(bound: float, /, *,
                    exc_type: Callable,
                    err_msg: str):
     def dec(fn):
+        @wraps(fn)
         def wrapper(obj, val):
             _len = len(val)
             if not compare_fn(_len, bound):

{geolysis-0.7.0 → geolysis-0.7.2}/geolysis.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: geolysis
-Version: 0.7.0
+Version: 0.7.2
 Summary: geolysis is an opensource software for geotechnical engineering analysis and modeling.
 Author-email: Patrick Boateng <boatengpato.pb@gmail.com>
 License: MIT License
@@ -49,53 +49,77 @@ alt="geolysislogo" width="75%" />
 
 </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>
+`geolysis` is an open-source python package (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` package is among three other projects, `geolysis.gui`,
+`geolysis.excel`, and `geolysis.ai`.
+
+Here are brief descriptions of the `geolysis` projects:
+
+1. `geolysis`
+
+   A python package (library) which provides the core functionalities for
+   `geolysis.gui` and the `geolysis.excel` applications. Current features
+   provided by the `geolysis` package are shown in the table below.
+
+   <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>SPT 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>
+
+2. `geolysis.gui`
+
+   A graphical user interface that allows users to interact with the `geolysis`
+   package. 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.
+
+3. `geolysis.excel`
+
+   An add-in for Microsoft Excel that performs simple geotechnical analysis.
+   It offers some features similar to `geolysis.gui` within Microsoft Excel.
+   Below is an example of the Microsoft Excel addin.
+
+   <div align="center">
+    <img src="https://raw.githubusercontent.com/patrickboateng/geolysis/main/docs/_static/geolysis_excel_example.gif" 
+    alt="geolysis excel example" width="100%" />
+   </div><br>
+
+4. `geolysis.ai`
+
+   Offers machine learning models that are trained using geotechnical data.
 
 ## Project Structure
 
@@ -162,43 +186,6 @@ 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
-
-<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
 
 Full documentation is available [here](https://docs.geolysis.io/en/latest/)
@@ -216,5 +203,5 @@ file for more details.
 
 ## Contact
 
-For questions or feedback, please contact us at
-[boatengpato.pb@gmail.com](mailto:boatengpato.pb@gmail.com)
+For questions or feedback, please
+contact [boatengpato.pb@gmail.com](mailto:boatengpato.pb@gmail.com)