bdestombe/python-geotechnical-profile

Load, manage, and plot geotechnical data, including GEF and DTS measurements

Overview

docs
tests
package
Example notebooks

A Python package to load raw DTS files, perform a calibration, and plot the result

• Free software: BSD 3-Clause License

Installation

pip install geotechnicalprofile

Current version on pip is vv0.2.0. . This is probably several commits behind this repository. Pip install directly from github to obtain the most recent changes.

Learn by examples

Interactively run the example notebooks online by clicking the launch-binder button.

Documentation

https://python-geotechnical-profile.readthedocs.io/

Development

To run the all tests run:

tox

To bump version and docs:

git status          # to make sure no unversioned modifications are in the repository
tox                 # Performes tests and creates documentation and runs notebooks
git status          # Only notebook related files should be shown
git add --all       # Add all notebook related files to local version
git commit -m "Updated notebook examples to reflect recent changes"

# update CHANGELOG.rst with the recent commits
# update AUTHORS.rst

bumpversion patch   # (major, minor, patch)
git push
rm -rf build        # Clean local folders (not synced) used for pip wheel
rm -rf src/*.egg-info
rm -rf dist/*
python setup.py clean --all sdist bdist_wheel
twine upload --repository-url https://upload.pypi.org/legacy/ dist/geotechnicalprofile*

On GitHub draft a new release

# GitHub > Code > Releases > Draft a new release
# Tag: v1.2.3
# Title: v1.2.3
# Describtion: Copy-paste the new part of CHANGELOG.rst