geolysis 0.3.0__py3-none-any.whl → 0.4.2__py3-none-any.whl
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- geolysis/__init__.py +3 -3
- geolysis/foundation.py +326 -0
- geolysis/soil_classifier.py +719 -0
- geolysis/spt.py +447 -0
- geolysis/utils.py +78 -0
- geolysis/validators.py +54 -0
- {geolysis-0.3.0.dist-info → geolysis-0.4.2.dist-info}/LICENSE.txt +21 -21
- geolysis-0.4.2.dist-info/METADATA +228 -0
- geolysis-0.4.2.dist-info/RECORD +11 -0
- {geolysis-0.3.0.dist-info → geolysis-0.4.2.dist-info}/WHEEL +1 -1
- geolysis/core/__init__.py +0 -9
- geolysis/core/abc_4_cohl_soils.py +0 -495
- geolysis/core/constants.py +0 -47
- geolysis/core/estimators.py +0 -549
- geolysis/core/foundation.py +0 -543
- geolysis/core/soil_classifier.py +0 -859
- geolysis/core/spt.py +0 -633
- geolysis/core/utils.py +0 -113
- geolysis-0.3.0.dist-info/METADATA +0 -223
- geolysis-0.3.0.dist-info/RECORD +0 -14
- {geolysis-0.3.0.dist-info → geolysis-0.4.2.dist-info}/top_level.txt +0 -0
|
@@ -0,0 +1,228 @@
|
|
|
1
|
+
Metadata-Version: 2.2
|
|
2
|
+
Name: geolysis
|
|
3
|
+
Version: 0.4.2
|
|
4
|
+
Summary: geolysis.core is an opensource software for geotechnical engineering analysis and modeling.
|
|
5
|
+
Author-email: Patrick Boateng <boatengpato.pb@gmail.com>
|
|
6
|
+
License: MIT License
|
|
7
|
+
Project-URL: Homepage, https://github.com/patrickboateng/geolysis
|
|
8
|
+
Project-URL: Documentation, https://geolysis.readthedocs.org
|
|
9
|
+
Project-URL: Repository, https://github.com/patrickboateng/geolysis
|
|
10
|
+
Project-URL: Discussions, https://github.com/patrickboateng/geolysis/discussions
|
|
11
|
+
Project-URL: Issue Tracker, https://github.com/patrickboateng/geolysis/issues
|
|
12
|
+
Keywords: geotechnical-engineering,soil-classification,settlement-analysis,bearing-capacity-analysis
|
|
13
|
+
Classifier: Development Status :: 4 - Beta
|
|
14
|
+
Classifier: Intended Audience :: Developers
|
|
15
|
+
Classifier: Intended Audience :: Education
|
|
16
|
+
Classifier: Intended Audience :: Science/Research
|
|
17
|
+
Classifier: License :: OSI Approved :: MIT License
|
|
18
|
+
Classifier: Natural Language :: English
|
|
19
|
+
Classifier: Operating System :: OS Independent
|
|
20
|
+
Classifier: Programming Language :: Python :: 3.11
|
|
21
|
+
Classifier: Programming Language :: Python :: 3.12
|
|
22
|
+
Classifier: Programming Language :: Python :: Implementation :: CPython
|
|
23
|
+
Classifier: Topic :: Scientific/Engineering
|
|
24
|
+
Requires-Python: >=3.11
|
|
25
|
+
Description-Content-Type: text/markdown
|
|
26
|
+
License-File: LICENSE.txt
|
|
27
|
+
Provides-Extra: dev
|
|
28
|
+
Requires-Dist: pytest; extra == "dev"
|
|
29
|
+
Requires-Dist: pytest-cov; extra == "dev"
|
|
30
|
+
Requires-Dist: coverage; extra == "dev"
|
|
31
|
+
|
|
32
|
+
<h1 align="center">
|
|
33
|
+
<img src="https://raw.githubusercontent.com/patrickboateng/geolysis/dev/docs/source/_static/branding/geolysislogo.svg"
|
|
34
|
+
alt="geolysislogo" width="75%" />
|
|
35
|
+
</h1><br>
|
|
36
|
+
|
|
37
|
+
<div align="center">
|
|
38
|
+
|
|
39
|
+
[](https://pypi.org/project/geolysis/)
|
|
40
|
+
[](https://pypi.python.org/pypi/geolysis/)
|
|
41
|
+
[](https://opensource.org/license/mit/)
|
|
42
|
+
|
|
43
|
+
|
|
44
|
+
[](https://app.codacy.com/gh/patrickboateng/geolysis/dashboard?utm_source=gh&utm_medium=referral&utm_content=&utm_campaign=Badge_grade)
|
|
45
|
+
[](https://github.com/patrickboateng/geolysis/actions/workflows/unit-tests.yml)
|
|
46
|
+
[](https://geolysis.readthedocs.io/en/latest/?badge=latest)
|
|
47
|
+
|
|
48
|
+
</div>
|
|
49
|
+
|
|
50
|
+
`geolysis` is an open-source library for geotechnical analysis and modeling.
|
|
51
|
+
It offers tools for soil classification, Standard Penetration Test (SPT)
|
|
52
|
+
analysis, and bearing capacity estimation, among others.
|
|
53
|
+
|
|
54
|
+
The `geolysis` library is among four main projects: `geolysis.gui`,
|
|
55
|
+
`geolysis.excel`, and `geolysis.ai`. The geolysis library powers all of these
|
|
56
|
+
projects.
|
|
57
|
+
|
|
58
|
+
**_The `geolysis` projects are currently under developement and not yet
|
|
59
|
+
publicly available_**.
|
|
60
|
+
|
|
61
|
+
**_Active development of `geolysis` occurs on the `dev` branch. For more
|
|
62
|
+
information on the latest features of `geolysis`, switch to the
|
|
63
|
+
`dev` branch_**.
|
|
64
|
+
|
|
65
|
+
Here are brief descriptions of these projects:
|
|
66
|
+
|
|
67
|
+
<table>
|
|
68
|
+
<tr>
|
|
69
|
+
<td>
|
|
70
|
+
<strong>geolysis.gui</strong>
|
|
71
|
+
</td>
|
|
72
|
+
<td>A graphical user interface that allows users to interact with the
|
|
73
|
+
geolysis library. Through this interface, users can view generated reports
|
|
74
|
+
and visualizations, such as Particle Size Distribution (PSD) curves,
|
|
75
|
+
Atterberg Limits plots, and Compaction curves, among others.
|
|
76
|
+
Additionally, it enables users to conduct foundation analysis and
|
|
77
|
+
design, among other functionalities.
|
|
78
|
+
</td>
|
|
79
|
+
</tr>
|
|
80
|
+
<tr>
|
|
81
|
+
<td>
|
|
82
|
+
<strong>geolysis.excel</strong>
|
|
83
|
+
</td>
|
|
84
|
+
<td>An add-in for Microsoft Excel that performs simple geotechnical
|
|
85
|
+
analysis. It offers some features similar to <code>geolysis.gui</code>
|
|
86
|
+
within Microsoft Excel.
|
|
87
|
+
</td>
|
|
88
|
+
</tr>
|
|
89
|
+
<tr>
|
|
90
|
+
<td>
|
|
91
|
+
<strong>geolysis.ai</strong>
|
|
92
|
+
</td>
|
|
93
|
+
<td>Offers machine learning models that are trained using geotechnical data.
|
|
94
|
+
</td>
|
|
95
|
+
</tr>
|
|
96
|
+
</table>
|
|
97
|
+
|
|
98
|
+
## Project Structure
|
|
99
|
+
|
|
100
|
+
.
|
|
101
|
+
├── .github # GitHub Actions
|
|
102
|
+
├── docs # Documentation files
|
|
103
|
+
├── geolysis # Source files
|
|
104
|
+
├── tests # Automated tests
|
|
105
|
+
└── README.md
|
|
106
|
+
|
|
107
|
+
## Table of Contents
|
|
108
|
+
|
|
109
|
+
- [Installation](#installation)
|
|
110
|
+
- [Usage Example](#usage-example)
|
|
111
|
+
- [Features](#features)
|
|
112
|
+
- [Documentation](#documentation)
|
|
113
|
+
- [Contributing](#contributing)
|
|
114
|
+
- [License](#license)
|
|
115
|
+
- [Contact](#contact)
|
|
116
|
+
|
|
117
|
+
## Installation
|
|
118
|
+
|
|
119
|
+
**_Note: Work on the latest update is still in progress, so the usage example
|
|
120
|
+
below
|
|
121
|
+
will not function if installed._**
|
|
122
|
+
|
|
123
|
+
```shell
|
|
124
|
+
pip install geolysis
|
|
125
|
+
```
|
|
126
|
+
|
|
127
|
+
## Usage Example
|
|
128
|
+
|
|
129
|
+
```python
|
|
130
|
+
|
|
131
|
+
>> > from geolysis.soil_classifier import create_soil_classifier
|
|
132
|
+
>> > uscs_clf = create_soil_classifier(liquid_limit=34.1,
|
|
133
|
+
...
|
|
134
|
+
plastic_limit = 21.1,
|
|
135
|
+
...
|
|
136
|
+
fines = 47.88,
|
|
137
|
+
...
|
|
138
|
+
sand = 37.84,
|
|
139
|
+
...
|
|
140
|
+
clf_type = "USCS")
|
|
141
|
+
>> > clf = uscs_clf.classify()
|
|
142
|
+
>> > clf
|
|
143
|
+
SoilClf(symbol='SC', description='Clayey sands')
|
|
144
|
+
>> > clf.symbol
|
|
145
|
+
'SC'
|
|
146
|
+
>> > clf.description
|
|
147
|
+
'Clayey sands'
|
|
148
|
+
|
|
149
|
+
```
|
|
150
|
+
|
|
151
|
+
```python
|
|
152
|
+
|
|
153
|
+
>> > from geolysis.soil_classifier import create_soil_classifier
|
|
154
|
+
>> > aashto_clf = create_soil_classifier(liquid_limit=34.1,
|
|
155
|
+
...
|
|
156
|
+
plastic_limit = 21.1,
|
|
157
|
+
...
|
|
158
|
+
fines = 47.88,
|
|
159
|
+
...
|
|
160
|
+
sand = 37.84, # Sand is optional for AASHTO classification
|
|
161
|
+
...
|
|
162
|
+
clf_type = "AASHTO")
|
|
163
|
+
>> > clf = aashto_clf.classify()
|
|
164
|
+
>> > clf
|
|
165
|
+
SoilClf(symbol='A-6(4)', description='Clayey soils')
|
|
166
|
+
>> > clf.symbol
|
|
167
|
+
'A-6(4)'
|
|
168
|
+
>> > clf.description
|
|
169
|
+
'Clayey soils'
|
|
170
|
+
|
|
171
|
+
```
|
|
172
|
+
|
|
173
|
+
## Features
|
|
174
|
+
|
|
175
|
+
<table>
|
|
176
|
+
<tr>
|
|
177
|
+
<td rowspan="2">
|
|
178
|
+
<strong>Soil Classification</strong>
|
|
179
|
+
</td>
|
|
180
|
+
<td>AASHTO Classification System</td>
|
|
181
|
+
</tr>
|
|
182
|
+
<tr>
|
|
183
|
+
<td>Unified Soil Classification System</td>
|
|
184
|
+
</tr>
|
|
185
|
+
<tr>
|
|
186
|
+
<td rowspan="4">
|
|
187
|
+
<strong>Standard Penetration Test (SPT) Analysis</strong>
|
|
188
|
+
</td>
|
|
189
|
+
<td>SPT Energy Correction</td>
|
|
190
|
+
</tr>
|
|
191
|
+
<tr>
|
|
192
|
+
<td>SPT Overburden Pressure Correction</td>
|
|
193
|
+
</tr>
|
|
194
|
+
<tr>
|
|
195
|
+
<td>Dilatancy Correction</td>
|
|
196
|
+
</tr>
|
|
197
|
+
<tr>
|
|
198
|
+
<td>SPT N-Design Calculation</td>
|
|
199
|
+
</tr>
|
|
200
|
+
<tr>
|
|
201
|
+
<td rowspan="2">
|
|
202
|
+
<strong>Bearing Capacity Estimation</strong>
|
|
203
|
+
</td>
|
|
204
|
+
<td>Allowable Bearing Capacity Estimation</td>
|
|
205
|
+
</tr>
|
|
206
|
+
<tr>
|
|
207
|
+
<td>Ultimate Bearing Capacity Estimation</td>
|
|
208
|
+
</tr>
|
|
209
|
+
</table>
|
|
210
|
+
|
|
211
|
+
## Documentation
|
|
212
|
+
|
|
213
|
+
Full documentation is available [here](https://www.geolysis.readthedocs.io)
|
|
214
|
+
|
|
215
|
+
**_Note: Work on the latest documentation is still ongoing._**
|
|
216
|
+
|
|
217
|
+
## Contributing
|
|
218
|
+
|
|
219
|
+
## License
|
|
220
|
+
|
|
221
|
+
This project is licensed under the MIT License - see the
|
|
222
|
+
[LICENSE](https://github.com/patrickboateng/geolysis/blob/main/LICENSE.txt)
|
|
223
|
+
file for more details.
|
|
224
|
+
|
|
225
|
+
## Contact
|
|
226
|
+
|
|
227
|
+
For questions or feedback, please contact us at
|
|
228
|
+
[boatengpato.pb@gmail.com](mailto:boatengpato.pb@gmail.com)
|
|
@@ -0,0 +1,11 @@
|
|
|
1
|
+
geolysis/__init__.py,sha256=XZTtMHzfsLe7mt08DNl_2Qui1xPYU8f504pS-Q8yKzY,77
|
|
2
|
+
geolysis/foundation.py,sha256=aZVLOrRSx1ALwJwQwrnCQOMc4fQf4gAoBmHjI0tyNLo,9548
|
|
3
|
+
geolysis/soil_classifier.py,sha256=FhfWYEo5dIQ1QWL83u5lX19AfMCCsnf0Klb67ekOLHc,26133
|
|
4
|
+
geolysis/spt.py,sha256=jlO2gIGpM-sKhBQRSaCe3iNFZ8xKq9XiZnxVcxzhyBg,13647
|
|
5
|
+
geolysis/utils.py,sha256=lonWt3VIB-zQjplCTzwUSIBxah4sB4fBh1l92iXE-NY,2313
|
|
6
|
+
geolysis/validators.py,sha256=j6ek90_si4caeVmPMEPTvSxBh0LnxiqXWKzUjF0Htbc,1662
|
|
7
|
+
geolysis-0.4.2.dist-info/LICENSE.txt,sha256=ap6sMs3lT7ICbEXBhgihwH1BTCVcjmCQkIkwVnil1Ak,1065
|
|
8
|
+
geolysis-0.4.2.dist-info/METADATA,sha256=yjsbp0sU4JTVH_S63ncjIyCruTBs1eucjd6ktoUIzNs,7059
|
|
9
|
+
geolysis-0.4.2.dist-info/WHEEL,sha256=In9FTNxeP60KnTkGw7wk6mJPYd_dQSjEZmXdBdMCI-8,91
|
|
10
|
+
geolysis-0.4.2.dist-info/top_level.txt,sha256=9mnQgOaCRr11dtXff8X-q3FfXjRONd6kHseSy5q2y8g,9
|
|
11
|
+
geolysis-0.4.2.dist-info/RECORD,,
|