pygeoapi-odc-provider

Provider plugin for pygeoapi to include Open Data Cube as a data resource.

Install: python setup.py install or python -m pip install .

API Coverages

A new collection can be added to the pygeoapi config.yaml with the following provider section after this library was installed:

providers:
  - type: coverage
    name: odcprovider.OpenDataCubeCoveragesProvider
    data: <product_name>
    format:
        name: NetCDF
        mimetype: application/netcdf

API Processes

Add new process can be configured by adding the following to the config.yaml:

[...]
  resources:
      hello-world:
      type: process
      processor:
        name: odcprovider.HelloWorldProcessor

Use the following curl call for testing the process:

curl -i -s -H "Content-Type: application/json" -X POST -d @request.json 'https://17.testbed.dev.52north.org/geodatacube/processes/hello-world/execution'

with request.json:

{
   "inputs": {
      "name": "Mr Test McTestface",
      "message": "Your are so testy today!"
   }
}

API Records

To use the OpenDataCubeRecordsProvider, add the following collection resource. The name catalog is not required but useful. Adjust the bbox to your data.

resources:
    catalog:
      type: collection
      title: Catalog
      description: Catalog collection providing metadata using OGC API records
      keywords:
        - records
        - metadata
        - search
      links:
        - type: text/html
          rel: canonical
          title: OGC API records DRAFT OGC#20-004
          href: https://docs.ogc.org/DRAFTS/20-004.html#record-schema-overview
          hreflang: en-US
      extents:
        spatial:
          bbox: [-142.2750,41.6276,-58.2405,83.5941]
          # EPSG#4617
          crs: http://www.opengis.net/def/crs/OGC/1.3/CRS84
      providers:
        - type: record
          name: odcprovider.OpenDataCubeRecordsProvider
          data: not-used-atm

Configuration of pygeoapi

To use products from Open Data Cube (ODC) in pygeoapi, they must be registered as dataset collections under the resources key in pygeoapi's config file (https://docs.pygeoapi.io/en/latest/configuration.html#resources).

The script create_config.py provides a convenient way to automatically generate a yml file containing resource entries for each ODC product. The script can optionally take an input file. The automatically generated resource entries will be merged/inserted there. The input file usually contains server and metadata information that is also needed to configure pygeoapi.

Docker

A custom Dockerfile for pygeoapi is provided which extends the official pygeoapi Docker image with the pygeoapi-odc-provider. To import data in Open Data Cube the opendatacube-importer can be used.

Changelog

• 0.4.0: add Dockerfile and docker-compose.yml
• 0.3.0: WIP records provider
• 0.2.0: add first processors
• 0.0.1: WIP coverages provider

Tests and Coverage

1. Install coverage: pip install coverage

2. Perform analysis: ./tests$ coverage run --branch --source ../src/ -m pytest

3. Render HTML report: ./tests$ coverage html

4. Open browser with file:///path-to-repo/tests/htmlcov/index.html and enable javascript.

ToDos

• Clarify License: MIT vs GPLv2 vs Apache 2.0 for service libs @52N