{"id":20098826,"url":"https://github.com/patrickboateng/geolysis","last_synced_at":"2025-05-06T06:30:32.900Z","repository":{"id":110076310,"uuid":"603914717","full_name":"patrickboateng/geolysis","owner":"patrickboateng","description":"An open-source library for geotechnical engineering analysis and modeling.","archived":false,"fork":false,"pushed_at":"2025-05-06T05:09:41.000Z","size":5894,"stargazers_count":13,"open_issues_count":0,"forks_count":5,"subscribers_count":5,"default_branch":"main","last_synced_at":"2025-05-06T06:24:27.162Z","etag":null,"topics":["bearing-capacity-analysis","geotechnical-engineering","soil-classification","standard-penetration-test-analysis"],"latest_commit_sha":null,"homepage":"https://docs.geolysis.io","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/patrickboateng.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"docs/CONTRIBUTING.md","funding":null,"license":"LICENSE.txt","code_of_conduct":"docs/CODE_OF_CONDUCT.md","threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null}},"created_at":"2023-02-19T23:21:23.000Z","updated_at":"2025-05-06T05:09:45.000Z","dependencies_parsed_at":"2024-04-04T23:34:34.203Z","dependency_job_id":"3e6fbe7c-ccbd-4a15-92f5-fc6b72afa0cc","html_url":"https://github.com/patrickboateng/geolysis","commit_stats":null,"previous_names":["patrickboateng/geolysis","patrickboateng/geolab"],"tags_count":16,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/patrickboateng%2Fgeolysis","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/patrickboateng%2Fgeolysis/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/patrickboateng%2Fgeolysis/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/patrickboateng%2Fgeolysis/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/patrickboateng","download_url":"https://codeload.github.com/patrickboateng/geolysis/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":252633362,"owners_count":21779851,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["bearing-capacity-analysis","geotechnical-engineering","soil-classification","standard-penetration-test-analysis"],"created_at":"2024-11-13T17:06:50.418Z","updated_at":"2025-05-06T06:30:32.887Z","avatar_url":"https://github.com/patrickboateng.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"\u003cdiv align=\"center\"\u003e\n\u003cimg src=\"https://raw.githubusercontent.com/patrickboateng/geolysis/dev/docs/source/_static/branding/geolysislogo.svg\" \nalt=\"geolysislogo\" width=\"75%\" /\u003e\n\u003c/div\u003e\u003cbr\u003e\n\n\u003cdiv align=\"center\"\u003e\n\n[![PyPI Latest Release](https://img.shields.io/pypi/v/geolysis?style=flat\u0026logo=pypi)](https://pypi.org/project/geolysis/)\n[![PyPI Downloads](https://static.pepy.tech/badge/geolysis)](https://pepy.tech/projects/geolysis)\n[![PyPI pyversions](https://img.shields.io/pypi/pyversions/geolysis.svg?logo=python\u0026style=flat)](https://pypi.python.org/pypi/geolysis/)\n[![license](https://img.shields.io/pypi/l/geolysis?style=flat\u0026logo=opensourceinitiative)](https://opensource.org/license/mit/)\n\n![Coveralls Status](https://img.shields.io/coverallsCoverage/github/patrickboateng/geolysis?logo=coveralls)\n[![Codacy Badge](https://app.codacy.com/project/badge/Grade/17f88084c6a84a08a20f9d8da1438107)](https://app.codacy.com/gh/patrickboateng/geolysis/dashboard?utm_source=gh\u0026utm_medium=referral\u0026utm_content=\u0026utm_campaign=Badge_grade)\n[![Unit-Tests](https://github.com/patrickboateng/geolysis/actions/workflows/geolysis-unit-tests.yml/badge.svg)](https://github.com/patrickboateng/geolysis/actions/workflows/unit-tests.yml)\n[![Documentation Status](https://readthedocs.org/projects/geolysis/badge/?version=latest)](https://geolysis.readthedocs.io/en/latest/?badge=latest)\n\n\u003c/div\u003e\n\n`geolysis` is an open-source python package (library) for geotechnical analysis\nand modeling. It offers tools for soil classification, Standard Penetration\nTest (SPT) analysis, and bearing capacity estimation, among others.\n\nThe `geolysis` package is among three other projects, `geolysis.gui`,\n`geolysis.excel`, and `geolysis.ai`.\n\nHere are brief descriptions of the `geolysis` projects:\n\n1. `geolysis`\n\n   A python package (library) which provides the core functionalities for\n   `geolysis.gui` and the `geolysis.excel` applications. Current features\n   provided by the `geolysis` package are shown in the table below.\n\n   \u003ctable\u003e\n    \u003ctr\u003e\n        \u003ctd\u003e\u003cstrong\u003eSoil Classification\u003c/strong\u003e\u003c/td\u003e\n        \u003ctd\u003eAASHTO Classification System\u003c/td\u003e\n    \u003c/tr\u003e\n    \u003ctr\u003e\n        \u003ctd\u003e\u003c/td\u003e\n        \u003ctd\u003eUnified Soil Classification System\u003c/td\u003e\n    \u003c/tr\u003e\n    \u003ctr\u003e\n        \u003ctd\u003e\u003cstrong\u003eStandard Penetration Test (SPT) Analysis\u003c/strong\u003e\u003c/td\u003e\n        \u003ctd\u003eSPT Energy Correction\u003c/td\u003e\n    \u003c/tr\u003e\n    \u003ctr\u003e\n        \u003ctd\u003e\u003c/td\u003e\n        \u003ctd\u003eSPT Overburden Pressure Correction\u003c/td\u003e\n    \u003c/tr\u003e\n    \u003ctr\u003e\n        \u003ctd\u003e\u003c/td\u003e\n        \u003ctd\u003eSPT Dilatancy Correction\u003c/td\u003e\n    \u003c/tr\u003e\n    \u003ctr\u003e\n        \u003ctd\u003e\u003c/td\u003e\n        \u003ctd\u003eSPT N-Design Calculation\u003c/td\u003e\n    \u003c/tr\u003e\n    \u003ctr\u003e\n        \u003ctd\u003e\u003cstrong\u003eBearing Capacity Estimation\u003c/strong\u003e\u003c/td\u003e\n        \u003ctd\u003eAllowable Bearing Capacity Estimation\u003c/td\u003e\n    \u003c/tr\u003e\n    \u003ctr\u003e\n        \u003ctd\u003e\u003c/td\u003e\n        \u003ctd\u003eUltimate Bearing Capacity Estimation\u003c/td\u003e\n    \u003c/tr\u003e\n   \u003c/table\u003e\n\n2. `geolysis.gui`\n\n   A graphical user interface that allows users to interact with the `geolysis`\n   package. Through this interface, users can view generated reports and\n   visualizations, such as Particle Size Distribution (PSD) curves, Atterberg\n   Limits plots, and Compaction curves, among others.\n\n3. `geolysis.excel`\n\n   An add-in for Microsoft Excel that performs simple geotechnical analysis.\n   It offers some features similar to `geolysis.gui` within Microsoft Excel.\n   Below is an example of the Microsoft Excel addin.\n\n   \u003cdiv align=\"center\"\u003e\n    \u003cimg src=\"https://raw.githubusercontent.com/patrickboateng/geolysis/main/docs/_static/geolysis_excel_example.gif\" \n    alt=\"geolysis excel example\" width=\"100%\" /\u003e\n   \u003c/div\u003e\u003cbr\u003e\n\n4. `geolysis.ai`\n\n   Offers machine learning models that are trained using geotechnical data.\n\n## Project Structure\n\n    .\n    ├── .github        # GitHub Actions\n    ├── docs           # Documentation files\n    ├── geolysis       # Source files\n    ├── tests          # Automated tests\n    └── README.md\n\n## Table of Contents\n\n- [Installation](#installation)\n- [Usage Example](#usage-example)\n- [Documentation](#documentation)\n- [Contributing](#contributing)\n- [License](#license)\n- [Contact](#contact)\n\n## Installation\n\n```shell\n$ pip install geolysis\n```\n\n## Usage Example\n\n```python\n\n\u003e\u003e\u003e from geolysis.soil_classifier import create_soil_classifier\n\u003e\u003e\u003e uscs_clf = create_soil_classifier(liquid_limit=34.1,\n...                                   plastic_limit=21.1,\n...                                   fines=47.88,\n...                                   sand=37.84,\n...                                   clf_type=\"USCS\")\n\u003e\u003e\u003e clf = uscs_clf.classify()\n\u003e\u003e\u003e clf\nSoilClf(symbol='SC', description='Clayey sands')\n\u003e\u003e\u003e clf.symbol\n'SC'\n\u003e\u003e\u003e clf.description\n'Clayey sands'\n\n```\n\n```python\n\n\u003e\u003e\u003e from geolysis.soil_classifier import create_soil_classifier\n\u003e\u003e\u003e aashto_clf = create_soil_classifier(liquid_limit=34.1,\n...                                     plastic_limit=21.1,\n...                                     fines=47.88,\n...                                     clf_type=\"AASHTO\")\n\u003e\u003e\u003e clf = aashto_clf.classify()\n\u003e\u003e\u003e clf\nSoilClf(symbol='A-6(4)', description='Clayey soils')\n\u003e\u003e\u003e clf.symbol\n'A-6(4)'\n\u003e\u003e\u003e clf.description\n'Clayey soils'\n\n```\n\nCheck out more examples\n[here](https://docs.geolysis.io/en/latest/user_guide/getting_started.html#quick-start)\n\n## Documentation\n\nFull documentation is available [here](https://docs.geolysis.io/en/latest/)\n\n## Contributing\n\nContribution guidelines can be\nfound [here](https://docs.geolysis.io/en/latest/dev_guide/index.html)\n\n## License\n\nThis project is licensed under the MIT License - see the\n[LICENSE](https://github.com/patrickboateng/geolysis/blob/main/LICENSE.txt)\nfile for more details.\n\n## Contact\n\nFor questions or feedback, please\ncontact [boatengpato.pb@gmail.com](mailto:boatengpato.pb@gmail.com)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fpatrickboateng%2Fgeolysis","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fpatrickboateng%2Fgeolysis","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fpatrickboateng%2Fgeolysis/lists"}