Skip to main content

Tooling for converting STAC metadata to ODC data model

Project description

odc.stac

Documentation Status Test Status Test Coverage Run Examples in Binder Join Discord for support

Load STAC items into xarray Datasets. Process locally or distribute data loading and computation with Dask.

Usage

odc.stac.load

catalog = pystac_client.Client.open(...)
query = catalog.search(...)
xx = odc.stac.load(
    query.items(),
    bands=["red", "green", "blue"],
)
xx.red.plot.imshow(col="time")

For more details see Documentation and Sample Notebooks, or try it out on Binder.

Installation

Using pip

pip install odc-stac

To install with botocore support (for working with AWS):

pip install 'odc-stac[botocore]'

Using Conda

This package is be available on conda-forge channel:

conda install -c conda-forge odc-stac

From unreleased source

To use development version of odc-stac install dependencies from conda, then install odc-stac with pip.

Sample environment.yml is provided below.

channels:
  - conda-forge
dependencies:
  - odc-geo
  - xarray
  - numpy
  - dask
  - pandas
  - affine
  - rasterio
  - toolz
  - pystac
  - pystac-client
  - pip
  - pip:
    - "git+https://github.com/opendatacube/odc-stac/"

Developing

To develop odc-stac locally it’s best to use provided devcontainer.

git clone https://github.com/opendatacube/odc-stac
code odc-stac

Once running inside the dev container, run tests with pytest:

pytest

Linting is provided by mypy, pylint, and black:

black --check .
pylint -v odc
mypy odc

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

odc_stac-0.5.3.tar.gz (296.2 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

odc_stac-0.5.3-py3-none-any.whl (44.1 kB view details)

Uploaded Python 3

File details

Details for the file odc_stac-0.5.3.tar.gz.

File metadata

  • Download URL: odc_stac-0.5.3.tar.gz
  • Upload date:
  • Size: 296.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/7.0.0 CPython/3.12.3

File hashes

Hashes for odc_stac-0.5.3.tar.gz
Algorithm Hash digest
SHA256 00144973748880115f3e261401b0378f14c1bcf6490b0bbeb3c18e9c68508b4e
MD5 9908f4177932e6ae93915c5bca4422a9
BLAKE2b-256 83bb428165d3ff727791531559d1049fb4fad7899a6f878e769378d0b3269f31

See more details on using hashes here.

File details

Details for the file odc_stac-0.5.3-py3-none-any.whl.

File metadata

  • Download URL: odc_stac-0.5.3-py3-none-any.whl
  • Upload date:
  • Size: 44.1 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/7.0.0 CPython/3.12.3

File hashes

Hashes for odc_stac-0.5.3-py3-none-any.whl
Algorithm Hash digest
SHA256 0597532a46003c9462d04e5015ebd9f2e2dec40892c6a4bcc515b278e789179a
MD5 7e596640da4cc8527fc1bdb9f2c980bf
BLAKE2b-256 c279936fc1d69f1a1102f2e0bae76ad2ca1cab3503e69a2ae900e843dbd86a2c

See more details on using hashes here.

Supported by

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