This repo contains the source JSON files for the open SpatioTemporal Asset Catalog (STAC) resources deployed to https://www.planet.com/data/stac. This repo is formatted as a 'metadata-only' self-contained catalog with the assets all residing in a Planet Google Cloud Storage bucket. Publishing is done by pushing to an internal Planet git repo, where the catalog is rewritten to be an 'absolute published catalog'.
The catalog should be considered 'in-progress', as not all items are in their ideal state yet. Contributions as Pull Requests to help improve the STAC metadata are welcome, subject to review by the project maintainers.
The instructions below currently require access to the private us.gcr.io/planet-gcr registry. Until that changes, you can skip these make commands and rely on CI jobs to make things work.
The development environment requires Docker and Make.
After adding new STAC resources to the stac directory, add links from the root stac/catalog.json (or an existing linked collection or catalog). Use relative URLs for all link href values.
To format everything in the stac directory:
make format
To add or update stats for the stac/catalog.json:
make stats
To validate all of the resources:
make validate
Deploying changes to https://www.planet.com/data/stac must be done by a Planeteer - if you'd like new changes contributed to be published then just let the maintainers of this repo know.
To update the deployment, set up remotes for the internal and external repositories:
git remote add origin git@github.com:planetlabs/open-stac.git
git remote add planet ${INTERNAL_REPO_URL}Whenever you want to deploy the latest from the default branch on GitHub:
git fetch origin
git push planet origin/main:mainPlanet and any contributors grant you a license to any content (JSON metadata, etc) in this repository under the Creative Commons Attribution 4.0 International Public License, see the LICENSE file, and grant you a license to any code in the repository under the Apache 2 License, see the LICENSE-CODE file.