FAIRiCUB Extension Specification

• Title: FAIRiCUBE
• Identifier: https://fairicube.github.io/fairicube/v1.2.0/schema.json
• Field Name Prefix: fairicube
• Scope: Item
• Extension Maturity Classification: Proposal
• Owner: @baloola

This document explains the Fairicube Extension to the SpatioTemporal Asset Catalog (STAC) specification. This is the place to add a short introduction.

• Examples:
  • Item example: Shows the basic usage of the extension in a STAC Item
• JSON Schema
• Changelog

Fields

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

• Item Properties (incl. Summaries in Collections)
• Assets (for Items, incl. Item Asset Definitions in Collections)
• Bands
• Data Cube Dimensions

Field Name	Type	Description
fairicube:purpose	string	Describes the project's purpose which the resource was created for.
fairicube:source_type	string	The type of the original data (e.g grid, vector)
fairicube:quality_measures	string	The applied quality measures on data (standardised calibration, repeated samples or measurements, data capture, data entry validation, peer review of data, or representation with controlled vocabularies)
fairicube:definition	string	A semantic definition (or link) for the supplied dataset (what measurements are represented eg. velocity)
fairicube:comment	string	Any helpful comments about the dataset e.g. processing details for processors and producers
fairicube:interpolation	string	The method which has been applied for Interpolation / aggragation (NA, nearest, spline, etc.)

Relation types

The following types should be used as applicable rel types in the Link Object.

Type	Description
measurement-method	A URL to a workflow, protocol, plan, algorithm, or computational method specifying how create a value.

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