Skip to content

stac-extensions/noaa-mrms-qpe

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

3 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

NOAA MRMS QPE Extension Specification

This document explains the NOAA MRMS QPE Extension to the SpatioTemporal Asset Catalog (STAC) specification.

Fields

The fields in the table below can be used in these parts of STAC documents:

  • Catalogs
  • Collections
  • Item Properties (incl. Summaries in Collections)
  • Assets (for both Collections and Items, incl. Item Asset Definitions in Collections)
  • Links
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

All contributions are subject to the STAC Specification Code of Conduct. For contributions, please follow the STAC specification contributing guide Instructions 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. To run tests locally, you'll need npm, which is a standard part of any node.js installation.

First you'll need to install everything with npm once. Just navigate to the root of this repository and on your command line run:

npm install

Then to check markdown formatting and test the examples against the JSON schema, you can run:

npm test

This will spit out the same texts that you see online, and you can then go and fix your markdown or examples.

If the tests reveal formatting problems with the examples, you can fix them with:

npm run format-examples

About

STAC Extension for NOAA MRMS QPE (Multi-Radar Multi-Sensor Quantitative Precipitation Estimation) products

Resources

License

Stars

Watchers

Forks

Packages

No packages published