Skip to main content

Groundhog - A general-purpose geotechnical package

Project description

[![PyPI version](https://badge.fury.io/py/groundhog.svg)](https://badge.fury.io/py/groundhog)

![groundhog banner](https://github.com/snakesonabrain/groundhog/blob/main/groundhog_banner_wide.png?raw=true)

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). [![Binder](https://mybinder.org/badge_logo.svg)](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>

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.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

groundhog-0.13.0.tar.gz (1.5 MB view details)

Uploaded Source

Built Distribution

groundhog-0.13.0-py3-none-any.whl (1.5 MB view details)

Uploaded Python 3

File details

Details for the file groundhog-0.13.0.tar.gz.

File metadata

  • Download URL: groundhog-0.13.0.tar.gz
  • Upload date:
  • Size: 1.5 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.1.1 CPython/3.10.9

File hashes

Hashes for groundhog-0.13.0.tar.gz
Algorithm Hash digest
SHA256 efc25633e97993052af3ad1b5c280e5ffae069f8ce8b3c22d254f6f270e0eb2c
MD5 217529e6f39f6d15e32a5c44ea638527
BLAKE2b-256 3e40172d4bc452347d0eb1e06d27e890dcafb2254fa6bb63461194502248138b

See more details on using hashes here.

File details

Details for the file groundhog-0.13.0-py3-none-any.whl.

File metadata

  • Download URL: groundhog-0.13.0-py3-none-any.whl
  • Upload date:
  • Size: 1.5 MB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.1.1 CPython/3.10.9

File hashes

Hashes for groundhog-0.13.0-py3-none-any.whl
Algorithm Hash digest
SHA256 69aa21715ccda3a312654cc95a4f43fc13e11b43f2fc0f5740009537f2ffe000
MD5 dbcffc06efcd910873ab14ad30e9e7fa
BLAKE2b-256 3894537bd3119ec3c538e48c3433bacef54509639546f03a14d6ff6c733c8bb2

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page