geolysis 0.2.0__py3-none-any.whl → 0.3.0__py3-none-any.whl

geolysis-0.2.0.dist-info/METADATA

@@ -1,193 +0,0 @@
-Metadata-Version: 2.1
-Name: geolysis
-Version: 0.2.0
-Summary: geolysis is an opensource software for geotechnical engineering analysis and modeling.
-Author-email: Patrick Boateng <boatengpato.pb@gmail.com>
-Maintainer-email: Patrick Boateng <boatengpato.pb@gmail.com>
-License: MIT License
-        
-        Copyright (c) 2023 geolysis
-        
-        Permission is hereby granted, free of charge, to any person obtaining a copy
-        of this software and associated documentation files (the "Software"), to deal
-        in the Software without restriction, including without limitation the rights
-        to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-        copies of the Software, and to permit persons to whom the Software is
-        furnished to do so, subject to the following conditions:
-        
-        The above copyright notice and this permission notice shall be included in all
-        copies or substantial portions of the Software.
-        
-        THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-        IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-        FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-        AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-        LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-        OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
-        SOFTWARE.
-        
-Project-URL: Homepage, https://github.com/patrickboateng/geolysis
-Project-URL: Repository, https://github.com/patrickboateng/geolysis
-Project-URL: Changelog, https://github.com/patrickboateng/geolysis/blob/main/CHANGELOG.md
-Project-URL: Issue Tracker, https://github.com/patrickboateng/geolysis/issues
-Project-URL: Discussions, https://github.com/patrickboateng/geolysis/discussions
-Keywords: discrete-element-method,geotechnical-engineering,soil-classification,settlement-analysis,bearing-capacity-analysis
-Classifier: Development Status :: 2 - Pre-Alpha
-Classifier: Intended Audience :: Developers
-Classifier: Intended Audience :: Education
-Classifier: Intended Audience :: Science/Research
-Classifier: License :: OSI Approved :: MIT License
-Classifier: Natural Language :: English
-Classifier: Operating System :: OS Independent
-Classifier: Programming Language :: Python :: 3.10
-Classifier: Programming Language :: Python :: 3.11
-Classifier: Programming Language :: Python :: 3.12
-Classifier: Programming Language :: Python :: Implementation :: CPython
-Classifier: Topic :: Scientific/Engineering
-Requires-Python: >=3.10
-Description-Content-Type: text/markdown
-License-File: LICENSE.txt
-Provides-Extra: dev
-Requires-Dist: black ; extra == 'dev'
-Requires-Dist: pytest ; extra == 'dev'
-Requires-Dist: mypy ; extra == 'dev'
-Requires-Dist: pytest-cov ; extra == 'dev'
-
-[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
-[changelog_url]: https://github.com/patrickboateng/geolysis/blob/main/CHANGELOG.md
-[license_url]: https://github.com/patrickboateng/geolysis/blob/main/LICENSE.txt
-
-<h1 align="center">
-<img src="https://raw.githubusercontent.com/patrickboateng/geolysis/main/docs/source/_static/geolysis_logo.png" alt="logo" width="300">
-</h1><br>
-
-<div align="center">
-
-[![GitHub Repo stars](https://img.shields.io/github/stars/patrickboateng/geolysis?style=flat&logo=github)](https://github.com/patrickboateng/geolysis/stargazers)
-[![PyPI Latest Release](https://img.shields.io/pypi/v/geolysis?style=flat&logo=pypi)](https://pypi.org/project/geolysis/)
-[![PyPI pyversions](https://img.shields.io/pypi/pyversions/geolysis.svg?logo=python&style=flat)](https://pypi.python.org/pypi/geolysis/)
-[![GitHub last commit](https://img.shields.io/github/last-commit/patrickboateng/geolysis?logo=github&style=flat)](https://github.com/patrickboateng/geolysis/commits)
-[![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)
-[![CI-Unit-Test](https://github.com/patrickboateng/geolysis/actions/workflows/unit-tests.yml/badge.svg)](https://github.com/patrickboateng/geolysis/actions/workflows/unit-tests.yml)
-[![CI-Build-Test](https://github.com/patrickboateng/geolysis/actions/workflows/build.yml/badge.svg)](https://github.com/patrickboateng/geolysis/actions/workflows/build.yml)
-
-</div>
-
-## Project Links
-
-<!-- - [Documentation](/docs) -->
-
-- [Homepage](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
-
-- [What is geolysis?](#what-is-geolysis)
-- [Installation](#installation)
-- [Soil Classification Example](#soil-classification-example)
-  - [AASHTO Classification](#aashto-classification)
-  - [USCS Classification](#uscs-classification)
-- [Release History](#release-history)
-- [Code of Conduct](#code-of-conduct)
-- [Contributing](#contributing)
-- [License](#license)
-- [Contact Information](#contact-information)
-
-## 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
-
-```shell
-pip install geolysis
-```
-
-## Soil Classification Example
-
-### AASHTO Classification
-
-```python
-
->>> 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
-
-```python
-
->>> 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][changelog_url] for release history.
-
-## 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.
-
-## 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)

geolysis-0.2.0.dist-info/RECORD

@@ -1,14 +0,0 @@
-geolysis/__init__.py,sha256=tqBKoOtCBrtKZ-2BgxiUADtw5Pv4hCcpFAJdVEmVBAA,162
-geolysis/constants.py,sha256=zb3ViohH0tT2W_P6mf1fhmUMxAcjWAaYy-q0LsQUQl8,444
-geolysis/estimators.py,sha256=KtsWH59Z3hu8_vWC1a_Id4yS4Gudkr8WPMgSBaNPl_8,7459
-geolysis/foundation.py,sha256=gHIruNNuj4ZwP4rWxRNyWdUrGZwEs20pGNuwK0kR1Aw,4192
-geolysis/soil_classifier.py,sha256=Ir-yruadFe_TKxRaAkzEfil70vjfrzWPfmmu2D-L6BE,22543
-geolysis/spt.py,sha256=-1lznvEGLaxVMz_Typ3bWM6uszzZYzjXlgQGKVC7luk,18129
-geolysis/utils.py,sha256=TAEj8To4mTcI4NaR-8Qb1OpINtmUxRps8eLnfR131VM,2422
-geolysis/bearing_capacity/__init__.py,sha256=9BZwVHQaZSmfmxm2T8qGy6RIEbARo-ni1CXJOM8CCG4,19
-geolysis/bearing_capacity/abc.py,sha256=UslF92YL_l8zi5Evc84j3IdLy58nY_nfzxpdtxsH8sc,9960
-geolysis-0.2.0.dist-info/LICENSE.txt,sha256=Gxc3UWw7OX-M-Nif4EZcGFQ0Jh3gfNUO_kPS1TDy-BU,1086
-geolysis-0.2.0.dist-info/METADATA,sha256=l1YrgZl72BXR18mX4EF8EEDJ54uBsLApBu6homZgEjQ,8127
-geolysis-0.2.0.dist-info/WHEEL,sha256=oiQVh_5PnQM0E3gPdiz09WCNmwiHDMaGer_elqB3coM,92
-geolysis-0.2.0.dist-info/top_level.txt,sha256=9mnQgOaCRr11dtXff8X-q3FfXjRONd6kHseSy5q2y8g,9
-geolysis-0.2.0.dist-info/RECORD,,