Groundhog - A general-purpose geotechnical package
====================================================
[](https://badge.fury.io/py/groundhog)
This Python package contains useful functionality for supporting automated geotechnical calculations.
Functionality for onshore and offshore geotechnical problems is included. This package is under constant development so any request for additional functionality can always be submitted to the package author.
groundhog bundles a large amount of knowledge and provides it to end users through extensively documented functions. The aim of the package is as follows:
- Improve correctness through unit-tested functions with parameter validation
- Raise awareness on underlying test data and theories supporting engineering correlations and design formulae
- Promoting development of open-source engineering software by the worldwide community of engineers
groundhog is developed using a set of 10 Golden rules which are reflected in the groundhog function architecture and should also be followed by any contributors to the project.
For more information, consult the [documentation](https://groundhog.readthedocs.io/en/main/) or get started using the [tutorial notebooks](https://mybinder.org/v2/gh/snakesonabrain/groundhog/main). [](https://mybinder.org/v2/gh/snakesonabrain/groundhog/main)
Installation requirements
-------------------------
groundhog is written for Python 3.7+. Downloading Anaconda3 is recommended for users not familiar with Python development. Plotting functionality included in the package is built on plotly. The plotly package also needs to be installed and is not included in the default Anaconda installation.
Installing groundhog is easily done with pip:`
```
pip install groundhog
```
Support groundhog
-------------------
You can support the development of groundhog by buying me a coffee
<a href="https://www.buymeacoffee.com/groundhog"><img src="https://img.buymeacoffee.com/button-api/?text=Buy me a coffee&emoji=&slug=groundhog&button_colour=FFDD00&font_colour=000000&font_family=Cookie&outline_colour=000000&coffee_colour=ffffff"></a>
License and copyright
-----------------------
groundhog. A general-purpose Python library for geotechnical engineering.
Copyright (C) 2020 Bruno Stuyts
This program is free software: you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.
This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU General Public License for more details.
You should have received a copy of the GNU General Public License
along with this program. If not, see <https://www.gnu.org/licenses/>.
Disclaimer
-------------
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
Raw data
{
"_id": null,
"home_page": "https://github.com/snakesonabrain/groundhog",
"name": "groundhog",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.7",
"maintainer_email": null,
"keywords": "engineering, geotechnical",
"author": "Bruno Stuyts",
"author_email": "bruno@pro-found.be",
"download_url": "https://files.pythonhosted.org/packages/d6/7b/2bb768b000884f6413baad7b9a71c2335e92de6cf76c07ded41111d30095/groundhog-0.12.0.tar.gz",
"platform": null,
"description": "Groundhog - A general-purpose geotechnical package\n====================================================\n\n[](https://badge.fury.io/py/groundhog)\n\n\n\nThis Python package contains useful functionality for supporting automated geotechnical calculations.\n\nFunctionality for onshore and offshore geotechnical problems is included. This package is under constant development so any request for additional functionality can always be submitted to the package author.\n\ngroundhog bundles a large amount of knowledge and provides it to end users through extensively documented functions. The aim of the package is as follows:\n\n - Improve correctness through unit-tested functions with parameter validation\n - Raise awareness on underlying test data and theories supporting engineering correlations and design formulae\n - Promoting development of open-source engineering software by the worldwide community of engineers\n\ngroundhog is developed using a set of 10 Golden rules which are reflected in the groundhog function architecture and should also be followed by any contributors to the project.\n\nFor more information, consult the [documentation](https://groundhog.readthedocs.io/en/main/) or get started using the [tutorial notebooks](https://mybinder.org/v2/gh/snakesonabrain/groundhog/main). [](https://mybinder.org/v2/gh/snakesonabrain/groundhog/main)\n\nInstallation requirements\n-------------------------\n\ngroundhog is written for Python 3.7+. Downloading Anaconda3 is recommended for users not familiar with Python development. Plotting functionality included in the package is built on plotly. The plotly package also needs to be installed and is not included in the default Anaconda installation.\n\nInstalling groundhog is easily done with pip:`\n\n```\npip install groundhog\n```\n\n\nSupport groundhog\n-------------------\n\nYou can support the development of groundhog by buying me a coffee\n\n<a href=\"https://www.buymeacoffee.com/groundhog\"><img src=\"https://img.buymeacoffee.com/button-api/?text=Buy me a coffee&emoji=&slug=groundhog&button_colour=FFDD00&font_colour=000000&font_family=Cookie&outline_colour=000000&coffee_colour=ffffff\"></a>\n\n\nLicense and copyright\n-----------------------\n\ngroundhog. A general-purpose Python library for geotechnical engineering.\n Copyright (C) 2020 Bruno Stuyts\n\n This program is free software: you can redistribute it and/or modify\n it under the terms of the GNU General Public License as published by\n the Free Software Foundation, either version 3 of the License, or\n (at your option) any later version.\n\n This program is distributed in the hope that it will be useful,\n but WITHOUT ANY WARRANTY; without even the implied warranty of\n MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the\n GNU General Public License for more details.\n\n You should have received a copy of the GNU General Public License\n along with this program. If not, see <https://www.gnu.org/licenses/>.\n\n\nDisclaimer\n-------------\n\nTHIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS \"AS IS\" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.\n",
"bugtrack_url": null,
"license": "GNU GPLv3",
"summary": "Groundhog - A general-purpose geotechnical package",
"version": "0.12.0",
"project_urls": {
"Download": "https://github.com/snakesonabrain/groundhog/archive/main.zip",
"Homepage": "https://github.com/snakesonabrain/groundhog"
},
"split_keywords": [
"engineering",
" geotechnical"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "d7a86d40c210667b546805dd33b85c46e327ebccda6fd3b564e90ad75b43dc15",
"md5": "2994f19de900c35518cda85de22d7dde",
"sha256": "c3cf416cbd028d45c94a053c0fe7aa0db2086c5de5f0cf04dc731c95206f24e2"
},
"downloads": -1,
"filename": "groundhog-0.12.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "2994f19de900c35518cda85de22d7dde",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.7",
"size": 1501597,
"upload_time": "2024-03-30T19:04:52",
"upload_time_iso_8601": "2024-03-30T19:04:52.096832Z",
"url": "https://files.pythonhosted.org/packages/d7/a8/6d40c210667b546805dd33b85c46e327ebccda6fd3b564e90ad75b43dc15/groundhog-0.12.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "d67b2bb768b000884f6413baad7b9a71c2335e92de6cf76c07ded41111d30095",
"md5": "f2102950a4832f85dd1be9317af10f05",
"sha256": "e310574be943a08291f1bdcf0c1ff4759d90658445c05de31d07d31162ed7a13"
},
"downloads": -1,
"filename": "groundhog-0.12.0.tar.gz",
"has_sig": false,
"md5_digest": "f2102950a4832f85dd1be9317af10f05",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.7",
"size": 1464534,
"upload_time": "2024-03-30T19:04:59",
"upload_time_iso_8601": "2024-03-30T19:04:59.044572Z",
"url": "https://files.pythonhosted.org/packages/d6/7b/2bb768b000884f6413baad7b9a71c2335e92de6cf76c07ded41111d30095/groundhog-0.12.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-03-30 19:04:59",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "snakesonabrain",
"github_project": "groundhog",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [
{
"name": "pandas",
"specs": [
[
">=",
"=2.0.3"
]
]
},
{
"name": "plotly",
"specs": []
},
{
"name": "scipy",
"specs": [
[
">=",
"1.4.1"
]
]
},
{
"name": "xlrd",
"specs": [
[
"==",
"1.2.0"
]
]
},
{
"name": "openpyxl",
"specs": []
},
{
"name": "jinja2",
"specs": [
[
">=",
"2.0.0"
]
]
},
{
"name": "xlsxwriter",
"specs": [
[
"==",
"1.3.9"
]
]
},
{
"name": "pyproj",
"specs": [
[
">=",
"2.6"
]
]
},
{
"name": "streamlit",
"specs": []
},
{
"name": "nose",
"specs": []
},
{
"name": "matplotlib",
"specs": []
},
{
"name": "Pillow",
"specs": []
}
],
"lcname": "groundhog"
}
JSON
