How to install the SDK¶

From PyPI¶

pip install owi-metadatabase

With uv:

uv pip install owi-metadatabase

From source (development)¶

git clone https://github.com/OWI-Lab/owi-metadatabase-sdk.git
cd owi-metadatabase-sdk
uv sync --dev

Verify the installation¶

from owi.metadatabase.geometry.io import GeometryAPI
from owi.metadatabase.locations.io import LocationsAPI

print("Installation successful")

Optional extras¶

Soil extension¶

pip install "owi-metadatabase[soil]"

Results extension¶

pip install "owi-metadatabase[results]"

SHM extension¶

pip install "owi-metadatabase[shm]"

Multiple extensions together¶

pip install "owi-metadatabase[soil,results,shm]"

Verify an extension install¶

from owi.metadatabase.results import ResultsAPI
from owi.metadatabase.shm import ShmAPI
from owi.metadatabase.soil import SoilAPI

print(SoilAPI)
print(ResultsAPI)
print(ShmAPI)

Documentation tooling¶

uv sync --group docs

Full development environment¶

uv sync --dev

Troubleshooting¶

Import errors after upgrade¶

Make sure the old package is fully removed before installing the new one:

pip uninstall owimetadatabase-preprocessor
pip install owi-metadatabase

Namespace package conflicts¶

If imports fail with ModuleNotFoundError, remove stale installations:

pip uninstall owi-metadatabase-sdk owimetadatabase-preprocessor
pip install owi-metadatabase

Note

If you use zsh, wrap extras in quotes because [ and ] are glob characters: pip install "owi-metadatabase[soil,results,shm]".