Skip to content

stac-extensions/sentinel-5p

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

6 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Sentinel-5P Extension Specification

This document explains the Sentinel-5P Extension to the SpatioTemporal Asset Catalog (STAC) specification.

Caution

The intention of the first version of the specification was to reflect the existing behavior of the properties prefixed with s5p as implemented by the stactools-sentinel5p package. The following version deprecated most of the fields in favor of other extensions that are not specific to Sentinel-5P. The remaining fields can be used if providers think they offer additional value to users. For all other fields the recommended alternatives should be preferred.

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
s5p:processing_mode string One of: NRTI, OFFL, RPRO
s5p:collection_identifier string One of: 01, 02, 03

Note

Various fields and objects in this extensions have been deprecated. Please see the document about deprecated fields for more information.

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