Skip to content

Commit

Permalink
docs: add link to stac index (#328)
Browse files Browse the repository at this point in the history
### Motivation

It is somewhat hard to know how to browse the archive so provide a big
button to a STAC browser.

### Modifications

Adds a badge to link to STAC index and to the catalog directly

### Verification

<!-- TODO: Say how you tested your changes. -->
  • Loading branch information
blacha authored Dec 2, 2024
1 parent ec1c969 commit 0028f64
Showing 1 changed file with 9 additions and 5 deletions.
14 changes: 9 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,12 +1,20 @@
# New Zealand Elevation

[![STAC Index Badge](https://img.shields.io/badge/New_Zealand_Elevation-%2309B3AD?style=flat&label=Open%20in%20STAC%20Index&labelColor=%23144E63&link=https%3A%2F%2Fstacindex.org%2Fcatalogs%2Fnz-elevation%23%2F)](https://stacindex.org/catalogs/nz-elevation#/)

Toitū Te Whenua makes New Zealand's most up-to-date publicly owned elevation data freely available to use under an open licence. You can access this through the [LINZ Data Service](https://data.linz.govt.nz/data/category/elevation/), [LINZ Basemaps](https://basemaps.linz.govt.nz/@-41.8899962,174.0492437,z5?i=elevation) or the [Registry of Open Data on AWS](https://registry.opendata.aws/nz-elevation/).

## Quickstart

Browse the archive with [STAC Index](https://stacindex.org/catalogs/nz-elevation#/) or access the catalog directly [https://nz-elevation.s3-ap-southeast-2.amazonaws.com/catalog.json](https://nz-elevation.s3-ap-southeast-2.amazonaws.com/catalog.json)

## Background

This repository contains STAC Collection metadata for each elevation dataset, as well as some guidance documentation:

- [Naming](docs/naming.md) covers the s3://nz-elevation bucket naming structure
- [Usage](docs/usage.md) shows how TIFFs can be interacted with from S3 using GDAL, QGIS, etc
- [Elevation Compression](docs/tiff-compression) provides commentary and analysis on the compression options we explored.
- [Elevation Compression](docs/tiff-compression/README.md) provides commentary and analysis on the compression options we explored.

## AWS Access

Expand All @@ -18,10 +26,6 @@ Using the [AWS CLI](https://aws.amazon.com/cli/) anyone can access all of the im
aws s3 ls --no-sign-request s3://nz-elevation/
```

### Browsing the S3 Bucket

[STAC Browser](https://radiantearth.github.io/stac-browser/#/external/nz-elevation.s3.ap-southeast-2.amazonaws.com/catalog.json) can be used to browse through the contents of the S3 bucket.

## Related

For access to LINZ's aerial and satellite imagery see [linz/imagery](https://github.com/linz/imagery)
Expand Down

0 comments on commit 0028f64

Please sign in to comment.