geolysis


Namegeolysis JSON
Version 0.10.0 PyPI version JSON
download
home_pageNone
Summarygeolysis is an opensource software for geotechnical engineering analysis and modeling.
upload_time2025-09-01 00:29:38
maintainerNone
docs_urlNone
authorNone
requires_python>=3.11
licenseMIT License
keywords geotechnical-engineering soil-classification bearing-capacity-analysis standard-penetration-test-analysis
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            <div align="center">
<img src="https://raw.githubusercontent.com/patrickboateng/geolysis/main/docs/assets/pkg-logo.svg" 
alt="logo" width="30%" height="30%" />
</div><br>

<div align="center">

[![PyPI Latest Release](https://img.shields.io/pypi/v/geolysis?style=flat&logo=pypi)](https://pypi.org/project/geolysis/)
[![PyPI Downloads](https://static.pepy.tech/badge/geolysis)](https://pepy.tech/projects/geolysis)
[![PyPI pyversions](https://img.shields.io/pypi/pyversions/geolysis.svg?logo=python&style=flat)](https://pypi.python.org/pypi/geolysis/)
[![license](https://img.shields.io/pypi/l/geolysis?style=flat&logo=opensourceinitiative)](https://opensource.org/license/mit/)

![Coveralls Status](https://img.shields.io/coverallsCoverage/github/patrickboateng/geolysis?logo=coveralls)
[![Codacy Badge](https://app.codacy.com/project/badge/Grade/17f88084c6a84a08a20f9d8da1438107)](https://app.codacy.com/gh/patrickboateng/geolysis/dashboard?utm_source=gh&utm_medium=referral&utm_content=&utm_campaign=Badge_grade)
[![Unit-Tests](https://github.com/patrickboateng/geolysis/actions/workflows/geolysis-unit-tests.yml/badge.svg)](https://github.com/patrickboateng/geolysis/actions/workflows/geolysis-unit-tests.yml)
[![Documentation Status](https://readthedocs.org/projects/geolysis/badge/?version=latest)](https://geolysis.readthedocs.io/en/latest/?badge=latest)

</div>

`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](https://github.com/geolysis-dev).

The rest of this **README** provides an overview of the `geolysis` python
package.

## Table of Contents

- [Installation](#installation)
- [API Reference](#api-reference)
- [Imports](#imports)
- [Project Structure](#project-structure)
- [Usage](#usage)
- [Documentation](#documentation)
- [Contributing](#contributing)
- [License](#license)
- [Contact](#contact)

## Installation

```shell
$ pip install geolysis
```

## API Reference

- [Python API](https://docs.geolysis.io/en/latest/reference/) 
    - [geolysis.bearing_capacity.abc](https://docs.geolysis.io/en/latest/reference/allowable_bearing_capacity/) - _Allowable bearing capacity
      estimation_
    - [geolysis.bearing_capacity.ubc](https://docs.geolysis.io/en/latest/reference/ultimate_bearing_capacity/) - _Ultimate bearing capacity
      estimation_
    - [geolysis.foundation](https://docs.geolysis.io/en/latest/reference/foundation/) - _Foundation Representation_
    - [geolysis.soil_classifier](https://docs.geolysis.io/en/latest/reference/soil_classifier/) - _Soil classification_
    - [geolysis.spt](https://docs.geolysis.io/en/latest/reference/spt/) - _Standard Penetration Test (SPT) Analysis_
    - [geolysis.utils](https://docs.geolysis.io/en/latest/reference/utils/) - _Utilities_


## Imports

- **Bearing Capacity**

    - **Allowable Bearing Capacity (ABC)**
     
      ```python
      from geolysis.bearing_capacity.abc import create_abc_4_cohesionless_soils
      ```
        
    - **Ultimate Bearing Capacity (UBC)**
     
      ```python
      from geolysis.bearing_capacity.ubc import create_ubc_4_all_soil_types
      ```

- **Foundation**
 
  ```python
  from geolysis.foundation import create_foundation
  ```


- **Soil Classification**
 
  ```python
  from geolysis.soil_classifier import create_uscs_classifier
  from geolysis.soil_classifier import create_aashto_classifier
  ```
 
- **Standard Penetration Test (SPT) Analysis**
 
  ```python
  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

    .
    ├── .github            # GitHub Actions
    ├── docs               # Documentation files
    ├── geolysis           # Source files
    ├── tests              # Automated tests
    ├── pyproject.toml     # Project configuration file
    └── README.md          # Project README file

## Usage

```python

>>> 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_grp_idx
'A-6'
>>> clf.group_index
'4'
>>> clf.description
'Clayey soils'

```

Check out more [examples](https://docs.geolysis.io/en/latest/usage/)

## Documentation

Check out the full [documentation](https://docs.geolysis.io/en/latest/).

## Contributing

Check out the [contribution guidelines](https://docs.geolysis.io/en/latest/dev_guide/)

## License

This project is licensed under the MIT License - see the
[LICENSE](https://github.com/patrickboateng/geolysis/blob/main/LICENSE.txt)
file for more details.

## Contact

For questions or feedback, please
contact [patrickboateng at patrickboateng dot tech](mailto:patrickboateng@patrickboateng.tech)

            

Raw data

            {
    "_id": null,
    "home_page": null,
    "name": "geolysis",
    "maintainer": null,
    "docs_url": null,
    "requires_python": ">=3.11",
    "maintainer_email": null,
    "keywords": "geotechnical-engineering, soil-classification, bearing-capacity-analysis, standard-penetration-test-analysis",
    "author": null,
    "author_email": "Patrick Boateng <boatengpato.pb@gmail.com>",
    "download_url": "https://files.pythonhosted.org/packages/73/96/8cdfe1685a67fc9f9b8607e446fcfff83ae3b30518c001b68da54f1b1f90/geolysis-0.10.0.tar.gz",
    "platform": null,
    "description": "<div align=\"center\">\n<img src=\"https://raw.githubusercontent.com/patrickboateng/geolysis/main/docs/assets/pkg-logo.svg\" \nalt=\"logo\" width=\"30%\" height=\"30%\" />\n</div><br>\n\n<div align=\"center\">\n\n[![PyPI Latest Release](https://img.shields.io/pypi/v/geolysis?style=flat&logo=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&style=flat)](https://pypi.python.org/pypi/geolysis/)\n[![license](https://img.shields.io/pypi/l/geolysis?style=flat&logo=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&utm_medium=referral&utm_content=&utm_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/geolysis-unit-tests.yml)\n[![Documentation Status](https://readthedocs.org/projects/geolysis/badge/?version=latest)](https://geolysis.readthedocs.io/en/latest/?badge=latest)\n\n</div>\n\n`geolysis` is an open-source python package (library) for geotechnical analysis\nand modeling.\n\nThe `geolysis` python package is among three other projects, `geolysis.excel`,\n`geolysis.gui`, and `geolysis.ai`. More details about these projects are\nprovided [here](https://github.com/geolysis-dev).\n\nThe rest of this **README** provides an overview of the `geolysis` python\npackage.\n\n## Table of Contents\n\n- [Installation](#installation)\n- [API Reference](#api-reference)\n- [Imports](#imports)\n- [Project Structure](#project-structure)\n- [Usage](#usage)\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## API Reference\n\n- [Python API](https://docs.geolysis.io/en/latest/reference/) \n    - [geolysis.bearing_capacity.abc](https://docs.geolysis.io/en/latest/reference/allowable_bearing_capacity/) - _Allowable bearing capacity\n      estimation_\n    - [geolysis.bearing_capacity.ubc](https://docs.geolysis.io/en/latest/reference/ultimate_bearing_capacity/) - _Ultimate bearing capacity\n      estimation_\n    - [geolysis.foundation](https://docs.geolysis.io/en/latest/reference/foundation/) - _Foundation Representation_\n    - [geolysis.soil_classifier](https://docs.geolysis.io/en/latest/reference/soil_classifier/) - _Soil classification_\n    - [geolysis.spt](https://docs.geolysis.io/en/latest/reference/spt/) - _Standard Penetration Test (SPT) Analysis_\n    - [geolysis.utils](https://docs.geolysis.io/en/latest/reference/utils/) - _Utilities_\n\n\n## Imports\n\n- **Bearing Capacity**\n\n    - **Allowable Bearing Capacity (ABC)**\n     \n      ```python\n      from geolysis.bearing_capacity.abc import create_abc_4_cohesionless_soils\n      ```\n        \n    - **Ultimate Bearing Capacity (UBC)**\n     \n      ```python\n      from geolysis.bearing_capacity.ubc import create_ubc_4_all_soil_types\n      ```\n\n- **Foundation**\n \n  ```python\n  from geolysis.foundation import create_foundation\n  ```\n\n\n- **Soil Classification**\n \n  ```python\n  from geolysis.soil_classifier import create_uscs_classifier\n  from geolysis.soil_classifier import create_aashto_classifier\n  ```\n \n- **Standard Penetration Test (SPT) Analysis**\n \n  ```python\n  from geolysis.spt import DilatancyCorrection\n  from geolysis.spt import EnergyCorrection\n  from geolysis.spt import SPT\n  from geolysis.spt import create_overburden_pressure_correction\n  ```\n  \n## Project Structure\n\n    .\n    \u251c\u2500\u2500 .github            # GitHub Actions\n    \u251c\u2500\u2500 docs               # Documentation files\n    \u251c\u2500\u2500 geolysis           # Source files\n    \u251c\u2500\u2500 tests              # Automated tests\n    \u251c\u2500\u2500 pyproject.toml     # Project configuration file\n    \u2514\u2500\u2500 README.md          # Project README file\n\n## Usage\n\n```python\n\n>>> from geolysis.soil_classifier import create_aashto_classifier\n>>> aashto_clf = create_aashto_classifier(liquid_limit=34.1,\n...                                       plastic_limit=21.1,\n...                                       fines=47.88, )\n>>> clf = aashto_clf.classify()\n>>> clf.symbol\n'A-6(4)'\n>>> clf.symbol_no_grp_idx\n'A-6'\n>>> clf.group_index\n'4'\n>>> clf.description\n'Clayey soils'\n\n```\n\nCheck out more [examples](https://docs.geolysis.io/en/latest/usage/)\n\n## Documentation\n\nCheck out the full [documentation](https://docs.geolysis.io/en/latest/).\n\n## Contributing\n\nCheck out the [contribution guidelines](https://docs.geolysis.io/en/latest/dev_guide/)\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 [patrickboateng at patrickboateng dot tech](mailto:patrickboateng@patrickboateng.tech)\n",
    "bugtrack_url": null,
    "license": "MIT License",
    "summary": "geolysis is an opensource software for geotechnical engineering analysis and modeling.",
    "version": "0.10.0",
    "project_urls": {
        "Discussions": "https://github.com/patrickboateng/geolysis/discussions",
        "Documentation": "https://docs.geolysis.io",
        "Homepage": "https://docs.geolysis.io",
        "Issue Tracker": "https://github.com/patrickboateng/geolysis/issues",
        "Repository": "https://github.com/patrickboateng/geolysis"
    },
    "split_keywords": [
        "geotechnical-engineering",
        " soil-classification",
        " bearing-capacity-analysis",
        " standard-penetration-test-analysis"
    ],
    "urls": [
        {
            "comment_text": null,
            "digests": {
                "blake2b_256": "df6855c2c99d50373d2ad2b71a364624b220ab15616586597a7f4846d777a47a",
                "md5": "7c5a7edeea9babf35f6ee33e27343cf7",
                "sha256": "8eb810afadb6b5d937d483ed3776c04a79648fcefc138f6f67b204ab06652d8d"
            },
            "downloads": -1,
            "filename": "geolysis-0.10.0-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "7c5a7edeea9babf35f6ee33e27343cf7",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.11",
            "size": 32987,
            "upload_time": "2025-09-01T00:29:37",
            "upload_time_iso_8601": "2025-09-01T00:29:37.720285Z",
            "url": "https://files.pythonhosted.org/packages/df/68/55c2c99d50373d2ad2b71a364624b220ab15616586597a7f4846d777a47a/geolysis-0.10.0-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": null,
            "digests": {
                "blake2b_256": "73968cdfe1685a67fc9f9b8607e446fcfff83ae3b30518c001b68da54f1b1f90",
                "md5": "2b2a3a30531ef134c2c9d91b358ed4f1",
                "sha256": "0ae04d55673b3a22b8dedf47ba6635ee01da39f3fa2c4a6a0b230d7c1609ca27"
            },
            "downloads": -1,
            "filename": "geolysis-0.10.0.tar.gz",
            "has_sig": false,
            "md5_digest": "2b2a3a30531ef134c2c9d91b358ed4f1",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.11",
            "size": 30322,
            "upload_time": "2025-09-01T00:29:38",
            "upload_time_iso_8601": "2025-09-01T00:29:38.785932Z",
            "url": "https://files.pythonhosted.org/packages/73/96/8cdfe1685a67fc9f9b8607e446fcfff83ae3b30518c001b68da54f1b1f90/geolysis-0.10.0.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2025-09-01 00:29:38",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "patrickboateng",
    "github_project": "geolysis",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": true,
    "lcname": "geolysis"
}
        
Elapsed time: 0.56443s