geolysis 0.4.2__tar.gz → 0.4.3__tar.gz

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.
Files changed (26) hide show
  1. {geolysis-0.4.2 → geolysis-0.4.3}/PKG-INFO +43 -78
  2. {geolysis-0.4.2 → geolysis-0.4.3}/README.md +38 -73
  3. geolysis-0.4.3/geolysis/__init__.py +1 -0
  4. {geolysis-0.4.2 → geolysis-0.4.3}/geolysis/foundation.py +165 -98
  5. {geolysis-0.4.2 → geolysis-0.4.3}/geolysis/soil_classifier.py +161 -99
  6. {geolysis-0.4.2 → geolysis-0.4.3}/geolysis/spt.py +89 -44
  7. {geolysis-0.4.2 → geolysis-0.4.3}/geolysis.egg-info/PKG-INFO +43 -78
  8. {geolysis-0.4.2 → geolysis-0.4.3}/geolysis.egg-info/SOURCES.txt +2 -3
  9. {geolysis-0.4.2 → geolysis-0.4.3}/pyproject.toml +6 -21
  10. geolysis-0.4.3/tests/test_foundation.py +117 -0
  11. geolysis-0.4.3/tests/test_soil_classifier.py +172 -0
  12. geolysis-0.4.3/tests/test_spt.py +108 -0
  13. {geolysis-0.4.2 → geolysis-0.4.3}/tests/test_utils.py +7 -2
  14. geolysis-0.4.3/tests/test_validators.py +24 -0
  15. geolysis-0.4.2/geolysis/__init__.py +0 -3
  16. geolysis-0.4.2/geolysis/utils.py +0 -78
  17. geolysis-0.4.2/geolysis/validators.py +0 -54
  18. geolysis-0.4.2/tests/test_foundation.py +0 -22
  19. geolysis-0.4.2/tests/test_soil_classifier.py +0 -136
  20. geolysis-0.4.2/tests/test_spt.py +0 -37
  21. {geolysis-0.4.2 → geolysis-0.4.3}/LICENSE.txt +0 -0
  22. {geolysis-0.4.2 → geolysis-0.4.3}/geolysis.egg-info/dependency_links.txt +0 -0
  23. {geolysis-0.4.2 → geolysis-0.4.3}/geolysis.egg-info/requires.txt +0 -0
  24. {geolysis-0.4.2 → geolysis-0.4.3}/geolysis.egg-info/top_level.txt +0 -0
  25. {geolysis-0.4.2 → geolysis-0.4.3}/setup.cfg +0 -0
  26. {geolysis-0.4.2 → geolysis-0.4.3}/setup.py +0 -0
{geolysis-0.4.2 → geolysis-0.4.3}/PKG-INFO RENAMED
@@ -1,15 +1,15 @@
1
1
  Metadata-Version: 2.2
2
2
  Name: geolysis
3
- Version: 0.4.2
4
- Summary: geolysis.core is an opensource software for geotechnical engineering analysis and modeling.
3
+ Version: 0.4.3
4
+ Summary: geolysis is an opensource software for geotechnical engineering analysis and modeling.
5
5
  Author-email: Patrick Boateng <boatengpato.pb@gmail.com>
6
6
  License: MIT License
7
- Project-URL: Homepage, https://github.com/patrickboateng/geolysis
8
- Project-URL: Documentation, https://geolysis.readthedocs.org
7
+ Project-URL: Homepage, https://docs.geolysis.io
8
+ Project-URL: Documentation, https://docs.geolysis.io
9
9
  Project-URL: Repository, https://github.com/patrickboateng/geolysis
10
10
  Project-URL: Discussions, https://github.com/patrickboateng/geolysis/discussions
11
11
  Project-URL: Issue Tracker, https://github.com/patrickboateng/geolysis/issues
12
- Keywords: geotechnical-engineering,soil-classification,settlement-analysis,bearing-capacity-analysis
12
+ Keywords: geotechnical-engineering,soil-classification,bearing-capacity-analysis,standard-penetration-test-analysis
13
13
  Classifier: Development Status :: 4 - Beta
14
14
  Classifier: Intended Audience :: Developers
15
15
  Classifier: Intended Audience :: Education
@@ -29,14 +29,15 @@ Requires-Dist: pytest; extra == "dev"
29
29
  Requires-Dist: pytest-cov; extra == "dev"
30
30
  Requires-Dist: coverage; extra == "dev"
31
31
 
32
- <h1 align="center">
32
+ <div align="center">
33
33
  <img src="https://raw.githubusercontent.com/patrickboateng/geolysis/dev/docs/source/_static/branding/geolysislogo.svg"
34
34
  alt="geolysislogo" width="75%" />
35
- </h1><br>
35
+ </div><br>
36
36
 
37
37
  <div align="center">
38
38
 
