Skip to main content

No project description provided

Project description

xpublish-edr

PyPI Conda Version

Tests codecov pre-commit.ci status

Xpublish routers for the OGC EDR API.

Documentation and code

URLs for the docs and code.

Installation

For conda users you can

conda install --channel conda-forge xpublish_edr

or, if you are a pip users

pip install xpublish_edr

Example

import xarray as xr
import xpublish
from xpublish.routers import base_router, zarr_router
from xpublish_edr.cf_edr_router import cf_edr_router


ds = xr.open_dataset("dataset.nc")

rest = xpublish.Rest(
    datasets,
    routers=[
        (base_router, {"tags": ["info"]}),
        (cf_edr_router, {"tags": ["edr"], "prefix": "/edr"}),
        (zarr_router, {"tags": ["zarr"], "prefix": "/zarr"}),
    ],
)

OGC EDR Spec Compliance

This package attempts to follow the spec where reasonable, adding functionality where the value is demonstrable.

collections and Resource Paths Support

xpublish-edr does not currently support the /collections/{collectionId}/query path template described in the spec. Instead the path resource appears as /{dataset_id}/query. This is because of the path structure of xpublish.

In the future, when xpublish supports DataTree it will provide a path to supporting the spec compliant collections resource path.

Supported Queries

8.2.1 Position query

Query Compliant Comments
coords
z
datetime
parameter-name
crs Not currently supported, all coordinates should be in the reference system of the queried dataset
parameter-name
f
method Optional: controls data selection. Use "nearest" for nearest neighbor selection, or "linear" for interpolated selection. Uses nearest if not specified

Any additional query parameters are assumed to be additional selections to make on the dimensions/coordinates. These queries will use the specified selections method.

8.2.3 Area query

Query Compliant Comments
coords Only POLYGON supported currently
z
datetime
parameter-name
crs Not currently supported, all coordinates should be in the reference system of the queried dataset
parameter-name
f
method Optional: controls data selection. Use "nearest" for nearest neighbor selection, or "linear" for interpolated selection. Uses nearest if not specified

method is not applicable for the coordinates of area queries, only for selecting datetime, z, or additional dimensions.

For POLYGON coordinates, points that are located within OR on the polygons boundary are included in the response.

Get in touch

Report bugs, suggest features or view the source code on GitHub.

License and copyright

xpublish-edr is licensed under BSD 3-Clause "New" or "Revised" License (BSD-3-Clause).

Development occurs on GitHub at https://github.com/gulfofmaine/xpublish-edr/issues.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

xpublish_edr-0.2.2.tar.gz (11.8 kB view details)

Uploaded Source

Built Distribution

xpublish_edr-0.2.2-py3-none-any.whl (14.5 kB view details)

Uploaded Python 3

File details

Details for the file xpublish_edr-0.2.2.tar.gz.

File metadata

  • Download URL: xpublish_edr-0.2.2.tar.gz
  • Upload date:
  • Size: 11.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/5.1.1 CPython/3.12.7

File hashes

Hashes for xpublish_edr-0.2.2.tar.gz
Algorithm Hash digest
SHA256 390a16eed6bc0ef5235acb45b7d0d9f15d4db4d16d374099c49b706e126f0d59
MD5 a3406922fd0117fe6e04e79d75ec75dc
BLAKE2b-256 e7d88742cebca52bf8decad8eae881061432b0fdc71371265a561131c81f3891

See more details on using hashes here.

Provenance

The following attestation bundles were made for xpublish_edr-0.2.2.tar.gz:

Publisher: GitHub
  • Repository: xpublish-community/xpublish-edr
  • Workflow: publish-to-pypi.yml
Attestations:
  • Statement type: https://in-toto.io/Statement/v1
    • Predicate type: https://docs.pypi.org/attestations/publish/v1
    • Subject name: xpublish_edr-0.2.2.tar.gz
    • Subject digest: 390a16eed6bc0ef5235acb45b7d0d9f15d4db4d16d374099c49b706e126f0d59
    • Transparency log index: 148157777
    • Transparency log integration time:

File details

Details for the file xpublish_edr-0.2.2-py3-none-any.whl.

File metadata

  • Download URL: xpublish_edr-0.2.2-py3-none-any.whl
  • Upload date:
  • Size: 14.5 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/5.1.1 CPython/3.12.7

File hashes

Hashes for xpublish_edr-0.2.2-py3-none-any.whl
Algorithm Hash digest
SHA256 f3819af8e94b6544543109e180b222646eb2be315a8d34cabd4b5c010167880f
MD5 4afa5a51acce65b0043b03f4b9b84d34
BLAKE2b-256 3dc9bed5be2c427f116d3b9f3f488f9da5b5c09dae2f3cc77b5631f6c64bffc3

See more details on using hashes here.

Provenance

The following attestation bundles were made for xpublish_edr-0.2.2-py3-none-any.whl:

Publisher: GitHub
  • Repository: xpublish-community/xpublish-edr
  • Workflow: publish-to-pypi.yml
Attestations:
  • Statement type: https://in-toto.io/Statement/v1
    • Predicate type: https://docs.pypi.org/attestations/publish/v1
    • Subject name: xpublish_edr-0.2.2-py3-none-any.whl
    • Subject digest: f3819af8e94b6544543109e180b222646eb2be315a8d34cabd4b5c010167880f
    • Transparency log index: 148157781
    • Transparency log integration time:

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page