<div align="center">
<img src="https://raw.githubusercontent.com/patrickboateng/geolysis/main/docs/assets/pkg-logo.svg"
alt="logo" width="30%" height="30%" />
</div><br>
<div align="center">
[](https://pypi.org/project/geolysis/)
[](https://pepy.tech/projects/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/geolysis-unit-tests.yml)
[](https://geolysis.readthedocs.io/en/latest/?badge=latest)
</div>
`geolysis` is an open-source python package (library) for geotechnical analysis
and modeling.
The `geolysis` python package is among three other projects, `geolysis.excel`,
`geolysis.gui`, and `geolysis.ai`. More details about these projects are
provided [here](https://github.com/geolysis-dev).
`geolysis` has only one project dependency which is [func-validator](https://github.com/patrickboateng/func-validator/)
for validating `function` (and `method`) arguments.
The rest of this **README** provides an overview of the `geolysis` python
package.
## Table of Contents
- [Installation](#installation)
- [API Reference](#api-reference)
- [Imports](#imports)
- [Project Structure](#project-structure)
- [Usage](#usage)
- [Documentation](#documentation)
- [Contributing](#contributing)
- [License](#license)
- [Contact](#contact)
## Installation
```shell
$ pip install geolysis
```
## API Reference
- [Python API](https://docs.geolysis.io/en/latest/reference/)
- [geolysis.bearing_capacity.abc](https://docs.geolysis.io/en/latest/reference/allowable_bearing_capacity/) - _Allowable bearing capacity
estimation_
- [geolysis.bearing_capacity.ubc](https://docs.geolysis.io/en/latest/reference/ultimate_bearing_capacity/) - _Ultimate bearing capacity
estimation_
- [geolysis.foundation](https://docs.geolysis.io/en/latest/reference/foundation/) - _Foundation Representation_
- [geolysis.soil_classifier](https://docs.geolysis.io/en/latest/reference/soil_classifier/) - _Soil classification_
- [geolysis.spt](https://docs.geolysis.io/en/latest/reference/spt/) - _Standard Penetration Test (SPT) Analysis_
- [geolysis.utils](https://docs.geolysis.io/en/latest/reference/utils/) - _Utilities_
## Imports
- **Bearing Capacity**
- **Allowable Bearing Capacity (ABC)**
```python
from geolysis.bearing_capacity.abc import create_abc_4_cohesionless_soils
```
- **Ultimate Bearing Capacity (UBC)**
```python
from geolysis.bearing_capacity.ubc import create_ubc_4_all_soil_types
```
- **Foundation**
```python
from geolysis.foundation import create_foundation
```
- **Soil Classification**
```python
from geolysis.soil_classifier import create_uscs_classifier
from geolysis.soil_classifier import create_aashto_classifier
```
- **Standard Penetration Test (SPT) Analysis**
```python
from geolysis.spt import DilatancyCorrection
from geolysis.spt import EnergyCorrection
from geolysis.spt import SPT
from geolysis.spt import create_overburden_pressure_correction
```
## Project Structure
.
├── .github # GitHub Actions
├── docs # Documentation files
├── geolysis # Source files
├── tests # Automated tests
├── pyproject.toml # Project configuration file
└── README.md # Project README file
## Usage
```python
>>> from geolysis.soil_classifier import create_aashto_classifier
>>> aashto_clf = create_aashto_classifier(liquid_limit=34.1,
... plastic_limit=21.1,
... fines=47.88, )
>>> clf = aashto_clf.classify()
>>> clf.symbol
'A-6(4)'
>>> clf.symbol_no_grp_idx
'A-6'
>>> clf.group_index
'4'
>>> clf.description
'Clayey soils'
```
Check out more [examples](https://docs.geolysis.io/en/latest/usage/)
## Documentation
Check out the full [documentation](https://docs.geolysis.io/en/latest/).
## Contributing
Check out the [contribution guidelines](https://docs.geolysis.io/en/latest/dev_guide/)
## 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 [patrickboateng at patrickboateng dot tech](mailto:patrickboateng@patrickboateng.tech)
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, bearing-capacity-analysis, standard-penetration-test-analysis",
"author": null,
"author_email": "Patrick Boateng <boatengpato.pb@gmail.com>",
"download_url": "https://files.pythonhosted.org/packages/ff/49/ccfb63aa4aa8919c60665cd5b1444bff5dc6f0efb996cb84a5ae4467907d/geolysis-0.10.3.tar.gz",
"platform": null,
"description": "<div align=\"center\">\n<img src=\"https://raw.githubusercontent.com/patrickboateng/geolysis/main/docs/assets/pkg-logo.svg\" \nalt=\"logo\" width=\"30%\" height=\"30%\" />\n</div><br>\n\n<div align=\"center\">\n\n[](https://pypi.org/project/geolysis/)\n[](https://pepy.tech/projects/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/geolysis-unit-tests.yml)\n[](https://geolysis.readthedocs.io/en/latest/?badge=latest)\n\n</div>\n\n`geolysis` is an open-source python package (library) for geotechnical analysis\nand modeling.\n\nThe `geolysis` python package is among three other projects, `geolysis.excel`,\n`geolysis.gui`, and `geolysis.ai`. More details about these projects are\nprovided [here](https://github.com/geolysis-dev).\n\n`geolysis` has only one project dependency which is [func-validator](https://github.com/patrickboateng/func-validator/)\nfor validating `function` (and `method`) arguments.\n\nThe rest of this **README** provides an overview of the `geolysis` python\npackage.\n\n## Table of Contents\n\n- [Installation](#installation)\n- [API Reference](#api-reference)\n- [Imports](#imports)\n- [Project Structure](#project-structure)\n- [Usage](#usage)\n- [Documentation](#documentation)\n- [Contributing](#contributing)\n- [License](#license)\n- [Contact](#contact)\n\n## Installation\n\n```shell\n$ pip install geolysis\n```\n\n## API Reference\n\n- [Python API](https://docs.geolysis.io/en/latest/reference/) \n - [geolysis.bearing_capacity.abc](https://docs.geolysis.io/en/latest/reference/allowable_bearing_capacity/) - _Allowable bearing capacity\n estimation_\n - [geolysis.bearing_capacity.ubc](https://docs.geolysis.io/en/latest/reference/ultimate_bearing_capacity/) - _Ultimate bearing capacity\n estimation_\n - [geolysis.foundation](https://docs.geolysis.io/en/latest/reference/foundation/) - _Foundation Representation_\n - [geolysis.soil_classifier](https://docs.geolysis.io/en/latest/reference/soil_classifier/) - _Soil classification_\n - [geolysis.spt](https://docs.geolysis.io/en/latest/reference/spt/) - _Standard Penetration Test (SPT) Analysis_\n - [geolysis.utils](https://docs.geolysis.io/en/latest/reference/utils/) - _Utilities_\n\n\n## Imports\n\n- **Bearing Capacity**\n\n - **Allowable Bearing Capacity (ABC)**\n \n ```python\n from geolysis.bearing_capacity.abc import create_abc_4_cohesionless_soils\n ```\n \n - **Ultimate Bearing Capacity (UBC)**\n \n ```python\n from geolysis.bearing_capacity.ubc import create_ubc_4_all_soil_types\n ```\n\n- **Foundation**\n \n ```python\n from geolysis.foundation import create_foundation\n ```\n\n\n- **Soil Classification**\n \n ```python\n from geolysis.soil_classifier import create_uscs_classifier\n from geolysis.soil_classifier import create_aashto_classifier\n ```\n \n- **Standard Penetration Test (SPT) Analysis**\n \n ```python\n from geolysis.spt import DilatancyCorrection\n from geolysis.spt import EnergyCorrection\n from geolysis.spt import SPT\n from geolysis.spt import create_overburden_pressure_correction\n ```\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 \u251c\u2500\u2500 pyproject.toml # Project configuration file\n \u2514\u2500\u2500 README.md # Project README file\n\n## Usage\n\n```python\n\n>>> from geolysis.soil_classifier import create_aashto_classifier\n>>> aashto_clf = create_aashto_classifier(liquid_limit=34.1,\n... plastic_limit=21.1,\n... fines=47.88, )\n>>> clf = aashto_clf.classify()\n>>> clf.symbol\n'A-6(4)'\n>>> clf.symbol_no_grp_idx\n'A-6'\n>>> clf.group_index\n'4'\n>>> clf.description\n'Clayey soils'\n\n```\n\nCheck out more [examples](https://docs.geolysis.io/en/latest/usage/)\n\n## Documentation\n\nCheck out the full [documentation](https://docs.geolysis.io/en/latest/).\n\n## Contributing\n\nCheck out the [contribution guidelines](https://docs.geolysis.io/en/latest/dev_guide/)\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\ncontact [patrickboateng at patrickboateng dot tech](mailto:patrickboateng@patrickboateng.tech)\n",
"bugtrack_url": null,
"license": "MIT License",
"summary": "geolysis is an opensource software for geotechnical engineering analysis and modeling.",
"version": "0.10.3",
"project_urls": {
"Discussions": "https://github.com/patrickboateng/geolysis/discussions",
"Documentation": "https://docs.geolysis.io",
"Homepage": "https://docs.geolysis.io",
"Issue Tracker": "https://github.com/patrickboateng/geolysis/issues",
"Repository": "https://github.com/patrickboateng/geolysis"
},
"split_keywords": [
"geotechnical-engineering",
" soil-classification",
" bearing-capacity-analysis",
" standard-penetration-test-analysis"
],
"urls": [
{
"comment_text": null,
"digests": {
"blake2b_256": "fe45b8407735ee645004b4c21b57884b22b1ab0ccfd3f0567c0c092bc3e787f8",
"md5": "cb8b58939f7f838a3dc52530547a2c58",
"sha256": "a6e653cdf0e600f292486af1ab96a54dfd9112714c7c63767499755d9954637f"
},
"downloads": -1,
"filename": "geolysis-0.10.3-py3-none-any.whl",
"has_sig": false,
"md5_digest": "cb8b58939f7f838a3dc52530547a2c58",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.11",
"size": 33279,
"upload_time": "2025-09-05T21:36:18",
"upload_time_iso_8601": "2025-09-05T21:36:18.202478Z",
"url": "https://files.pythonhosted.org/packages/fe/45/b8407735ee645004b4c21b57884b22b1ab0ccfd3f0567c0c092bc3e787f8/geolysis-0.10.3-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "ff49ccfb63aa4aa8919c60665cd5b1444bff5dc6f0efb996cb84a5ae4467907d",
"md5": "07a06c7651c626eb87bb5f7a7c005166",
"sha256": "909511ad7d2c9ac56583a3b964b98bdabbd4bc3b12e21de1eb720ef8f49132da"
},
"downloads": -1,
"filename": "geolysis-0.10.3.tar.gz",
"has_sig": false,
"md5_digest": "07a06c7651c626eb87bb5f7a7c005166",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.11",
"size": 30658,
"upload_time": "2025-09-05T21:36:19",
"upload_time_iso_8601": "2025-09-05T21:36:19.953386Z",
"url": "https://files.pythonhosted.org/packages/ff/49/ccfb63aa4aa8919c60665cd5b1444bff5dc6f0efb996cb84a5ae4467907d/geolysis-0.10.3.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-09-05 21:36:19",
"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
