Skip to content

intake/intake-stac

Repository files navigation

Intake-STAC

CI Binder PyPI version Documentation Status codecov

This is an Intake data source for SpatioTemporal Asset Catalogs (STAC). The STAC specification provides a common metadata specification, API, and catalog format to describe geospatial assets, so they can more easily indexed and discovered. A 'spatiotemporal asset' is any file that represents information about the earth captured in a certain space and time.

Intake-STAC provides an opinionated way for users to load Assets from STAC catalogs into the scientific Python ecosystem. It uses the intake-xarray plugin and supports several file formats including GeoTIFF, netCDF, GRIB, and OpenDAP.

Installation

Intake-STAC has a few requirements, such as Intake, intake-xarray and pystac. Intake-stac can be installed in any of the following ways:

We recommend installing the latest release with conda:

$ conda install -c conda-forge intake-stac

Or the latest development version with pip:

$ pip install git+https://github.com/intake/intake-stac

Quickstart

import intake

catalog_url = 'https://www.planet.com/data/stac/catalog.json'
cat = intake.open_stac_catalog(catalog_url)

collection = cat['planet-disaster-data']
subset = collection['hurricane-harvey']['hurricane-harvey-0831']
item = subset['Houston-East-20170831-103f-100d-0f4f-RGB']

da = item['thumbnail'].to_dask()
da

The examples/ directory contains several Jupyter Notebooks illustrating common workflows.

STAC Index is a convenient website for finding datasets with STACs

Versions

To install a specific version of intake-stac, specify the version in the install command

pip install intake-stac==0.4.0

The table below shows the corresponding versions between intake-stac and STAC:

intake-stac STAC
0.2.x 0.6.x
0.3.x 1.0.0-betaX
0.4.x 1.0.0

About

intake-stac was created as part of the Pangeo initiative under support from the NASA-ACCESS program. See the initial design document.