Skip to main content

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

Project description

logo


GitHub Repo stars PyPI Latest Release PyPI pyversions GitHub last commit license

Coveralls Status CI-Unit-Test CI-Build-Test

Project Links

[!IMPORTANT] Project documentation is underway

Table of Contents

What is geolysis?

geolysis is an open-source software for geotechnical analysis and modeling. It provides features such as soil classifications (based on the USCS and AASHTO classification standards), estimating soil bearing capacity using SPT N-value, and estimating of soil engineering parameters such as Soil Unit Weight (moist, saturated, and submerged), Compression index, soil internal angle of friction, and undrained shear strength of soil.

Features to include in upcoming versions:

  • Settlement analysis
  • Discrete element method (DEM)

The motivation behind geolysis is to provide free software to assist geotechnical engineers in their day-to-day work and to expose civil engineering students (especially geotechnical students) to tools that can make them industry-ready geotechnical engineers right from college.

Installation

pip install geolysis

Soil Classification Example

AASHTO Classification

>>> from geolysis.soil_classifier import AASHTO
>>> aashto_cls = AASHTO(liquid_limit=30.2, plasticity_index=6.3, fines=11.18)
>>> aashto_cls.soil_class
'A-2-4(0)'
>>> aashto_cls.soil_desc
'Silty or clayey gravel and sand'

USCS Classification

>>> from geolysis.soil_classifier import USCS
>>> uscs_cls = USCS(liquid_limit=34.1, plastic_limit=21.1, fines=47.88,
...                 sand=37.84, gravel=14.8)
>>> uscs_cls.soil_class
'SC'
>>> uscs_cls.soil_desc
'Clayey sands'
>>> uscs_cls = USCS(liquid_limit=30.8, plastic_limit=20.7, fines=10.29,
...                 sand=81.89, gravel=7.83, d_10=0.07, d_30=0.3, d_60=0.8)
>>> uscs_cls.soil_class
'SW-SC'
>>> uscs_cls.soil_desc
'Well graded sand with clay'

Release History

Check the changelog for release history.

Code of Conduct

This project has a code of conduct that we expect all contributors to adhere to. Please read and follow it when participating in this project.

Contributing

If you would like to contribute to this project, please read the contributing guidelines

License

Distributed under the MIT license. By using, distributing, or contributing to this project, you agree to the terms and conditions of this license.

Contact Information

[!IMPORTANT] For questions or comments about geolysis, please ask them in the discussions forum

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

geolysis-0.2.0.tar.gz (25.8 kB view hashes)

Uploaded Source

Built Distribution

geolysis-0.2.0-py3-none-any.whl (21.6 kB view hashes)

Uploaded Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page