<h1 align="center">
<img src="https://raw.githubusercontent.com/patrickboateng/geolysis/dev/docs/source/_static/branding/geolysislogo.svg"
alt="geolysislogo" width="75%" />
</h1><br>
<div align="center">
[](https://pypi.org/project/geolysis/)
[](https://pypi.python.org/pypi/geolysis/)
[](https://opensource.org/license/mit/)
[](https://app.codacy.com/gh/patrickboateng/geolysis/dashboard?utm_source=gh&utm_medium=referral&utm_content=&utm_campaign=Badge_grade)
[](https://github.com/patrickboateng/geolysis/actions/workflows/unit-tests.yml)
[](https://geolysis.readthedocs.io/en/latest/?badge=latest)
</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>
## Project Structure
.
├── .github # GitHub Actions
├── docs # Documentation files
├── geolysis # Source files
├── tests # Automated tests
└── README.md
## Table of Contents
- [Installation](#installation)
- [Usage Example](#usage-example)
- [Features](#features)
- [Documentation](#documentation)
- [Contributing](#contributing)
- [License](#license)
- [Contact](#contact)
## Installation
**_Note: Work on the latest update is still in progress, so the usage example
below
will not function if installed._**
```shell
pip install geolysis
```
## Usage Example
```python
>> > from geolysis.soil_classifier import create_soil_classifier
>> > uscs_clf = create_soil_classifier(liquid_limit=34.1,
...
plastic_limit = 21.1,
...
fines = 47.88,
...
sand = 37.84,
...
clf_type = "USCS")
>> > clf = uscs_clf.classify()
>> > clf
SoilClf(symbol='SC', description='Clayey sands')
>> > clf.symbol
'SC'
>> > clf.description
'Clayey sands'
```
```python
>> > from geolysis.soil_classifier import create_soil_classifier
>> > aashto_clf = create_soil_classifier(liquid_limit=34.1,
...
plastic_limit = 21.1,
...
fines = 47.88,
...
sand = 37.84, # Sand is optional for AASHTO classification
...
clf_type = "AASHTO")
>> > clf = aashto_clf.classify()
>> > clf
SoilClf(symbol='A-6(4)', description='Clayey soils')
>> > clf.symbol
'A-6(4)'
>> > clf.description
'Clayey soils'
```
## Features
<table>
<tr>
<td rowspan="2">
<strong>Soil Classification</strong>
</td>
<td>AASHTO Classification System</td>
</tr>
<tr>
<td>Unified Soil Classification System</td>
</tr>
<tr>
<td rowspan="4">
<strong>Standard Penetration Test (SPT) Analysis</strong>
</td>
<td>SPT Energy Correction</td>
</tr>
<tr>
<td>SPT Overburden Pressure Correction</td>
</tr>
<tr>
<td>Dilatancy Correction</td>
</tr>
<tr>
<td>SPT N-Design Calculation</td>
</tr>
<tr>
<td rowspan="2">
<strong>Bearing Capacity Estimation</strong>
</td>
<td>Allowable Bearing Capacity Estimation</td>
</tr>
<tr>
<td>Ultimate Bearing Capacity Estimation</td>
</tr>
</table>
## Documentation
Full documentation is available [here](https://www.geolysis.readthedocs.io)
**_Note: Work on the latest documentation is still ongoing._**
## Contributing
## License
This project is licensed under the MIT License - see the
[LICENSE](https://github.com/patrickboateng/geolysis/blob/main/LICENSE.txt)
file for more details.
## Contact
For questions or feedback, please contact us at
[boatengpato.pb@gmail.com](mailto:boatengpato.pb@gmail.com)
Raw data
{
"_id": null,
"home_page": null,
"name": "geolysis",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.11",
"maintainer_email": null,
"keywords": "geotechnical-engineering, soil-classification, settlement-analysis, bearing-capacity-analysis",
"author": null,
"author_email": "Patrick Boateng <boatengpato.pb@gmail.com>",
"download_url": "https://files.pythonhosted.org/packages/8f/26/2298f5ca4ceae87c2a3ad79d915039e6d4ab535d273027c1406b631bc1e7/geolysis-0.4.2.tar.gz",
"platform": null,
"description": "<h1 align=\"center\">\n<img src=\"https://raw.githubusercontent.com/patrickboateng/geolysis/dev/docs/source/_static/branding/geolysislogo.svg\" \nalt=\"geolysislogo\" width=\"75%\" />\n</h1><br>\n\n<div align=\"center\">\n\n[](https://pypi.org/project/geolysis/)\n[](https://pypi.python.org/pypi/geolysis/)\n[](https://opensource.org/license/mit/)\n\n\n[](https://app.codacy.com/gh/patrickboateng/geolysis/dashboard?utm_source=gh&utm_medium=referral&utm_content=&utm_campaign=Badge_grade)\n[](https://github.com/patrickboateng/geolysis/actions/workflows/unit-tests.yml)\n[](https://geolysis.readthedocs.io/en/latest/?badge=latest)\n\n</div>\n\n`geolysis` is an open-source library for geotechnical analysis and modeling.\nIt offers tools for soil classification, Standard Penetration Test (SPT)\nanalysis, and bearing capacity estimation, among others.\n\nThe `geolysis` library is among four main projects: `geolysis.gui`,\n`geolysis.excel`, and `geolysis.ai`. The geolysis library powers all of these\nprojects.\n\n**_The `geolysis` projects are currently under developement and not yet\npublicly available_**.\n\n**_Active development of `geolysis` occurs on the `dev` branch. For more\ninformation on the latest features of `geolysis`, switch to the\n`dev` branch_**.\n\nHere are brief descriptions of these projects:\n\n<table>\n <tr>\n <td>\n <strong>geolysis.gui</strong>\n </td>\n <td>A graphical user interface that allows users to interact with the\n geolysis library. Through this interface, users can view generated reports\n and visualizations, such as Particle Size Distribution (PSD) curves,\n Atterberg Limits plots, and Compaction curves, among others.\n Additionally, it enables users to conduct foundation analysis and\n design, among other functionalities.\n </td>\n </tr>\n <tr>\n <td>\n <strong>geolysis.excel</strong>\n </td>\n <td>An add-in for Microsoft Excel that performs simple geotechnical\n analysis. It offers some features similar to <code>geolysis.gui</code>\n within Microsoft Excel.\n </td>\n </tr>\n <tr>\n <td>\n <strong>geolysis.ai</strong>\n </td>\n <td>Offers machine learning models that are trained using geotechnical data.\n </td>\n </tr>\n</table>\n\n## Project Structure\n\n .\n \u251c\u2500\u2500 .github # GitHub Actions\n \u251c\u2500\u2500 docs # Documentation files\n \u251c\u2500\u2500 geolysis # Source files\n \u251c\u2500\u2500 tests # Automated tests\n \u2514\u2500\u2500 README.md\n\n## Table of Contents\n\n- [Installation](#installation)\n- [Usage Example](#usage-example)\n- [Features](#features)\n- [Documentation](#documentation)\n- [Contributing](#contributing)\n- [License](#license)\n- [Contact](#contact)\n\n## Installation\n\n**_Note: Work on the latest update is still in progress, so the usage example\nbelow\nwill not function if installed._**\n\n```shell\n pip install geolysis\n```\n\n## Usage Example\n\n```python\n\n>> > from geolysis.soil_classifier import create_soil_classifier\n>> > uscs_clf = create_soil_classifier(liquid_limit=34.1,\n ...\nplastic_limit = 21.1,\n...\nfines = 47.88,\n...\nsand = 37.84,\n...\nclf_type = \"USCS\")\n>> > clf = uscs_clf.classify()\n>> > clf\nSoilClf(symbol='SC', description='Clayey sands')\n>> > clf.symbol\n'SC'\n>> > clf.description\n'Clayey sands'\n\n```\n\n```python\n\n>> > from geolysis.soil_classifier import create_soil_classifier\n>> > aashto_clf = create_soil_classifier(liquid_limit=34.1,\n ...\nplastic_limit = 21.1,\n...\nfines = 47.88,\n...\nsand = 37.84, # Sand is optional for AASHTO classification\n...\nclf_type = \"AASHTO\")\n>> > clf = aashto_clf.classify()\n>> > clf\nSoilClf(symbol='A-6(4)', description='Clayey soils')\n>> > clf.symbol\n'A-6(4)'\n>> > clf.description\n'Clayey soils'\n\n```\n\n## Features\n\n<table>\n <tr>\n <td rowspan=\"2\">\n <strong>Soil Classification</strong>\n </td>\n <td>AASHTO Classification System</td>\n </tr>\n <tr>\n <td>Unified Soil Classification System</td>\n </tr>\n <tr>\n <td rowspan=\"4\">\n <strong>Standard Penetration Test (SPT) Analysis</strong>\n </td>\n <td>SPT Energy Correction</td>\n </tr>\n <tr>\n <td>SPT Overburden Pressure Correction</td>\n </tr>\n <tr>\n <td>Dilatancy Correction</td>\n </tr>\n <tr>\n <td>SPT N-Design Calculation</td>\n </tr>\n <tr>\n <td rowspan=\"2\">\n <strong>Bearing Capacity Estimation</strong>\n </td>\n <td>Allowable Bearing Capacity Estimation</td>\n </tr>\n <tr>\n <td>Ultimate Bearing Capacity Estimation</td>\n </tr>\n</table>\n\n## Documentation\n\nFull documentation is available [here](https://www.geolysis.readthedocs.io)\n\n**_Note: Work on the latest documentation is still ongoing._**\n\n## Contributing\n\n## License\n\nThis project is licensed under the MIT License - see the\n[LICENSE](https://github.com/patrickboateng/geolysis/blob/main/LICENSE.txt)\nfile for more details.\n\n## Contact\n\nFor questions or feedback, please contact us at\n[boatengpato.pb@gmail.com](mailto:boatengpato.pb@gmail.com)\n",
"bugtrack_url": null,
"license": "MIT License",
"summary": "geolysis.core is an opensource software for geotechnical engineering analysis and modeling.",
"version": "0.4.2",
"project_urls": {
"Discussions": "https://github.com/patrickboateng/geolysis/discussions",
"Documentation": "https://geolysis.readthedocs.org",
"Homepage": "https://github.com/patrickboateng/geolysis",
"Issue Tracker": "https://github.com/patrickboateng/geolysis/issues",
"Repository": "https://github.com/patrickboateng/geolysis"
},
"split_keywords": [
"geotechnical-engineering",
" soil-classification",
" settlement-analysis",
" bearing-capacity-analysis"
],
"urls": [
{
"comment_text": null,
"digests": {
"blake2b_256": "5b54085394fd174085a4a4f5b574fae241de7fd84ceefa4618712692e92ced1b",
"md5": "777f506c81451e26ee0561c1777ef9ea",
"sha256": "60d42af23cb86ce3b5cd7b36e5a319e04233fe5264d5296b42c459d92e7b2cbf"
},
"downloads": -1,
"filename": "geolysis-0.4.2-py3-none-any.whl",
"has_sig": false,
"md5_digest": "777f506c81451e26ee0561c1777ef9ea",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.11",
"size": 17987,
"upload_time": "2025-02-16T03:01:24",
"upload_time_iso_8601": "2025-02-16T03:01:24.496859Z",
"url": "https://files.pythonhosted.org/packages/5b/54/085394fd174085a4a4f5b574fae241de7fd84ceefa4618712692e92ced1b/geolysis-0.4.2-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "8f262298f5ca4ceae87c2a3ad79d915039e6d4ab535d273027c1406b631bc1e7",
"md5": "102dcc8c7b645d37d4dd0c6522b271af",
"sha256": "7a66f332812a3f6cc80759224fd8488a16fcd0ab2b3b291ebf5bae15473c9cd0"
},
"downloads": -1,
"filename": "geolysis-0.4.2.tar.gz",
"has_sig": false,
"md5_digest": "102dcc8c7b645d37d4dd0c6522b271af",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.11",
"size": 21398,
"upload_time": "2025-02-16T03:01:26",
"upload_time_iso_8601": "2025-02-16T03:01:26.283623Z",
"url": "https://files.pythonhosted.org/packages/8f/26/2298f5ca4ceae87c2a3ad79d915039e6d4ab535d273027c1406b631bc1e7/geolysis-0.4.2.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-02-16 03:01:26",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "patrickboateng",
"github_project": "geolysis",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "geolysis"
}
JSON
