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.2.tar.gz (116.5 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.2-py3-none-any.whl (44.0 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for odc_stac-0.5.2.tar.gz
Algorithm Hash digest
SHA256 ab5969805e843be072c3bf2886b383b9a6101ab556d91bfc83377a87455c6028
MD5 501b7612193a87e3d34be2d4aca7cde9
BLAKE2b-256 003a7d7ad9deb2fb612bb42f6499ca49b7bdd8850e4d2189b974ca521d2e93aa

See more details on using hashes here.

File details

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

File metadata

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

File hashes

Hashes for odc_stac-0.5.2-py3-none-any.whl
Algorithm Hash digest
SHA256 acb15b7dd26771fdcdf4f93b1e070e14748fad6d18c572e6710f8ca5d6c78073
MD5 a43d211576743c7095c1f2573f9e0f31
BLAKE2b-256 018afd93f13a9b4b688b5ac8c8ec14ed6401db99166b7d55c41c9c96250398d9

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