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.
[!IMPORTANT] The
geolysis.excel(an Excel Add-in), is available to install from the Microsoft AppSource Store using this installer link: https://appsource.microsoft.com/en-us/product/Office365/WA200009428
geolysis has only one project dependency which
is 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
- API Reference
- Imports
- Project Structure
- Usage
- Documentation
- Contributing
- License
- Contact
Installation
$ pip install geolysis
API Reference
- Python API
- geolysis.bearing_capacity.abc - Allowable bearing capacity estimation
- geolysis.bearing_capacity.ubc - Ultimate bearing capacity estimation
- geolysis.foundation - Foundation Representation
- geolysis.soil_classifier - Soil classification
- geolysis.spt - Standard Penetration Test (SPT) Analysis
- geolysis.utils - Utilities
Imports
Bearing Capacity
-
Allowable Bearing Capacity (ABC)
from geolysis.bearing_capacity.abc import create_abc_4_cohesionless_soils
-
Ultimate Bearing Capacity (UBC)
from geolysis.bearing_capacity.ubc import create_ubc_4_all_soils
Foundation
from geolysis.foundation import create_foundation
Soil Classification
from geolysis.soil_classifier import create_uscs_classifier
from geolysis.soil_classifier import create_aashto_classifier
Standard Penetration Test (SPT) Analysis
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
These are the main components of the 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
>>> 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_group_idx
'A-6'
>>> clf.group_index
'4'
>>> clf.description
'Clayey soils'
Check out more examples
Documentation
Check out the full documentation.
Contributing
Check out the contribution guidelines
License
This project is licensed under the MIT License - see the LICENSE file for more details.
Contact
For questions or feedback, please contact patrickboateng at patrickboateng dot tech
1 maintainer
Release files for geolysis 0.24.1
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| geolysis-0.24.1.tar.gz | 30.6 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| geolysis-0.24.1-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 62.6 kB
Release files / geolysis-0.24.1.tar.gz
| Download URL | geolysis-0.24.1.tar.gz |
|---|---|
| Size | 30.6 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
e28fe470bd1b8c4d788e5361dc9fee9ebee33de8b6aa6c5379f1bb4df6246f97
|
|
BLAKE2b-256 checksum How to use checksums |
07f849618bad91ef61de0f19096b63879c12563b7e42e37a4497af124ec61728
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/6.1.0 CPython/3.13.7
|
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Jan 31, 2026.
Transparency logRelease files / geolysis-0.24.1-py3-none-any.whl
| Download URL | geolysis-0.24.1-py3-none-any.whl |
|---|---|
| Size | 32.1 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
e786397096473e925cb2e79d6f67fc854a0fb6e517a8fbca0e78d5fab95b2d6f
|
|
BLAKE2b-256 checksum How to use checksums |
667ef7b2b050f12e361c710a25d95590ff05e89bfeac7d3b64bb9a25da0f1a01
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/6.1.0 CPython/3.13.7
|
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Jan 31, 2026.
Transparency log
