OWI-metadatabase Soil Extension

Soil extension package for the OWI-metadatabase namespace SDK.

This package extends owi-metadatabase with soil-focused endpoints, data processing, and plotting helpers while keeping the same owi.metadatabase.* import namespace.

📚 Read the Documentation

Features

• Soil API Client: Access soil profiles, in-situ tests, geotechnical samples, and lab tests
• Processing Utilities: Convert API payloads to tabular/analysis-ready structures
• Groundhog Integration: Convert CPT/profile data into Groundhog-compatible objects
• Visualization Helpers: Build interactive Plotly maps and profile/fence plots
• Namespace Extension: Works seamlessly with the core owi-metadatabase package

Installation

Install as extension package (owi-metadatabase-soil)

From PyPI:

pip install owi-metadatabase-soil

Using uv:

uv pip install owi-metadatabase-soil

Install from core package extra (owi-metadatabase[soil])

If you prefer installing from the base package extras:

pip install "owi-metadatabase[soil]"

Using uv:

uv pip install "owi-metadatabase[soil]"

Quick Start

from owi.metadatabase.soil import SoilAPI

soil_api = SoilAPI(token="your-api-token")
print(soil_api.ping())

Examples

1) Retrieve test locations

from owi.metadatabase.soil import SoilAPI

soil_api = SoilAPI(token="your-api-token")
result = soil_api.get_testlocations(projectsite="Nobelwind")

if result["exists"]:
    print(result["data"].head())

2) Find the closest in-situ test

closest = soil_api.get_closest_insitutest(latitude=51.707765, longitude=2.798876, radius=1.0)
print(closest["title"], f"at {closest['offset [m]']:.1f} m")

3) Retrieve CPT detail and optional Groundhog CPT object

cpt = soil_api.get_cpttest_detail(
    insitutest="BH-CPT-01",
    projectsite="Nobelwind",
    location="NW-A01",
    cpt=True,
)

print(cpt["exists"])
print(cpt["rawdata"].columns)

4) Retrieve a soil profile detail

profile = soil_api.get_soilprofile_detail(
    projectsite="Nobelwind",
    location="NW-A01",
    soilprofile="BH-Profile-01",
)

print(profile["exists"])

5) Plot test locations

from owi.metadatabase.soil import SoilPlot

plotter = SoilPlot(soil_api)
figure = plotter.plot_testlocations(return_fig=True, projectsite="Nobelwind")
figure.show()

Development

uv sync --dev
uv run invoke test.run
uv run invoke qa.all
uv run invoke docs.build

Built with ❤️ and 🧠 by OWI-Lab