Skip to content

Latest commit

 

History

History
67 lines (44 loc) · 3 KB

README.md

File metadata and controls

67 lines (44 loc) · 3 KB

Intake-stac

Binder Build Status 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.

Two examples of STAC catalogs are:

Radiant Earth keeps track of a more complete listing of STAC implementations here.

This project provides an opinionated way for users to load datasets from these 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 sat-stac. Intake-stac can be installed in any of the following ways:

Using conda:

$ conda install -c conda-forge intake-stac

Using Pip:

$ pip install intake-stac

Or from the source repository:

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

The examples/ directory contains some example Jupyter Notebooks that can be used to test the functionality.

Versions

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

pip install intake-stac==0.1.0

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

sat-stac STAC
0.[1,2].x 0.6.x

Running the tests

To run the tests some additional packages need to be installed from the requirements-dev.txt file.

$ pip install -r requirements-dev.txt
$ pytest -v -s --cov intake-stac --cov-report term-missing

About

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