Welcome to geolysis documentation

geolysis is an open-source python package (library) for geotechnical analysis and modeling.

Geotechnical Software Toolkit

The geolysis python package is among three other projects, geolysis.excel, geolysis.gui, and geolysis.ai. For me information on the full geotechnical toolkit, click here.

Installation

geolysis supports Python 3.11 - 3.12. We also recommend using a virtual environment in order to isolate your project dependencies from other projects and the system.

geolysis can be installed via pip as follows for the supported operating systems.

pip install geolysis # "pip3 install geolysis" for unix systems

Version Check

To see whether geolysis is already installed or to check if an install has worked, run the following in a Python shell:

import geolysis as gl
print(gl.__version__) 

or from the command line:

python -c "import geolysis; print(geolysis.__version__)" # python3 for unix systems

You'll see the version number if geolysis is installed and an error message otherwise.

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

Contributing

Contributions are always welcome! Please check the contributing guidelines

Release Notes

Please see the release notes