intake_stac.StacCatalog

class intake_stac.StacCatalog(stac_obj, **kwargs)[source]

Intake Catalog represeting a STAC Catalog

A Catalog that references a STAC catalog at some URL and constructs an intake catalog from it, with opinionated choices about the drivers that will be used to load the datasets. In general, the drivers are:

  • netcdf
  • rasterio
  • xarray_image
  • textfiles
__init__(self, stac_obj, **kwargs)

Initialize the catalog.

Parameters:
stac_obj: stastac.Thing

A satstac.Thing pointing to a STAC object

kwargs : dict, optional

Passed to intake.Catolog.__init__

Methods

__init__(self, stac_obj, \*\*kwargs) Initialize the catalog.
close(self) Close open resources corresponding to this data source.
discover(self) Open resource and populate the source attributes.
export(self, path, \*\*kwargs) Save this data for sharing with other people
filter(self, func) Create a Catalog of a subset of entries based on a condition
force_reload(self) Imperative reload data now
from_dict(entries, \*\*kwargs) Create Catalog from the given set of entries
from_url(url, \*\*kwargs) Initialize the catalog from a STAC url.
get_persisted(self)
items(self) Get an iterator over (key, value) tuples for the catalog entries.
persist(self[, ttl]) Save data from this source to local persistent storage
pop(self, key) Remove entry from catalog and return it
read(self) Load entire dataset into a container and return it
read_chunked(self) Return iterator over container fragments of data source
read_partition(self, i) Return a part of the data corresponding to i-th partition.
reload(self) Reload catalog if sufficient time has passed
save(self, url[, storage_options]) Output this catalog to a file as YAML
search(self, text[, depth])
serialize(self) Serialize the catalog to yaml.
set_cache_dir(self, cache_dir)
to_dask(self) Return a dask container for this data source
to_spark(self) Provide an equivalent data object in Apache Spark
walk(self[, sofar, prefix, depth]) Get all entries in this catalog and sub-catalogs
yaml(self[, with_plugin]) Return YAML representation of this data-source

Attributes

cache_dirs
classname
container
datashape
description
gui
has_been_persisted
hvplot Returns a hvPlot object to provide a high-level plotting API.
is_persisted
kwargs
name
partition_access
plot Returns a hvPlot object to provide a high-level plotting API.
plots List custom associated quick-plots
version