Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/patrickboateng/geolysis
An open-source software for geotechnical engineering analysis and modeling.
https://github.com/patrickboateng/geolysis
bearing-capacity-analysis discrete-element-method discrete-element-modelling geotechnical-engineering settlement-analysis soil-classification
Last synced: about 2 months ago
JSON representation
An open-source software for geotechnical engineering analysis and modeling.
- Host: GitHub
- URL: https://github.com/patrickboateng/geolysis
- Owner: patrickboateng
- License: mit
- Created: 2023-02-19T23:21:23.000Z (almost 2 years ago)
- Default Branch: main
- Last Pushed: 2024-05-21T21:40:10.000Z (8 months ago)
- Last Synced: 2024-05-22T20:00:24.852Z (8 months ago)
- Topics: bearing-capacity-analysis, discrete-element-method, discrete-element-modelling, geotechnical-engineering, settlement-analysis, soil-classification
- Language: Python
- Homepage: https://geolysis.readthedocs.org/en/latest
- Size: 1.69 MB
- Stars: 4
- Watchers: 4
- Forks: 3
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Contributing: docs/CONTRIBUTING.md
- License: LICENSE.txt
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
[code_of_conduct_url]: https://github.com/patrickboateng/geolysis/blob/main/CODE_OF_CONDUCT.md/
[contributing_url]: https://github.com/patrickboateng/geolysis/blob/main/docs/CONTRIBUTING.md#how-to-contribute
[license_url]: https://github.com/patrickboateng/geolysis/blob/main/LICENSE.txt
# geolysis
[](https://pypi.org/project/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/unit-tests.yml)
[](https://geolysis.readthedocs.io/en/latest/?badge=latest)
#
> [!NOTE]
> Active development of `geolysis` occurs on the `dev` branch. For more
> information for the lastest features of `geolysis`, switch to the
> `dev` branch.
`geolysis` is your one-stop shop for all your geotechnical engineering
solutions, ranging from site investigation and laboratory test analysis
to advanced geotechnical designs.
`geolysis` is divided into four (4) main parts:
1. `geolyis.core (Python)`
`geolysis.core` is an open-source Python package that provides features for
analyzing geotechnical results obtained from field and laboratory tests.
`geolysis.core` is designed specifically to assist developers in building
applications that can solve complex geotechnical problems.
Whether you're working on soil mechanics, rock mechanics, or any other
geotechnical field, `geolysis.core` provides a powerful set of tools that can
help you design and develop robust solutions. With an intuitive API and a
wide range of features, this software is an essential tool for anyone who
needs to work with geotechnical data on a regular basis. Whether you're a
seasoned geotechnical engineer or a new developer just getting started in the
field, `geolysis.core` is the ideal solution for all your software
development needs.
Some of the features implemented so far include soil classification, standard
penetration test analysis (such as SPT N-design and SPT N-value corrections),
and calculating the allowable bearing capacity of soils from Standard
Penetration Test N-values. There are more features underway, which include
settlement analysis, ultimate bearing capacity analysis, etc.
`geolysis.core` is the foundation application on which other parts of the
application will depend. Developers can also use `geolysis.core` to power
their applications.
1. `geolysis.ui (Qt, PySide6)`
`geolysis.ui` is a Graphical User Interface (GUI) which will enable users to
graphically interact with `geolysis`. Users will be able to input data and
view generated plots, such as `PSD` curves, `Atterberg Limits` plots,
`Compaction` curves, etc within the application.
1. `geolysis.excel (Javascript & Others)`
`geolysis.excel` provides a Microsoft Excel add-in for simple geotechnical
analysis. _More on this later._
1. `geolysis.ai (Python, Pytorch & Others)`
`geolysis.ai` explores the use of Artificial Intelligence (**AI**) in
enhancing productivity in Geotechnical Engineering.
Lastly `geolysis.docs` is the documentation project for `geolysis`.
## Project Links
- [Documentation](https://geolysis.readthedocs.org/en/latest)
- [Repo](https://github.com/patrickboateng/geolysis)
- [PyPi](https://pypi.org/project/geolysis/)
- [Bug Reports](https://github.com/patrickboateng/geolysis/issues)
- [Discussions](https://github.com/patrickboateng/geolysis/discussions)
## Table of Contents
- [Motivation](#motivation)
- [Installation](#installation)
- [Getting Started](#getting-started)
- [Soil Classification Example](#soil-classification-example)
- [Release History](#release-history)
- [Code of Conduct](#code-of-conduct)
- [Contributing](#contributing)
- [License](#license)
- [Governance of this project](#governance-of-this-project)
- [Contact Information](#contact-information)
## Motivation
`geolysis` is a software solution that aims to support geotechnical engineers in
their daily work by providing a set of tools that makes them perform their tasks
in a more efficient and effective manner.
Moreover, the platform is designed to educate civil engineering students,
especially those who specialize in geotechnical engineering, by exposing them to
industry-relevant tools and techniques that will help them become industry-ready
professionals as soon as they graduate.
With `geolysis`, users will be better equipped to handle geotechnical
challenges, make informed decisions, and improve their overall productivity.
## Installation
```shell
pip install geolysis
```
## Getting Started
### Soil Classification Example
AASHTO classification
```python
>>> from geolysis.core.soil_classifier import ClfType, create_soil_classifier
>>> aashto_clf = create_soil_classifier(
... liquid_limit=30.2,
... plastic_limit=23.9,
... fines=11.18,
... clf_type=ClfType.AASHTO,
... )
>>> aashto_clf.classify()
'A-2-4(0)'
>>> aashto_clf.description()
'Silty or clayey gravel and sand'
```
USCS Classification
```python
>>> from geolysis.core.soil_classifier import ClfType, create_soil_classifier
>>> uscs_clf = create_soil_classifier(
... liquid_limit=34.1,
... plastic_limit=21.1,
... fines=47.88,
... sand=37.84,
... clf_type=ClfType.USCS,
... )
>>>
>>> uscs_clf.classify()
'SC'
>>> uscs_clf.description()
'Clayey sands'
>>> uscs_clf = create_soil_classifier(
... liquid_limit=30.8,
... plastic_limit=20.7,
... fines=10.29,
... sand=81.89,
... d_10=0.07,
... d_30=0.3,
... d_60=0.8,
... clf_type=ClfType.USCS,
... )
>>> uscs_clf.classify()
'SW-SC'
>>> uscs_clf.description()
'Well graded sand with clay'
```
## Release History
Check out the [release notes](https://geolysis.rtfd.io/en/latest/release_notes/index.html)
for features.
## Code of Conduct
This project has a [code of conduct][code_of_conduct_url] 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][contributing_url]
## License
Distributed under the [**MIT**][license_url] license. By using, distributing, or
contributing to this project, you agree to the terms and conditions of this
license.
## Governance of this project
`geolysis.core` is still developing relatively rapidly, so please be patient if
things change or features iterate and change quickly.
Once `geolysis.core` hits `1.0.0`, it will slow down considerably.
## Contact Information
- [**LinkedIn**](https://linkedin.com/in/patrickboateng/)
> [!IMPORTANT]
> For questions or comments about `geolysis`, please ask them in the
> [discussions forum](https://github.com/patrickboateng/geolysis/discussions)