[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
<div align="center">
[](https://pypi.org/project/geolysis/)
[](https://pypi.python.org/pypi/geolysis/)
[](https://opensource.org/license/mit/)
[](https://github.com/patrickboateng/geolysis/actions/workflows/unit-tests.yml)
[](https://github.com/patrickboateng/geolysis/actions/workflows/pkg_build.yml)
[](https://geolysis.readthedocs.io/en/latest/?badge=latest)
</div>
#
`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 Package)`
`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`. User 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.
## 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)
<!-- > [!IMPORTANT]
> Project documentation is underway -->
## 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 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
```python
>>> from geolysis.core.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'
```
<!-- See the [Quick start section] of the docs for more examples. -->
## 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)
Raw data
{
"_id": null,
"home_page": null,
"name": "geolysis",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.10",
"maintainer_email": null,
"keywords": "discrete-element-method, geotechnical-engineering, soil-classification, settlement-analysis, bearing-capacity-analysis",
"author": null,
"author_email": "Patrick Boateng <boatengpato.pb@gmail.com>",
"download_url": "https://files.pythonhosted.org/packages/39/75/f57dc266495db1ef34a254ff6c78b50cb74236da4e2c95d54e42ccf03aef/geolysis-0.3.0.tar.gz",
"platform": null,
"description": "[code_of_conduct_url]: https://github.com/patrickboateng/geolysis/blob/main/CODE_OF_CONDUCT.md/\r\n[contributing_url]: https://github.com/patrickboateng/geolysis/blob/main/docs/CONTRIBUTING.md#how-to-contribute\r\n[license_url]: https://github.com/patrickboateng/geolysis/blob/main/LICENSE.txt\r\n\r\n# geolysis\r\n\r\n<div align=\"center\">\r\n\r\n[](https://pypi.org/project/geolysis/)\r\n[](https://pypi.python.org/pypi/geolysis/)\r\n[](https://opensource.org/license/mit/)\r\n\r\n\r\n[](https://github.com/patrickboateng/geolysis/actions/workflows/unit-tests.yml)\r\n[](https://github.com/patrickboateng/geolysis/actions/workflows/pkg_build.yml)\r\n[](https://geolysis.readthedocs.io/en/latest/?badge=latest)\r\n\r\n</div>\r\n\r\n#\r\n\r\n`geolysis` is your one-stop shop for all your geotechnical engineering\r\nsolutions, ranging from site investigation and laboratory test analysis\r\nto advanced geotechnical designs.\r\n\r\n`geolysis` is divided into four (4) main parts:\r\n\r\n1. `geolyis.core (Python Package)`\r\n\r\n `geolysis.core` is an open-source Python package that provides features\r\n for analyzing geotechnical results obtained from field and laboratory\r\n tests. `geolysis.core` is designed specifically to assist developers\r\n in building applications that can solve complex geotechnical\r\n problems.\r\n\r\n Whether you're working on soil mechanics, rock mechanics, or any other\r\n geotechnical field, `geolysis.core` provides a powerful set of tools\r\n that can help you design and develop robust solutions. With an\r\n intuitive API and a wide range of features, this software is an\r\n essential tool for anyone who needs to work with geotechnical data on\r\n a regular basis. Whether you're a seasoned geotechnical engineer or a\r\n new developer just getting started in the field, `geolysis.core` is\r\n the ideal solution for all your software development needs.\r\n\r\n Some of the features implemented so far include soil classification,\r\n standard penetration test analysis (such as SPT N-design and SPT\r\n N-value corrections), and calculating the allowable bearing capacity of\r\n soils from Standard Penetration Test N-values.\u00a0There are more features\r\n underway, which include\u00a0settlement analysis, ultimate bearing capacity\r\n analysis,\u00a0etc.\r\n\r\n `geolysis.core` is the foundation application on which other parts of the\r\n application will depend. Developers can also use `geolysis.core` to power\r\n their applications.\r\n\r\n1. `geolysis.ui (Qt, PySide6)`\r\n\r\n `geolysis.ui` is a Graphical User Interface (GUI) which will enable\r\n users to graphically interact with `geolysis`. User will be able to\r\n input data and view generated plots, such as `PSD` curves,\r\n `Atterberg Limits` plots, `Compaction` curves, etc within the application.\r\n\r\n1. `geolysis.excel (Javascript & Others)`\r\n\r\n `geolysis.excel` provides a Microsoft Excel add-in for simple geotechnical\r\n analysis. _More on this later._\r\n\r\n1. `geolysis.ai (Python, Pytorch & Others)`\r\n\r\n `geolysis.ai` explores the use of Artificial Intelligence (**AI**) in\r\n enhancing productivity in Geotechnical Engineering.\r\n\r\n## Project Links\r\n\r\n- [Documentation](https://geolysis.readthedocs.org/en/latest)\r\n- [Repo](https://github.com/patrickboateng/geolysis)\r\n- [PyPi](https://pypi.org/project/geolysis/)\r\n- [Bug Reports](https://github.com/patrickboateng/geolysis/issues)\r\n- [Discussions](https://github.com/patrickboateng/geolysis/discussions)\r\n\r\n<!-- > [!IMPORTANT]\r\n> Project documentation is underway -->\r\n\r\n## Table of Contents\r\n\r\n- [Motivation](#motivation)\r\n- [Installation](#installation)\r\n- [Getting Started](#getting-started)\r\n - [Soil Classification Example](#soil-classification-example)\r\n- [Release History](#release-history)\r\n- [Code of Conduct](#code-of-conduct)\r\n- [Contributing](#contributing)\r\n- [License](#license)\r\n- [Governance of this project](#governance-of-this-project)\r\n- [Contact Information](#contact-information)\r\n\r\n## Motivation\r\n\r\n`geolysis` is a software solution that aims to support geotechnical\r\nengineers in their daily work by providing a set of tools that makes\r\nthem perform their tasks in a more efficient and effective manner.\r\nMoreover, the platform is designed to educate civil engineering\r\nstudents, especially those who specialize in geotechnical engineering,\r\nby exposing them to industry-relevant tools and techniques that will\r\nhelp them become industry-ready professionals as soon as they graduate.\r\nWith `geolysis`, users will be better equipped to handle geotechnical\r\nchallenges, make informed decisions, and improve their overall\r\nproductivity.\r\n\r\n## Installation\r\n\r\n```shell\r\npip install geolysis\r\n```\r\n\r\n## Getting Started\r\n\r\n### Soil Classification Example\r\n\r\nAASHTO classification\r\n\r\n```python\r\n\r\n>>> from geolysis.core.soil_classifier import AASHTO\r\n>>> aashto_cls = AASHTO(liquid_limit=30.2, plasticity_index=6.3, fines=11.18)\r\n>>> aashto_cls.soil_class\r\n'A-2-4(0)'\r\n>>> aashto_cls.soil_desc\r\n'Silty or clayey gravel and sand'\r\n\r\n```\r\n\r\nUSCS Classification\r\n\r\n```python\r\n\r\n>>> from geolysis.core.soil_classifier import USCS\r\n>>> uscs_cls = USCS(liquid_limit=34.1, plastic_limit=21.1,\r\n... fines=47.88, sand=37.84, gravel=14.8)\r\n>>> uscs_cls.soil_class\r\n'SC'\r\n>>> uscs_cls.soil_desc\r\n'Clayey sands'\r\n>>> uscs_cls = USCS(liquid_limit=30.8, plastic_limit=20.7, fines=10.29,\r\n... sand=81.89, gravel=7.83, d_10=0.07, d_30=0.3, d_60=0.8)\r\n>>> uscs_cls.soil_class\r\n'SW-SC'\r\n>>> uscs_cls.soil_desc\r\n'Well graded sand with clay'\r\n\r\n```\r\n\r\n<!-- See the [Quick start section] of the docs for more examples. -->\r\n\r\n## Release History\r\n\r\nCheck out the [release notes](https://geolysis.rtfd.io/en/latest/release_notes/index.html)\r\nfor features.\r\n\r\n## Code of Conduct\r\n\r\nThis project has a [code of conduct][code_of_conduct_url] that\r\nwe expect all contributors to adhere to. Please read and follow\r\nit when participating in this project.\r\n\r\n## Contributing\r\n\r\nIf you would like to contribute to this project, please read\r\nthe [contributing guidelines][contributing_url]\r\n\r\n## License\r\n\r\nDistributed under the [**MIT**][license_url] license. By using,\r\ndistributing, or contributing to this project, you agree to the\r\nterms and conditions of this license.\r\n\r\n## Governance of this project\r\n\r\n`geolysis.core` is still developing relatively rapidly, so please\r\nbe patient if things change or features iterate and change quickly.\r\nOnce `geolysis.core` hits `1.0.0`, it will slow down considerably.\r\n\r\n## Contact Information\r\n\r\n- [**LinkedIn**](https://linkedin.com/in/patrickboateng/)\r\n\r\n> [!IMPORTANT]\r\n> For questions or comments about `geolysis`, please ask them in the\r\n> [discussions forum](https://github.com/patrickboateng/geolysis/discussions)\r\n",
"bugtrack_url": null,
"license": "MIT License",
"summary": "geolysis.core is an opensource software for geotechnical engineering analysis and modeling.",
"version": "0.3.0",
"project_urls": {
"Changelog": "https://github.com/patrickboateng/geolysis/blob/main/CHANGELOG.md",
"Discussions": "https://github.com/patrickboateng/geolysis/discussions",
"Homepage": "https://github.com/patrickboateng/geolysis",
"Issue Tracker": "https://github.com/patrickboateng/geolysis/issues",
"Repository": "https://github.com/patrickboateng/geolysis"
},
"split_keywords": [
"discrete-element-method",
" geotechnical-engineering",
" soil-classification",
" settlement-analysis",
" bearing-capacity-analysis"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "ec18ac3ca28d32f7b3362170d4446b513e6ac6fab493e2fb971f696bd8f13a62",
"md5": "96da2ccb88a97b2ff727e59ba0250a4d",
"sha256": "d276e3135ad195363c8467a91679200de06912287a3581e1a7ef06acf981e901"
},
"downloads": -1,
"filename": "geolysis-0.3.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "96da2ccb88a97b2ff727e59ba0250a4d",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.10",
"size": 24842,
"upload_time": "2024-05-25T22:35:55",
"upload_time_iso_8601": "2024-05-25T22:35:55.552715Z",
"url": "https://files.pythonhosted.org/packages/ec/18/ac3ca28d32f7b3362170d4446b513e6ac6fab493e2fb971f696bd8f13a62/geolysis-0.3.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "3975f57dc266495db1ef34a254ff6c78b50cb74236da4e2c95d54e42ccf03aef",
"md5": "5709977bd53da0e678130ff5ddfa34c0",
"sha256": "46165e73e9166aca8aa5856630e9d79464679d836c7c446aa0e17d16e18bd019"
},
"downloads": -1,
"filename": "geolysis-0.3.0.tar.gz",
"has_sig": false,
"md5_digest": "5709977bd53da0e678130ff5ddfa34c0",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.10",
"size": 28699,
"upload_time": "2024-05-25T22:35:58",
"upload_time_iso_8601": "2024-05-25T22:35:58.172710Z",
"url": "https://files.pythonhosted.org/packages/39/75/f57dc266495db1ef34a254ff6c78b50cb74236da4e2c95d54e42ccf03aef/geolysis-0.3.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-05-25 22:35:58",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "patrickboateng",
"github_project": "geolysis",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [],
"lcname": "geolysis"
}
JSON
