geolysis 0.24.0

geolysis is an opensource software for geotechnical engineering analysis and modeling.

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