From 70a1d6a78ca9a14497fe246f5e066b96f6266599 Mon Sep 17 00:00:00 2001 From: Nick Roberts Date: Thu, 24 Oct 2024 20:59:08 -0400 Subject: [PATCH] First pass at updating readme --- README.md | 54 +++++++++++++++++++++++------------------------------- 1 file changed, 23 insertions(+), 31 deletions(-) diff --git a/README.md b/README.md index bf65d0e..260a502 100644 --- a/README.md +++ b/README.md @@ -1,18 +1,18 @@ -# Template Extension Specification +# SST Extension Specification -- **Title:** Template -- **Identifier:** -- **Field Name Prefix:** template +- **Title:** SST +- **Identifier:** +- **Field Name Prefix:** sst - **Scope:** Item, Collection - **Extension [Maturity Classification](https://github.com/radiantearth/stac-spec/tree/master/extensions/README.md#extension-maturity):** Proposal -- **Owner**: @your-gh-handles @person2 +- **Owner**: @slawler @nick-j-roberts -This document explains the Template Extension to the [SpatioTemporal Asset Catalog](https://github.com/radiantearth/stac-spec) (STAC) specification. -This is the place to add a short introduction. +This document explains the SST Extension to the [SpatioTemporal Asset Catalog](https://github.com/radiantearth/stac-spec) (STAC) specification. +This extension is meant to formalize and define terms used in documenting metadata produced as part of a pipeline for running stochaistic storm transposition (SST) modeling. This extension thus far focuses on metadata produced when translating a watershed geometry over a valid transposition region and summarizing precipitation values found in the translated location in order to identify precipitation accumulation metrics which could have realistically occurred within the watershed and over a given duration. - Examples: - - [Item example](examples/item.json): Shows the basic usage of the extension in a STAC Item - - [Collection example](examples/collection.json): Shows the basic usage of the extension in a STAC Collection + - [Item example](examples/item.json): Shows the basic usage of the extension in a STAC Item using dummy values + - [Collection example](examples/collection.json): Shows the basic usage of the extension in a STAC Collection for the summaries field - [JSON Schema](json-schema/schema.json) - [Changelog](./CHANGELOG.md) @@ -21,41 +21,33 @@ This is the place to add a short introduction. The fields in the table below can be used in these parts of STAC documents: - [ ] Catalogs -- [x] Collections +- [ ] Collections - [x] Item Properties (incl. Summaries in Collections) -- [x] Assets (for both Collections and Items, incl. Item Asset Definitions in Collections) +- [ ] Assets (for both Collections and Items, incl. Item Asset Definitions in Collections) - [ ] Links | Field Name | Type | Description | | -------------------- | ------------------------- | -------------------------------------------- | -| template:new_field | string | **REQUIRED**. Describe the required field... | -| template:xyz | [XYZ Object](#xyz-object) | Describe the field... | -| template:another_one | \[number] | Describe the field... | +| sst:statistics | [Statistics Object](#statistics-object) | **REQUIRED**. Object providing the precipitaion accumulation minimum, mean, and maximum values with units specified, along with the count of gridded AORC cells used to produce the statistics and optionally the normalized mean (AORC mean divided by ATLAS14 mean)| ### Additional Field Information -#### template:new_field +#### sst:statistics -This is a much more detailed description of the field `template:new_field`... +This is a much more detailed description of the field `sst:statistics`... -### XYZ Object +### Statistics Object -This is the introduction for the purpose and the content of the XYZ Object... +This is the introduction for the purpose and the content of the Statistics Object... | Field Name | Type | Description | | ---------- | ------ | -------------------------------------------- | -| x | number | **REQUIRED**. Describe the required field... | -| y | number | **REQUIRED**. Describe the required field... | -| z | number | **REQUIRED**. Describe the required field... | +| min | number | **REQUIRED**. Describe the required field... | +| mean | number | **REQUIRED**. Describe the required field... | +| max | number | **REQUIRED**. Describe the required field... | +| count | integer| **REQUIRED**. Describe the required field... | +| normalized_mean | number | Describe the optional field... | -## Relation types - -The following types should be used as applicable `rel` types in the -[Link Object](https://github.com/radiantearth/stac-spec/tree/master/item-spec/item-spec.md#link-object). - -| Type | Description | -| -------------- | ------------------------------------- | -| fancy-rel-type | This link points to a fancy resource. | ## Contributing @@ -67,10 +59,10 @@ for running tests are copied here for convenience. ### Running tests -The same checks that run as checks on PR's are part of the repository and can be run locally to verify that changes are valid. +The same checks that run as checks on PR's are part of the repository and can be run locally to verify that changes are valid. To run tests locally, you'll need `npm`, which is a standard part of any [node.js installation](https://nodejs.org/en/download/). -First you'll need to install everything with npm once. Just navigate to the root of this repository and on +First you'll need to install everything with npm once. Just navigate to the root of this repository and on your command line run: ```bash npm install