geolysis 0.7.1__py3-none-any.whl → 0.7.3__py3-none-any.whl

geolysis/__init__.py

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

geolysis/spt.py

@@ -7,7 +7,7 @@ from abc import abstractmethod
 from typing import Final, Sequence, Literal
 
 from .utils import enum_repr, isclose, log10, mean, round_, sqrt, validators
-from .utils.exceptions import EnumErrorMsg, ErrorMsg
+from .utils.exceptions import EnumErrorMsg, ErrorMsg, ValidationError
 
 __all__ = ["SPTNDesign",
            "HammerType",
@@ -53,6 +53,10 @@ class SPTNDesign:
     @corrected_spt_n_values.setter
     @validators.min_len(1)
     def corrected_spt_n_values(self, val: Sequence[float]) -> None:
+        for v in val:
+            if v <= 0.0 or v > 100:
+                raise ValidationError(
+                    "SPT N-values must be between 0.0 and 100.")
         self._corrected_spt_n_values = val
 
     @staticmethod
@@ -300,6 +304,7 @@ class OPC:
         return self._std_spt_n_value
 
     @std_spt_n_value.setter
+    @validators.le(100)
     @validators.gt(0.0)
     def std_spt_n_value(self, val: float) -> None:
         self._std_spt_n_value = val
@@ -494,6 +499,7 @@ class DilatancyCorrection:
         return self._corr_spt_n_value
 
     @corr_spt_n_value.setter
+    @validators.le(100.0)
     @validators.gt(0.0)
     def corr_spt_n_value(self, val: float) -> None:
         self._corr_spt_n_value = val

{geolysis-0.7.1.dist-info → geolysis-0.7.3.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: geolysis
-Version: 0.7.1
+Version: 0.7.3
 Summary: geolysis is an opensource software for geotechnical engineering analysis and modeling.
 Author-email: Patrick Boateng <boatengpato.pb@gmail.com>
 License: MIT License
@@ -49,57 +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>
-
-# Microsoft Excel Example
-
-![geolysis excel example](geolysis_excel_example.gif)
+`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
 
@@ -166,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/)
@@ -220,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.1.dist-info → geolysis-0.7.3.dist-info}/RECORD

@@ -1,7 +1,7 @@
-geolysis/__init__.py,sha256=doEthTEMHHK5V-a9L90VQf2YQ_nWHKbtT0fuyV19j38,122
+geolysis/__init__.py,sha256=tB9wh0D84gDFP-Qawiw-tgXqyYB_apapJ9hJj6uGP1U,122
 geolysis/foundation.py,sha256=gxI6bLbUrxQNhoKJis5glDysnI6PgqBkMM9m5CQztsg,11695
 geolysis/soil_classifier.py,sha256=2C-4hpgXNo2DUgXKcokUh3qjAH70qvgOCnxsL_NnmTw,26880
-geolysis/spt.py,sha256=7C8FPwwUej_YLkLAMMyUVhWYoh9FH4__6g5_G8NSas0,17507
+geolysis/spt.py,sha256=B9tR4GapKVFHsGHkcFHW68-K2w7szLmtBC9Ejmhz0lY,17736
 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=sWhQJj5klrenbwgaBAWRM23BQCcudZM4Ztwg8auxNw8,5399
@@ -17,8 +17,8 @@ geolysis/bearing_capacity/ubc/vesic_ubc.py,sha256=zlFI26tY_L1LCb6T7q4NY4E0pTivdj
 geolysis/utils/__init__.py,sha256=713rJNWVFLrP4CNon4i-xUf5rF5eA40Ydg-F1UV8o-0,2339
 geolysis/utils/exceptions.py,sha256=ivuyxqz0B7nmA5sXMfw4o7KPnQHoaGbLHmJCEiCEaAc,929
 geolysis/utils/validators.py,sha256=g18NIlLaNSIjlBwRLkUQr68qcYnwzo5qcfY5y_GoO1Y,3205
-geolysis-0.7.1.dist-info/licenses/LICENSE.txt,sha256=ap6sMs3lT7ICbEXBhgihwH1BTCVcjmCQkIkwVnil1Ak,1065
-geolysis-0.7.1.dist-info/METADATA,sha256=Ul3uVbiX7sIty2eYbxzNuQV0yVH46HLIQwhQARR91JQ,7450
-geolysis-0.7.1.dist-info/WHEEL,sha256=pxyMxgL8-pra_rKaQ4drOZAegBVuX-G_4nRHjjgWbmo,91
-geolysis-0.7.1.dist-info/top_level.txt,sha256=9mnQgOaCRr11dtXff8X-q3FfXjRONd6kHseSy5q2y8g,9
-geolysis-0.7.1.dist-info/RECORD,,
+geolysis-0.7.3.dist-info/licenses/LICENSE.txt,sha256=ap6sMs3lT7ICbEXBhgihwH1BTCVcjmCQkIkwVnil1Ak,1065
+geolysis-0.7.3.dist-info/METADATA,sha256=x-9PiEkGWxqWKrTjQZ4VnHlZ8OfkQPjGlOwkxMn_kaU,7235
+geolysis-0.7.3.dist-info/WHEEL,sha256=pxyMxgL8-pra_rKaQ4drOZAegBVuX-G_4nRHjjgWbmo,91
+geolysis-0.7.3.dist-info/top_level.txt,sha256=9mnQgOaCRr11dtXff8X-q3FfXjRONd6kHseSy5q2y8g,9
+geolysis-0.7.3.dist-info/RECORD,,