Skip to content

About

Easy-to-use Python package for soil texture triangle plotting and classification (USDA/HYPRES), with a companion Streamlit app.

Resources

Stars

1 star

Watchers

0 watching

Forks

Repository files navigation

Soil Texture Plot

Streamlit App

soiltextureplot is a Python package for soil texture classification and visualization with ternary diagrams.

Features

  • Ternary Plotting: Visualize soil texture data on interactive ternary diagrams
  • Multiple Classification Systems: Support for USDA and HYPRES soil texture classification systems
  • Command-Line Interface: Classify CSVs and save texture triangle plots with soiltextureplot
  • Interactive Web App: Streamlit-based application for easy data upload and visualization
  • Flexible Data Input: Support for CSV files with customizable column mapping
  • Point Classification: Automatic classification of soil samples into texture classes
  • Customizable Visualization: Control point sizes, colors, and labels

Install

Install with uv:

uv add soiltextureplot

Install with pip:

pip install soiltextureplot

Optional app extras:

pip install "soiltextureplot[app]"

Quick Usage

import pandas as pd
from soiltextureplot.triangle import SoilTextureTriangle

example_df = pd.DataFrame(
    {
        "sample_id": ["S1", "S2", "S3", "S4"],
        "sand": [75, 65, 45, 35],
        "silt": [15, 20, 35, 40],
        "clay": [10, 15, 20, 25],
        "BD": [1.35, 1.42, 1.20, 1.18],
    }
)

tri = SoilTextureTriangle(system_name="USDA")
tri.load_dataframe(example_df)
classified = tri.classify()
fig, ax = tri.plot(size_by="BD", cmap="viridis")

CLI

soiltextureplot list-systems
soiltextureplot classify data.csv -o classified.csv
soiltextureplot plot data.csv --size-by BD -o triangle.png
soiltextureplot run data.csv -o classified.csv -f triangle.png

Documentation

Full package docs are available on GitHub Pages:

Data Format

Your CSV file should contain soil texture data with percentages of sand, silt, and clay. The percentages should sum to 100% for each sample.

Example data format:

sample_id,sand,silt,clay
S1,65,20,15
S2,70,24,6
S3,75,21,4

Supported Classification Systems

USDA (United States Department of Agriculture)

The standard USDA soil texture classification system with 12 texture classes.

HYPRES (HYdraulic PRoperties of European Soils)

A European framework for classifying soils based on their hydrologic properties.

Web Application

The Streamlit web app allows you to:

  • Upload CSV files with soil texture data
  • Map columns to sand, silt, and clay percentages
  • Visualize data on interactive texture triangles
  • Customize plot appearance

Notebooks

Exploratory notebooks live at the repo root. Ruff formats and lints .ipynb files natively.

uv run jupyter notebook texture_plot.ipynb

Development

# Setup
uv sync --group dev

# Install git pre-commit hook
uv run pre-commit install

# Run all pre-commit checks on the repository
uv run pre-commit run --all-files

# Run one hook manually (example: ruff)
uv run pre-commit run ruff --all-files

# CI-style check-only quality commands (no auto-fixes)
uv run ruff format --check .
uv run ruff check .
uv run ty check src app

# Run tests
uv run pytest

# Build
uv build

# Publish (after updating version in pyproject.toml)
uv publish

Release Automation (GitHub Actions)

Publishing is automated via tag-triggered workflows:

  • v*rc* tags publish to TestPyPI
  • v*.*.* tags are evaluated for PyPI; tags containing rc are skipped by workflow condition

Both workflows verify that the git tag version matches uv version --short before publishing. Both workflows also run isolated wheel and source-distribution smoke tests (import soiltextureplot) before upload.

For maintainers, full trusted-publishing and release steps are documented in docs/releasing.md.

Acknowledgments

  • Built using mpltern for ternary plotting
  • Inspired by soil science classification standards
  • Streamlit for the web interface

About

Easy-to-use Python package for soil texture triangle plotting and classification (USDA/HYPRES), with a companion Streamlit app.

Resources

Stars

1 star

Watchers

0 watching

Forks

Releases

Packages

Contributors

Languages