add support for satstac.ItemCollection

binder/environment.yml

@@ -10,10 +10,10 @@ dependencies:
   - intake_geopandas
   - intake-xarray
   - rasterio
+  - sat-stac
+  - sat-search
   - netcdf4
   - rasterio
   - scikit-image
   - matplotlib
   - pip
-  - pip:
-    - sat-stac

ci/environment-dev-3.6.yml

@@ -29,6 +29,7 @@ dependencies:
   - pytoml
   - pyyaml
   - recommonmark
+  - sat-search
   - sat-stac
   - scikit-image
   - sphinx_rtd_theme

ci/environment-dev-3.7-upstream.yml

@@ -36,5 +36,6 @@ dependencies:
   - pip:
     - sphinx_copybutton
     - git+https://github.com/sat-utils/sat-stac.git
+    - git+https://github.com/sat-utils/sat-search.git
     - git+https://github.com/intake/intake.git
     - git+https://github.com/intake/intake-xarray.git

ci/environment-dev-3.7.yml

@@ -29,6 +29,7 @@ dependencies:
   - pytoml
   - pyyaml
   - recommonmark
+  - sat-search
   - sat-stac
   - scikit-image
   - sphinx_rtd_theme

docs/source/api.rst

@@ -14,6 +14,7 @@ Top-level functions
 
    open_stac_catalog
    open_stac_collection
+   open_stac_item_collection
    open_stac_item
 
 .. currentmodule:: intake_stac
@@ -26,5 +27,6 @@ Catalog Objects
 
    StacCatalog
    StacCollection
+   StacItemCollection
    StacItem
    catalog.StacEntry

docs/source/index.rst

@@ -6,9 +6,9 @@ Intake-stac is an open source project and Python package for discovering,
 exploring, and loading spatio-temporal datasets.
 
 Intake-stac provides Intake Drivers for SpatioTemporal Asset Catalogs (STAC).
-It provides tools for opening STAC ``Catalogs``, ``Collections``, and ``Items``
-as Intake catalogs. Intake and Intake-xarray provide the tooling for loading
-assets described in STAC into Xarray objects.
+It provides tools for opening STAC ``Catalogs``, ``Collections``,
+``ItemCollections``, and ``Items`` as Intake catalogs. Intake and Intake-xarray
+provide the tooling for loading assets described in STAC into Xarray objects.
 
 .. toctree::
    :maxdepth: 2

docs/source/tutorial.rst

@@ -2,8 +2,17 @@
 Tutorial
 ========
 
-Intake-stac provides is pretty simple. It provides a thin interface that
-combines `sat-stac` and Intake. It's basic usage is shown below:
+.. ipython:: python
+   :suppress:
+
+    import warnings
+    with warnings.catch_warnings(record=True) as w:
+        warnings.simplefilter("ignore")
+        import pandas
+        import xarray
+
+Intake-stac simply provides a thin interface that combines `sat-stac` and
+Intake. It's basic usage is shown below:
 
 To begin, import intake:
 
@@ -88,3 +97,30 @@ using Intake's `to_dask()` method:
 
     da = entry.to_dask()
     display(da)
+
+Working with `sat-search`
+-------------------------
+
+Intake-stac integrates with `sat-search` to faciliate dynamic search and
+discovery of assets through a STAC-API. To begin, construct a search query
+using `sat-search`:
+
+.. ipython:: python
+
+    import satsearch
+
+    results = satsearch.Search.search(
+        collection='landsat-8-l1',
+        bbox=[43.16, -11.32, 43.54, -11.96],
+        sort=['<datetime'], #earliest scene first
+        property=["landsat:tier=T1"])
+    items = results.items()
+    display(items)
+
+In the code section above, `items` is a `satstac.ItemsCollection` object.
+Intake-stac can turn this object into an Intake catalog:
+
+.. ipython:: python
+
+    catalog = intake.open_stac_item_collection(items)
+    list(catalog)

intake_stac/__init__.py

@@ -4,6 +4,6 @@
 del get_versions
 
 import intake  # noqa: F401
-from .catalog import StacCatalog, StacCollection, StacItem
+from .catalog import StacCatalog, StacCollection, StacItem, StacItemCollection
 
-__all__ = ["StacCatalog", "StacCollection", "StacItem"]
+__all__ = ["StacCatalog", "StacCollection", "StacItem", "StacItemCollection"]

intake_stac/catalog.py

@@ -33,12 +33,15 @@ def __init__(self, stac_obj, **kwargs):
         else:
             raise ValueError(
                 "Expected %s instance, got: %s"
-                % (type(self._stac_cls), type(stac_obj))
+                % (self._stac_cls, type(stac_obj))
             )
 
         metadata = self._get_metadata(**kwargs.pop("metadata", {}))
 
-        name = kwargs.pop("name", self._stac_obj.id)
+        try:
+            name = kwargs.pop("name", self._stac_obj.id)
+        except AttributeError:
+            name = str(type(self._stac_obj))
 
         super().__init__(name=name, metadata=metadata, **kwargs)
 
@@ -125,6 +128,31 @@ def _get_metadata(self, **kwargs):
         )
 
 
+class StacItemCollection(AbstractStacCatalog):
+    """
+    Intake Catalog represeting a STAC ItemCollection
+    """
+
+    name = "stac_item_collection"
+    _stac_cls = satstac.ItemCollection
+
+    def _load(self):
+        """
+        Load the STAC Item Collection.
+        """
+        for item in self._stac_obj:
+            self._entries[item.id] = LocalCatalogEntry(
+                name=item.id,
+                description="",
+                driver=StacItem,
+                catalog=self,
+                args={"stac_obj": item},
+            )
+
+    def _get_metadata(self, **kwargs):
+        return kwargs
+
+
 class StacCollection(AbstractStacCatalog):
     """
     Intake Catalog represeting a STAC Collection
@@ -201,7 +229,14 @@ def stack_bands(self, bands, regrid=False):
         item = {"concat_dim": "band", "urlpath": [], "type": "image/x.geotiff"}
         titles = []
         assets = self._stac_obj.assets
-        band_info = self._stac_obj.collection().properties.get("eo:bands")
+
+        try:
+            band_info = self._stac_obj.collection().properties.get("eo:bands")
+        except AttributeError:
+            # TODO: figure out why satstac objects don't always have a
+            #  collection. This workaround covers the case where
+            # `.collection()` returns None
+            band_info = self._stac_obj.properties.get("eo:bands")
 
         for band in bands:
             # band can be band id, name or common_name