Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

initial pass at using pystac instead of sat-stac #72

Merged
merged 14 commits into from
Mar 3, 2021
Merged
Show file tree
Hide file tree
Changes from 6 commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -1,3 +1,8 @@
test-reports/
docs/source/generated/
examples/
*pdf

# Byte-compiled / optimized / DLL files
__pycache__/
*.py[cod]
Expand Down
9 changes: 9 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,15 @@ All notable changes to this project will be documented in this file.
The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/)
and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.html).

## [v0.4.0] - 2021-XX-XX

- Switched from sat-stac to pystac dependency (#72)
- CI nightly test against py36 to py39 (#71)

### Added

- Tests against python3.8 (#63)

## [v0.3.0] - 2020-10-01

### Added
Expand Down
25 changes: 13 additions & 12 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,18 +1,18 @@
# Intake-STAC

![CI](https://github.com/pangeo-data/intake-stac/workflows/CI/badge.svg)
[![Binder](https://mybinder.org/badge_logo.svg)](https://mybinder.org/v2/gh/pangeo-data/intake-stac/binder?urlpath=git-pull%3Frepo%3Dhttps%253A%252F%252Fgithub.com%252Fpangeo-data%252Fintake-stac%26urlpath%3Dlab%252Ftree%252Fintake-stac%252Fexamples%26branch%3Dmain)
![CI](https://github.com/intake/intake-stac/workflows/CI/badge.svg)
[![Binder](https://mybinder.org/badge_logo.svg)](https://mybinder.org/v2/gh/intake/intake-stac/binder?urlpath=git-pull%3Frepo%3Dhttps%253A%252F%252Fgithub.com%252Fintake%252Fintake-stac%26urlpath%3Dlab%252Ftree%252Fintake-stac%252Fexamples%26branch%3Dmain)
[![PyPI version](https://badge.fury.io/py/intake-stac.svg)](https://badge.fury.io/py/intake-stac)
[![Documentation Status](https://readthedocs.org/projects/intake-stac/badge/?version=latest)](https://intake-stac.readthedocs.io/en/latest/?badge=latest)
[![codecov](https://codecov.io/gh/pangeo-data/intake-stac/branch/main/graph/badge.svg)](https://codecov.io/gh/pangeo-data/intake-stac)
[![codecov](https://codecov.io/gh/intake/intake-stac/branch/main/graph/badge.svg)](https://codecov.io/gh/intake/intake-stac)

This is an [Intake](https://intake.readthedocs.io/en/latest) data source for [SpatioTemporal Asset Catalogs (STAC)](https://stacspec.org/). 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](https://github.com/intake/intake-xarray) plugin and supports several file formats including GeoTIFF, netCDF, GRIB, and OpenDAP.

## Installation

Intake-STAC has a few [requirements](requirements.txt), such as [Intake](https://intake.readthedocs.io), [intake-xarray](https://intake-xarray.readthedocs.io/) and [sat-stac](https://github.com/sat-utils/sat-stac). Intake-stac can be installed in any of the following ways:
Intake-STAC has a few [requirements](requirements.txt), such as [Intake](https://intake.readthedocs.io), [intake-xarray](https://intake-xarray.readthedocs.io/) and [pystac](https://github.com/stac-utils/pystac). Intake-stac can be installed in any of the following ways:

We recommend installing the latest release with `conda`:

Expand All @@ -26,7 +26,7 @@ Or the latest development version with `pip`:
$ pip install git+https://github.com/intake/intake-stac
```

## Examples
## Quickstart

```python
from intake import open_stac_catalog
Expand All @@ -37,23 +37,24 @@ da = cat['Houston-East-20170831-103f-100d-0f4f-RGB']['thumbnail'].to_dask()
da
```

The [examples/](examples/) directory contains some example Jupyter Notebooks that can be used to test the functionality.
The [examples/](examples/) directory contains several Jupyter Notebooks illustrating common workflows.

#### Versions

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

```bash
pip install intake-stac==0.3.0
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.x |
| intake-stac | STAC |
| ----------- | ----------- |
| 0.2.x | 0.6.x |
| 0.3.x | 1.0.0-betaX |
| 0.4.x | 1.0.0-betaX |

## About

[intake-stac](https://github.com/pangeo-data/intake-stac) was created as part of the [Pangeo](http://pangeo.io) initiative under support from the NASA-ACCESS program. See the initial [design document](https://hackmd.io/cyJZkjV5TCWTJg1mUAoEVA).
[intake-stac](https://github.com/intake/intake-stac) was created as part of the [Pangeo](http://pangeo.io) initiative under support from the NASA-ACCESS program. See the initial [design document](https://hackmd.io/cyJZkjV5TCWTJg1mUAoEVA).
2 changes: 1 addition & 1 deletion ci/environment-3.7.yml
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ dependencies:
- geopandas
- intake
- intake-xarray
- pystac
- pytest-cov
- rasterio
- sat-stac
- xarray
2 changes: 1 addition & 1 deletion ci/environment-3.8.yml
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ dependencies:
- geopandas
- intake
- intake-xarray
- pystac
- pytest-cov
- rasterio
- sat-stac
- xarray
2 changes: 1 addition & 1 deletion ci/environment-3.9.yml
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ dependencies:
- geopandas
- intake
- intake-xarray
- pystac
- pytest-cov
- rasterio
- sat-stac
- xarray
2 changes: 1 addition & 1 deletion ci/environment-dev.yml
Original file line number Diff line number Diff line change
Expand Up @@ -29,14 +29,14 @@ dependencies:
- pandoc
- pip
- pre_commit
- pystac
- pytest-cov
- pytoml
- pyyaml
- rasterio
- recommonmark
- requests
- sat-search>=0.3
- sat-stac
- sphinx-copybutton
- sphinx_rtd_theme
- sphinx>=1.6
Expand Down
11 changes: 5 additions & 6 deletions ci/environment-docs.yml
Original file line number Diff line number Diff line change
@@ -1,7 +1,6 @@
#readthedocs uses defaults rather than conda-forge
name: intake-stac
channels:
- defaults
- conda-forge
dependencies:
- python=3.7
- aiohttp
Expand All @@ -11,17 +10,17 @@ dependencies:
- intake-xarray
- ipython
- mock
- nbsphinx
- numpydoc
- pillow
- pip
- pystac
- pytest-cov
- rasterio
- sat-search
- scikit-image
- sphinx
- sphinx_rtd_theme
- xarray
- pip:
- nbsphinx
- sat-search
- sat-stac
- .. #installs intake-stac from root folder
- ../ #installs intake-stac from root folder
2 changes: 1 addition & 1 deletion ci/environment-gui.yml
Original file line number Diff line number Diff line change
Expand Up @@ -40,6 +40,7 @@ dependencies:
- panel
- pip
- pre_commit
- pystac
- pytest
- pytest-cov
- pytest-icdiff
Expand All @@ -49,7 +50,6 @@ dependencies:
- recommonmark
- requests
- sat-search>=0.3
- sat-stac
- scikit-image
- sphinx-copybutton
- sphinx_rtd_theme
Expand Down
2 changes: 1 addition & 1 deletion ci/environment-unpinned.yml
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ dependencies:
- geopandas
- intake
- intake-xarray
- pystac
- pytest-cov
- rasterio
- sat-stac
- xarray
4 changes: 2 additions & 2 deletions ci/environment-upstream.yml
Original file line number Diff line number Diff line change
Expand Up @@ -8,13 +8,13 @@ dependencies:
- intake
- intake-xarray
- pip
- pystac
- pytest-cov
- rasterio
- sat-stac
- xarray
- pip:
- git+https://github.com/intake/filesystem_spec.git
- git+https://github.com/sat-utils/sat-stac.git
- git+https://github.com/stac-utils/pystac.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
Expand Down
Loading