| <- [[software:gplates:grot:start|GROT File format description]]  | -> [[software:gplates:grot:examplefiles|Rotation file example]] |

----

===== GPlates GROT Format attribute list =====

This is a list of all available GPlates GROT key:value pairs.

==== File header attribute list ====


  * Mandatory: Declaration of file type
  * Written by GPlates: Declaration of file version number
  * Written by GPlates: URL of standard specification (this document)

=== Dublin core metadata ===

  * All Dublin Core elements are prefixed with a ''@DC''

^ Attribute name ^ Definition ^ Example ^
| ** Dublin Core metadata ** |||
|''@DC:namespace''          | :!: Mandatory: Dublin Core Elements RDF schema link.   | Value: ''[[http://purl.org/dc/elements/1.1/]]''  |
|''@DC:title''              | Title of the document |  ''GPlates rotation file - NEWROTATION FORMAT SAMPLE FILE'' .      |
|''@DC:creator:name''       | :!: Mandatory  Name of the creator of the document. Multiple occurrences of attribute allowed      | Example: ''Odd Name'' |
|''@DC:creator:email''      | :!: Mandatory  Email of the document creator. Multiple occurrences of attribute allowed.           | Example: ''odd.name@example.com''. |
|''@DC:creator:url''        | Mandatory URL related to creator such as homepage. Multiple occurrences of attribute allowed. | Example ''http://www.example.com/people/odd'' . |
|''@DC:creator:affiliation''| Mandatory Affiliation of creator, such as Institute, postal address, phone. Multiple occurrences of attribute allowed. | Example: ''EarthByte Research Group, School of Geosciences'' . |
|''@DC:rights:license''     | Mandatory: Appropriate licensingterms for the data included in the file. | Example: ''Attribution-ShareAlike 3.0 Unported (CC BY-SA 3.0)'' . |
|''@DC:rights:url''         | Mandatory: URI of licensing terms for the data. | Example: ''[[http://creativecommons.org/licenses/by-sa/3.0/]]'' . |
|''@DC:date:created''       | Mandatory: Creation date of document, follow ISO standard (ie [YYYY]-[MM]-[DD] T[hh]:[mm]:[ss]). | Example ''2011-06-01T09:08:05'' . |
|''@DC:date:modified''      | Optional: Latest modification date of document. Multiple occurrences of attribute allowed. Can hold revision date if under revision control. | Example ''Date: 2012-05-08 16:55:58 +1000 (Tue, 08 May 2012)'' . |
|''@DC:coverage:temporal''    | Optional: Temporal coverage of data includedin this file. | Example ''0-600 Ma'' . |
|''@DC:bibliographicCitation''|  Optional: Full, plain text bibliographiccitation for the current file. | Example: ''Mueller, R.D. and Seton, M. and Roest, W. (2008): Global. Geochem., Geophys., Geosys. xx:'' . |
|''@DC:description''          |  Mandatory: Description of data set contained in this file. Multiline comment wrapped in triple quotation marks """ (like in Python) are allowed, as are multiple ocurrences of the attribute to mimick the same effect as for multiline value. | Example: ''A sample rotation file in the new GPlates rotation file format v1.1''|
|''@DC:contributor'' | Mandatory: Author data attribute for every contributor to this file. Data needs to be split into at least **5 different fields separated by vertical bars (''|'')**: (1) ''ID'' -- Unique ID for contributor (e.g. "FOOB" for "Foo Bar"), this maps to the ''@AU'' tag in rotation sequence comments; ''Real Name'' – of contributor (Odd Name); ''Email'' -- Email of contributor; ''URL''-- Website of contributor; ''Institute'', Postal address, other contact details for contributor. Fields can be left blank. |

=== Supplementary header information ===

|''@REVISIONHIST'' | Optional. Parent attribute for data which is under a revisioning system. User can generate child attributes by separating them with a colon ('':'') from the parent tag. | Example:  |
|''@BIBINFO'' | Optional. Parent attribute for bibliographic reference data related to this rotation file | |
|''@BIBINFO:bibliographyfile'' | Optional. URI for location of bibliographic reference data in BibTeX format. | Example: ''rotationfile_1-0.bib'' |
|''@BIBINFO:doibase''       | Mandatory. URL for resolving DOIs used in thebibliographic data. | Default: ''[[https://doi.org/]]'' |
|''@GPML'' | Parent attribute for GPGIM-derived attributes | | 
|''@GPML:namespace'' | Mandatory. URI for the locationof the GPGIM Schema document. | Currently: ''[[http://www.earthbyte.org/Resources/GPGIM/stable/]]'' | 
|''@GEOTIMESCALE'' | Mandatory. Bibliographic data for individual time scales used. Data is split into at least 3 fields, separated by vertical bars (''|'') and can extend over multiple lines using the triple quotation marks. These are 1) ''ID'' -- unique ID of timescale to be used in the ''@GTS'' tag for the individual rotation sequences. 2) ''DOI''/''URL''/''ISSN'' -- Unique identifier for publication the timescale is based upon, prefixing the actual values (like ''doi:12.12312/991823''); 3) Plain text full bibliographic reference for timescale or comments. |


==== Rotation sequence metadata ====

The rotation sequence metadata attribute //aliases// apply to both, the MPRS header segment as well as individual lines.

^ Attribute name ^  ^ Definition ^ Example ^
|''@REF'' | Optional | Unique citation key of bibliographic data used forthis rotation. Maps to entries specified in ''@BIBINFO:bibfile'' value.| |
|''@DOI''| Alias Optional. Digitial object identifier for bibliographicdata used for this rotation. Maps to entries specified in ''@BIBINFO:doibase'' value for complete a valid URL.  | |
|''@AU'' | Alias Optional. Author of rotation sequence data, maps tofirst field of ''@DC:contributor'', which is the unique contributor ID. | Example: ''@AU"ODDNAME"''. |
|''@CHRONID'' | Alias for Magnetic anomaly chrons as specified in GPGIM. | |
| ''GTS''      | Alias optional | ''GEOTIMESCALE:id''| |



=== Moving plate rotation sequences ===

^ Attribute name ^  ^ Definition ^ Example ^
|''@MPRS'' | | Parent element for Moving Plate rotation sequence | |
|''@MPRS:id'' | :!: Mandatory | Moving Plate ID. Denotes the start of a block of rotations which all belong to a single moving plate. |Example ''@MPRS:pid"801"'' |
|''@MPRS:code'' | :!: Mandatory | Unique letter acronym (variable length) fora moving plate. |Example ''@MPRS:code"SAM"'' for South America. |
|''@MRPS:name'' | :!: Mandatory | Unique full name for moving plate. |Example: ''@MPRS:name"South America'' |
|''@PP'' | :!: Mandatory | Plate pair of moving plate–fixed plate as specified by plate IDs, allowed values can only be composed of valid ''@MPRS:code'' values. | Example ''@PP:SAM-AFR'' for rotations expressing the rotation between South America relative to Africa. |
|''@T'' | Optional | Modification time stamp for rotation sequence data.Adhere to ISO standards in the for of ''YYYY-MM-DD [HH:MM:SS TZ ]'' | Example: ''2012-05-04 10:30:22+10'' |
|''@C'' | Optional | Freeform comment. | Example: ''@C"This rotation needs further checks"'' |
|''@GTS'' | :!: Mandatory | Geological time scale ID. Maps to first field of ''@GTS:id'' which is the unique identifier for the timescale used. | | 
|''@GPML:MagneticAnomalyIdentification:AnomalyPickID'' | Magnetic anomaly pick ID | |

=== Hellinger parameter group ===

^ Attribute name ^  ^ Definition ^ Example ^
|''@HELL'' | Parent element for Hellinger statistical fit parameters. | | 
|''@HELL:r'' | Total misfit | | 
|''@HELL:Ns'' | Number of data points and segment length. | |
|''@HELL:dF'' | Number of degrees of freedom. | |
|''@HELL:kappahat'' | Quality factor κ^ | |
|''@HELL:cov''| Covariance matrix, here we ONLY USE ''((x1 ,x2 ,x3 )(y2 ,y3 )(z3 ))'' due to the rotational symmetry of the matrix used. | |


----


| <- [[software:gplates:grot:start|GROT File format Description]]  | -> [[software:gplates:grot:examplefiles|Rotation file example]] |

{{tag> GPlates Rotations Fileformat}}