Skip to content

DACCS-Climate/marble-stac-extension

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

12 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Marble Platform Extension Specification

This document explains the Marble Platform specific extension to the SpatioTemporal Asset Catalog (STAC) specification. It adds fields that describe the location of data on the Marble Network/Platform.

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
marble:host_node string REQUIRED. Name of the Marble node hosting the data
marble:is_local boolean REQUIRED. Whether this data is local on the node being searched

Additional Field Information

marble:host_node

This is a controlled vocabulary and the values can be one of the host IDs (not its display name or some other identifier) currently available in the Marble node registry.

marble:is_local

If true, it means that the data is locally available on the node where the search is being performed. If false, it means the data is available on another federated node.

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

Schema describing Marble Platform specific information

Resources

License

Stars

Watchers

Forks

Packages

No packages published