Skip to content

Commit

Permalink
NOAA MRMS QPE extension moved from stactools package repo
Browse files Browse the repository at this point in the history
  • Loading branch information
m-mohr committed Oct 24, 2022
1 parent 4a0c2e5 commit 9421140
Show file tree
Hide file tree
Showing 6 changed files with 346 additions and 185 deletions.
7 changes: 6 additions & 1 deletion CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,4 +16,9 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0

### Fixed

[Unreleased]: <https://github.com/stac-extensions/template/compare/v1.0.0...HEAD>
## [v1.0.0]

- Initial release

[Unreleased]: <https://github.com/stac-extensions/noaa-mrms-qpe/compare/v1.0.0...HEAD>
[v1.0.0]: <https://github.com/stac-extensions/noaa-mrms-qpe/tree/v1.0.0>
49 changes: 12 additions & 37 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,14 +1,14 @@
# Template Extension Specification
# NOAA MRMS QPE Extension Specification

- **Title:** Template
- **Identifier:** <https://stac-extensions.github.io/template/v1.0.0/schema.json>
- **Field Name Prefix:** template
- **Title:** NOAA MRMS QPE
- **Identifier:** <https://stac-extensions.github.io/noaa-mrms-qpe/v1.0.0/schema.json>
- **Field Name Prefix:** noaa_mrms_qpe
- **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**: @m-mohr

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 NOAA MRMS QPE Extension to the
[SpatioTemporal Asset Catalog](https://github.com/radiantearth/stac-spec) (STAC) specification.

- Examples:
- [Item example](examples/item.json): Shows the basic usage of the extension in a STAC Item
Expand All @@ -25,36 +25,11 @@ The fields in the table below can be used in these parts of STAC documents:
- [x] 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... |

### Additional Field Information

#### template:new_field

This is a much more detailed description of the field `template:new_field`...

### XYZ Object

This is the introduction for the purpose and the content of the XYZ 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... |

## 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. |
| Field Name | Type | Description |
| -------------------- | ------- | ----------- |
| noaa_mrms_qpe:pass | integer | **REQUIRED**. The pass number: `1` = less latency, but less gauges; `2` = more latency, but more gauges. |
| noaa_mrms_qpe:period | integer | **REQUIRED**. The number of hours of the accumulations. One of: `1`, `3`, `6`, `12`, `24`, `48`, `72` |
| noaa_mrms_qpe:region | string | **REQUIRED**. The region of the data. One of: `CONUS` (Continental US), `HAWAII`, `GUAM`, `ALASKA`, `CARIB` (Caribbean Islands) |

## Contributing

Expand Down
199 changes: 150 additions & 49 deletions examples/collection.json
Original file line number Diff line number Diff line change
@@ -1,73 +1,174 @@
{
"type": "Collection",
"id": "noaa-mrms-qpe-24h-pass2",
"stac_version": "1.0.0",
"description": "The Multi-Radar Multi-Sensor (MRMS) quantitative precipitation estimation (QPE) product is generated fully automatically from multiple sources to generate seamless, hourly 1 km mosaics over the US.\n\n**Note:** The data for Guam and the Caribbean Islands are [not multi-sensor products](https://vlab.noaa.gov/documents/96675/666999/MS_DomainDiffernces.png) yet.\n\nThis is the 24-hour pass 2 product with more latency (120 min), but more gauges (99 %).",
"links": [
{
"rel": "item",
"href": "./item-conus.json",
"type": "application/geo+json",
"title": "CONUS_MRMS_MultiSensor_QPE_24H_Pass2_00.00_20220702-110000"
},
{
"rel": "item",
"href": "./item-guam.json",
"type": "application/geo+json",
"title": "GUAM_MRMS_MultiSensor_QPE_24H_Pass2_00.00_20220704-140000"
},
{
"rel": "root",
"href": "./collection.json",
"type": "application/json",
"title": "NOAA MRMS QPE 24-hour Pass 2"
},
{
"rel": "license",
"href": "https://www.nssl.noaa.gov/projects/mrms/nmq_data_policy_OGCrevised.pdf",
"type": "application/pdf",
"title": "MRMS Dataset Sharing Policy"
},
{
"rel": "about",
"href": "https://mrms.nssl.noaa.gov",
"type": "text/html",
"title": "MRMS Homepage"
},
{
"rel": "about",
"href": "https://vlab.noaa.gov/web/wdtd/-/multi-sensor-qpe-1?selectedFolder=9234881",
"type": "text/html",
"title": "MRMS QPE Technical Product Guide"
},
{
"rel": "self",
"href": "https://raw.githubusercontent.com/stactools-packages/noaa-mrms-qpe/main/examples/collection.json",
"type": "application/json"
}
],
"stac_extensions": [
"https://stac-extensions.github.io/item-assets/v1.0.0/schema.json",
"https://stac-extensions.github.io/template/v1.0.0/schema.json"
"https://stac-extensions.github.io/noaa-mrms-qpe/v1.0.0/schema.json",
"https://stac-extensions.github.io/raster/v1.1.0/schema.json",
"https://stac-extensions.github.io/item-assets/v1.0.0/schema.json"
],
"type": "Collection",
"id": "collection",
"title": "A title",
"description": "A description",
"license": "Apache-2.0",
"item_assets": {
"cog": {
"roles": [
"data",
"cloud-optimized"
],
"type": "image/tiff; application=geotiff; profile=cloud-optimized",
"raster:bands": [
{
"spatial_resolution": 1000,
"unit": "mm",
"data_type": "float64"
}
],
"title": "Processed Cloud-Optimized GeoTiff file"
},
"grib2": {
"roles": [
"data",
"source"
],
"type": "application/wmo-GRIB2",
"raster:bands": [
{
"spatial_resolution": 1000,
"unit": "mm",
"data_type": "float64"
}
],
"title": "Original GRIB2 file"
}
},
"title": "NOAA MRMS QPE 24-hour Pass 2",
"extent": {
"spatial": {
"bbox": [
[
172.9,
1.3,
173,
1.4
-176.0,
9.0,
150.0,
72.0
],
[
-130.0,
20.0,
-60.0,
55.0
],
[
-164.0,
15.0,
-151.0,
26.0
],
[
140.0,
9.0,
150.0,
18.0
],
[
-176.0,
50.0,
-126.0,
72.0
],
[
-90.0,
10.0,
-60.0,
25.0
]
]
},
"temporal": {
"interval": [
[
"2015-06-23T00:00:00Z",
"2022-07-01T00:00:00Z",
null
]
]
}
},
"template:new_field": "test",
"template:xyz": {
"x": 1,
"y": 2,
"z": 3
},
"template:another_one": [
1,
2,
3
"license": "proprietary",
"keywords": [
"NOAA",
"MRMS",
"QPE",
"multi-radar",
"multi-sensor",
"precipitation",
"24-hour",
"GRIB2",
"COG"
],
"assets": {
"example": {
"href": "https://example.com/examples/file.xyz",
"template:new_field": "test"
}
},
"item_assets": {
"data": {
"providers": [
{
"name": "NOAA National Severe Storms Laboratory",
"roles": [
"data"
"producer",
"licensor"
],
"template:new_field": "test"
"url": "https://www.nssl.noaa.gov/projects/mrms"
}
},
],
"summaries": {
"datetime": {
"minimum": "2015-06-23T00:00:00Z",
"maximum": "2019-07-10T13:44:56Z"
}
},
"links": [
{
"href": "https://example.com/examples/collection.json",
"rel": "self"
},
{
"href": "https://example.com/examples/item.json",
"rel": "item"
}
]
}
"noaa_mrms_qpe:pass": [
2
],
"noaa_mrms_qpe:period": [
24
],
"noaa_mrms_qpe:region": [
"CONUS",
"HAWAII",
"GUAM",
"ALASKA",
"CARIB"
]
}
}
Loading

0 comments on commit 9421140

Please sign in to comment.