39
39
  [![PyPI Latest Release](https://img.shields.io/pypi/v/geolysis?style=flat&logo=pypi)](https://pypi.org/project/geolysis/)
40
+ [![PyPI Downloads](https://static.pepy.tech/badge/geolysis)](https://pepy.tech/projects/geolysis)
40
41
  [![PyPI pyversions](https://img.shields.io/pypi/pyversions/geolysis.svg?logo=python&style=flat)](https://pypi.python.org/pypi/geolysis/)
41
42
  [![license](https://img.shields.io/pypi/l/geolysis?style=flat&logo=opensourceinitiative)](https://opensource.org/license/mit/)
42
43
 
@@ -116,106 +117,70 @@ Here are brief descriptions of these projects:
116
117
 
117
118
  ## Installation
118
119
 
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
120
  ```shell
124
- pip install geolysis
121
+ $ pip install geolysis
125
122
  ```
126
123
 
127
124
  ## Usage Example
128
125
 
129
126
  ```python
130
127
 
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
128
+ >>> from geolysis.soil_classifier import create_soil_classifier
129
+ >>> uscs_clf = create_soil_classifier(liquid_limit=34.1,
130
+ ... plastic_limit=21.1,
131
+ ... fines=47.88,
132
+ ... sand=37.84,
133
+ ... clf_type="USCS")
134
+ >>> clf = uscs_clf.classify()
135
+ >>> clf
143
136
  SoilClf(symbol='SC', description='Clayey sands')
144
- >> > clf.symbol
137
+ >>> clf.symbol
145
138
  'SC'
146
- >> > clf.description
139
+ >>> clf.description
147
140
  'Clayey sands'
148
141
 
149
142
  ```
150
143
 
151
144
  ```python
152
145
 
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
146
+ >>> from geolysis.soil_classifier import create_soil_classifier
147
+ >>> aashto_clf = create_soil_classifier(liquid_limit=34.1,
148
+ ... plastic_limit=21.1,
149
+ ... fines=47.88,
150
+ ... sand=37.84, # Sand is optional for AASHTO classification
151
+ ... clf_type="AASHTO")
152
+ >>> clf = aashto_clf.classify()
153
+ >>> clf
165
154
  SoilClf(symbol='A-6(4)', description='Clayey soils')
166
- >> > clf.symbol
155
+ >>> clf.symbol
167
156
  'A-6(4)'
168
- >> > clf.description
157
+ >>> clf.description
169
158
  'Clayey soils'
170
159
 
171
160
  ```
172
161
 
173
162
  ## Features
174
163
 
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>
164
+ | | |
165
+ |----------------------------------------------|---------------------------------------|
166
+ | **Soil Classification** | AASHTO Classification System |
167
+ | | Unified Soil Classification System |
168
+ | **Standard Penetration Test (SPT) Analysis** | SPT Energy Correction |
169
+ | | SPT Overburden Pressure Correction |
170
+ | | Dilatancy Correction |
171
+ | | SPT N-Design Calculation |
172
+ | **Bearing Capacity Estimation** | Allowable Bearing Capacity Estimation |
173
+ | | Ultimate Bearing Capacity Estimation |
210
174
 
211
175
  ## Documentation
212
176
 
213
- Full documentation is available [here](https://www.geolysis.readthedocs.io)
214
-
215
- **_Note: Work on the latest documentation is still ongoing._**
177
+ Full documentation is available [here](https://docs.geolysis.io/en/latest/)
216
178
 
217
179
  ## Contributing
218
180
 
181
+ Contribution guidelines can be
182
+ found [here](https://docs.geolysis.io/en/latest/dev_guide/index.html)
183
+
219
184
  ## License
220
185
 
221
186
  This project is licensed under the MIT License - see the
{geolysis-0.4.2 → geolysis-0.4.3}/README.md RENAMED
@@ -1,11 +1,12 @@
1
- <h1 align="center">
1
+ <div align="center">
2
2
  <img src="https://raw.githubusercontent.com/patrickboateng/geolysis/dev/docs/source/_static/branding/geolysislogo.svg"
3
3
  alt="geolysislogo" width="75%" />
4
- </h1><br>
4
+ </div><br>
5
5
 
6
6
  <div align="center">
7
7
 
8
8
  [![PyPI Latest Release](https://img.shields.io/pypi/v/geolysis?style=flat&logo=pypi)](https://pypi.org/project/geolysis/)
9
+ [![PyPI Downloads](https://static.pepy.tech/badge/geolysis)](https://pepy.tech/projects/geolysis)
9
10
  [![PyPI pyversions](https://img.shields.io/pypi/pyversions/geolysis.svg?logo=python&style=flat)](https://pypi.python.org/pypi/geolysis/)
10
11
  [![license](https://img.shields.io/pypi/l/geolysis?style=flat&logo=opensourceinitiative)](https://opensource.org/license/mit/)
11
12
 
@@ -85,106 +86,70 @@ Here are brief descriptions of these projects:
85
86
 
86
87
  ## Installation
87
88
 
88
- **_Note: Work on the latest update is still in progress, so the usage example
89
- below
90
- will not function if installed._**
91
-
92
89
  ```shell
93
- pip install geolysis
90
+ $ pip install geolysis
94
91
  ```
95
92
 
96
93
  ## Usage Example
97
94
 
98
95
  ```python
99
96
 
100
- >> > from geolysis.soil_classifier import create_soil_classifier
101
- >> > uscs_clf = create_soil_classifier(liquid_limit=34.1,
102
- ...
103
- plastic_limit = 21.1,
104
- ...
105
- fines = 47.88,
106
- ...
107
- sand = 37.84,
108
- ...
109
- clf_type = "USCS")
110
- >> > clf = uscs_clf.classify()
111
- >> > clf
97
+ >>> from geolysis.soil_classifier import create_soil_classifier
98
+ >>> uscs_clf = create_soil_classifier(liquid_limit=34.1,
99
+ ... plastic_limit=21.1,
100
+ ... fines=47.88,
101
+ ... sand=37.84,
102
+ ... clf_type="USCS")
103
+ >>> clf = uscs_clf.classify()
104
+ >>> clf
112
105
  SoilClf(symbol='SC', description='Clayey sands')
113
- >> > clf.symbol
106
+ >>> clf.symbol
114
107
  'SC'
115
- >> > clf.description
108
+ >>> clf.description
116
109
  'Clayey sands'
117
110
 
118
111
  ```
119
112
 
120
113
  ```python
121
114
 
122
- >> > from geolysis.soil_classifier import create_soil_classifier
123
- >> > aashto_clf = create_soil_classifier(liquid_limit=34.1,
124
- ...
125
- plastic_limit = 21.1,
126
- ...
127
- fines = 47.88,
128
- ...
129
- sand = 37.84, # Sand is optional for AASHTO classification
130
- ...
131
- clf_type = "AASHTO")
132
- >> > clf = aashto_clf.classify()
133
- >> > clf
115
+ >>> from geolysis.soil_classifier import create_soil_classifier
116
+ >>> aashto_clf = create_soil_classifier(liquid_limit=34.1,
117
+ ... plastic_limit=21.1,
118
+ ... fines=47.88,
119
+ ... sand=37.84, # Sand is optional for AASHTO classification
120
+ ... clf_type="AASHTO")
121
+ >>> clf = aashto_clf.classify()
122
+ >>> clf
134
123
  SoilClf(symbol='A-6(4)', description='Clayey soils')
135
- >> > clf.symbol
124
+ >>> clf.symbol
136
125
  'A-6(4)'
137
- >> > clf.description
126
+ >>> clf.description
138
127
  'Clayey soils'
139
128
 
140
129
  ```
141
130
 
142
131
  ## Features
143
132
 
144
- <table>
145
- <tr>
146
- <td rowspan="2">
147
- <strong>Soil Classification</strong>
148
- </td>
149
- <td>AASHTO Classification System</td>
150
- </tr>
151
- <tr>
152
- <td>Unified Soil Classification System</td>
153
- </tr>
154
- <tr>
155
- <td rowspan="4">
156
- <strong>Standard Penetration Test (SPT) Analysis</strong>
157
- </td>
158
- <td>SPT Energy Correction</td>
159
- </tr>
160
- <tr>
161
- <td>SPT Overburden Pressure Correction</td>
162
- </tr>
163
- <tr>
164
- <td>Dilatancy Correction</td>
165
- </tr>
166
- <tr>
167
- <td>SPT N-Design Calculation</td>
168
- </tr>
169
- <tr>
170
- <td rowspan="2">
171
- <strong>Bearing Capacity Estimation</strong>
172
- </td>
173
- <td>Allowable Bearing Capacity Estimation</td>
174
- </tr>
175
- <tr>
176
- <td>Ultimate Bearing Capacity Estimation</td>
177
- </tr>
178
- </table>
133
+ | | |
134
+ |----------------------------------------------|---------------------------------------|
135
+ | **Soil Classification** | AASHTO Classification System |
136
+ | | Unified Soil Classification System |
137
+ | **Standard Penetration Test (SPT) Analysis** | SPT Energy Correction |
138
+ | | SPT Overburden Pressure Correction |
139
+ | | Dilatancy Correction |
140
+ | | SPT N-Design Calculation |
141
+ | **Bearing Capacity Estimation** | Allowable Bearing Capacity Estimation |
142
+ | | Ultimate Bearing Capacity Estimation |
179
143
 
180
144
  ## Documentation
181
145
 
182
- Full documentation is available [here](https://www.geolysis.readthedocs.io)
183
-
184
- **_Note: Work on the latest documentation is still ongoing._**
146
+ Full documentation is available [here](https://docs.geolysis.io/en/latest/)
185
147
 
186
148
  ## Contributing
187
149
 
150
+ Contribution guidelines can be
151
+ found [here](https://docs.geolysis.io/en/latest/dev_guide/index.html)
152
+
188
153
  ## License
189
154
 
190
155
  This project is licensed under the MIT License - see the
geolysis-0.4.3/geolysis/__init__.py ADDED
@@ -0,0 +1 @@
1
+ __version__ = "0.4.3"