Skip to content

Metadata

Metadata

The top-level component metadata contains meta-information related to the creation of the file. The component hs3_version stores the HS\(^3\) version and is required for now. Overview of the components:

  • hs3_version: (required) HS\(^3\) version number as String for reference
  • packages: (optional) array of structs defining packages and their version number used in the creation of this file, depicted with the components name and version respectively
  • authors: (optional) array of authors, either individual persons, or collaborations
  • publications: (optional) array of document identifiers of publications associated with this file
  • description: (optional) short abstract/description for this file
Example: Metadata
"metadata" : { 
  "hs3_version" : "0.2.0", 
  "packages" : [ { "name": "ROOT", "version": "6.28.02" } ], 
  "authors": ["The ATLAS Collaboration", "The CMS Collaboration"], 
  "publications": ["doiABCDEFG"]
}