Skip to content

OWI Metadatabase SHM Extension

What is the OWI Metadatabase SHM SDK?

The owi-metadatabase-shm package extends the owi.metadatabase namespace with typed SHM-specific API behaviour.

  • Tutorials

    Step-by-step lessons that walk you through connecting to the API and running your first queries.

    Start learning

  • How-to Guides

    Focused recipes for common tasks: install, authenticate, and query data.

    Find a recipe

  • Reference

    Auto-generated API docs pulled from source code docstrings.

    Browse reference

  • Explanation

    Deeper discussions on architecture, design decisions, and namespace packaging.

    Understand concepts

Quick Example

from owi.metadatabase.shm import ApiShmRepository, SensorService, ShmAPI, ShmEntityService

api = ShmAPI(token="your-api-token")
repository = ApiShmRepository(api)
entity_service = ShmEntityService(repository=repository)
service = SensorService(entity_service=entity_service)

print(api.ping())
print(service.get_sensor_type({"name": "393B04"}))

Read Data Workflows

If you are using the SHM SDK for queries rather than uploads, start here:

Notebook Workflows

The repository also includes executable tutorial notebooks in scripts/ for sensor and signal upload workflows. They use the bundled Norther example data and are suitable both as interactive guides and as executable regression gates.