# Rudimentary soil model primarily for vertical stresses under level ground.
I think, I have made a simple calculation very complicated, but what is done is now done. Define soil layers, assemble them into soil profile and compute total vertical stresses, pore pressures, and effective vertical stresses at specified locations beneath a level ground. In addition, return requested soil parameters at specified depths. One can use these parameters at specified depths to perform futher analysis. This is a work in progress.
## Documentation
[geostress documentation](https://geosharma.gitlab.io/geostress/)
## References:
- [Maxim Millen's eng-tools](https://github.com/eng-tools)
- [Nico Schlömer and others pygmsh](https://github.com/nschloe/pygmsh)
- [Albert Kottke's pysra](https://github.com/arkottke/pysra)
- [note.nkmk.me](https://note.nkmk.me/en/python-pip-install-requirements/)
## Usage
This package lacks a good documentation. I am in the process of learning how to create documentation from python docstrings. I am a slow learner so I take baby steps. Once that is up, maybe I will include few examples in the documentation. Untill then please refer to the `tests` and the `examples` folders.
## Requirements
Only Python and Numpy are required for the package:
- python
- numpy
However, additional packages are required to run the example files and tests with `pytest`.
- pandas
- matplotlib
- altair
- hancalcs
- pytest
# Local installation in virtual environment
1. Make a `.venv` directory in the project folder.
2. Make a virtual environment `python -m venv .venv`
3. Activate the virtual environment `source .venv/bin/activate`
4. Install the requirements `python -m pip install -r requirements.txt`
5. Install the package locally `pip install -e .`
Above (4) and (5) are run after activating the virtual environment. This will install the package to the virtual environment. Any changes your make to the source code will be reflected in the package.
## Installation
I have a version uploaded to pypi `pip install pyvstress`
If installing packages from TestPyPi then `$ pip install --index-url https://test.pypi.org/simple/packagename`
Raw data
{
"_id": null,
"home_page": null,
"name": "geostress",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.13",
"maintainer_email": null,
"keywords": "Geotechnical Engineering, Soil Mechanics, Soil Profile, Vertical Stresses",
"author": null,
"author_email": "Aashish S <confusionaananda@gmail.com>",
"download_url": "https://files.pythonhosted.org/packages/36/8c/af46037ce5afc33d63315c43013b9e4df7fdcbf05d3090b73ae43840d31f/geostress-0.1.0.tar.gz",
"platform": null,
"description": "# Rudimentary soil model primarily for vertical stresses under level ground.\nI think, I have made a simple calculation very complicated, but what is done is now done. Define soil layers, assemble them into soil profile and compute total vertical stresses, pore pressures, and effective vertical stresses at specified locations beneath a level ground. In addition, return requested soil parameters at specified depths. One can use these parameters at specified depths to perform futher analysis. This is a work in progress.\n\n## Documentation\n[geostress documentation](https://geosharma.gitlab.io/geostress/)\n\n\n## References:\n - [Maxim Millen's eng-tools](https://github.com/eng-tools)\n - [Nico Schl\u00f6mer and others pygmsh](https://github.com/nschloe/pygmsh)\n - [Albert Kottke's pysra](https://github.com/arkottke/pysra)\n - [note.nkmk.me](https://note.nkmk.me/en/python-pip-install-requirements/)\n\n## Usage\nThis package lacks a good documentation. I am in the process of learning how to create documentation from python docstrings. I am a slow learner so I take baby steps. Once that is up, maybe I will include few examples in the documentation. Untill then please refer to the `tests` and the `examples` folders.\n\n## Requirements\nOnly Python and Numpy are required for the package:\n - python\n - numpy\n\nHowever, additional packages are required to run the example files and tests with `pytest`.\n - pandas\n - matplotlib\n - altair\n - hancalcs\n - pytest\n\n\n# Local installation in virtual environment\n1. Make a `.venv` directory in the project folder.\n2. Make a virtual environment `python -m venv .venv`\n3. Activate the virtual environment `source .venv/bin/activate`\n4. Install the requirements `python -m pip install -r requirements.txt`\n5. Install the package locally `pip install -e .`\n\nAbove (4) and (5) are run after activating the virtual environment. This will install the package to the virtual environment. Any changes your make to the source code will be reflected in the package.\n\n\n## Installation\n\nI have a version uploaded to pypi `pip install pyvstress`\n\nIf installing packages from TestPyPi then `$ pip install --index-url https://test.pypi.org/simple/packagename`\n\n",
"bugtrack_url": null,
"license": null,
"summary": "A simple package to compute vertical stress in soils and a little more.",
"version": "0.1.0",
"project_urls": null,
"split_keywords": [
"geotechnical engineering",
" soil mechanics",
" soil profile",
" vertical stresses"
],
"urls": [
{
"comment_text": null,
"digests": {
"blake2b_256": "c3c70f45c2f26f3fef92994fef4c13ea62eff7770b356db46e00d0573571d5f4",
"md5": "33ff517961ac53336044ba1eb38fb960",
"sha256": "dec84b44a9a115949cba0417677ebf72c997f93a082d5f05175b4c495e8f5a47"
},
"downloads": -1,
"filename": "geostress-0.1.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "33ff517961ac53336044ba1eb38fb960",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.13",
"size": 10885,
"upload_time": "2025-02-17T03:14:29",
"upload_time_iso_8601": "2025-02-17T03:14:29.027337Z",
"url": "https://files.pythonhosted.org/packages/c3/c7/0f45c2f26f3fef92994fef4c13ea62eff7770b356db46e00d0573571d5f4/geostress-0.1.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "368caf46037ce5afc33d63315c43013b9e4df7fdcbf05d3090b73ae43840d31f",
"md5": "6de70c998127781a36e8abfa0c6044fd",
"sha256": "9a6c3d55cf1e757989066cd902a8a3f7ceaa6e2180f8cd58e505f1452ffcaa6e"
},
"downloads": -1,
"filename": "geostress-0.1.0.tar.gz",
"has_sig": false,
"md5_digest": "6de70c998127781a36e8abfa0c6044fd",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.13",
"size": 516403,
"upload_time": "2025-02-17T03:14:31",
"upload_time_iso_8601": "2025-02-17T03:14:31.296679Z",
"url": "https://files.pythonhosted.org/packages/36/8c/af46037ce5afc33d63315c43013b9e4df7fdcbf05d3090b73ae43840d31f/geostress-0.1.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-02-17 03:14:31",
"github": false,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"lcname": "geostress"
}
JSON