odp-data-consume

ODP Data Consume Skill

Use this skill when the user wants to read, query, download, or pull data from the Ocean Data Platform (ODP) by Hub Ocean.

Prerequisites

Python Dependencies

pip install odp-sdk pyarrow shapely pandas python-dotenv h3

Package	Purpose
odp-sdk	ODP client library (authentication, catalog, dataset operations)
pyarrow	Tabular data deserialization
shapely	Convert WKT geometry back to GeoJSON
pandas	DataFrame handling for tabular query results
h3	Convert H3 cell ids back to boundary polygons from aggregate results

Authentication

import os
from odp.client import Client

client = Client(api_key=os.environ["ODP_API_KEY"])

Finding an API key

If ODP_API_KEY isn't already set in the environment, discover one from a local project's .env before asking the user. ODP-related projects commonly keep the key in their .env file.

# Search local project roots for an ODP_API_KEY in any .env file
grep -rhI --include='.env*' -E '^\s*ODP_API_KEY=' \
  ~/Projects ~/projects 2>/dev/null \
  | head -1 | sed -E 's/^\s*ODP_API_KEY=//'

Guidelines:

• Prefer an already-exported ODP_API_KEY; only scan .env files if the env var is unset.
• Search your working directories (e.g. ~/Projects, ~/projects) for .env/.env.* files containing ODP_API_KEY=.
• If several projects define a key, they usually share the same one — take the first match, but if they differ, ask the user which project/key to use.
• Never print the key value back to the user or write it into committed files. Read it, use it in-process, and pass it via an env var or directly to Client(api_key=...).
• If no key is found anywhere, ask the user for one rather than guessing.

Two Ways to Access Data

Method	Best for	Authentication
Python SDK	Downloading files, querying tabular data, programmatic access	API key required
STAC API	Discovering collections, spatial/temporal search, browsing catalog	No auth for public data