Skip to content

Commit

Permalink
Create metadataFormat.adoc
Browse files Browse the repository at this point in the history
Following issue #75 and anticipating on OG1.0 format delivery. I am proposing here a metadata file that will agregate all metadata into a json file, easy to read and very usefull for monitoring (amongst other thing).

This is a practice adopted by Argo with very good results in terms of monitoring.

This is to be discussed amongst each other and not to be tackle before the iugc2024.
  • Loading branch information
vturpin authored May 17, 2024
1 parent b0b1424 commit 3c87b03
Showing 1 changed file with 32 additions and 0 deletions.
32 changes: 32 additions & 0 deletions metadataFormat/metadataFormat.adoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,32 @@
[cols=",",options="header",]
|===========================================================================================
|https://www.oceangliders.org/[image:figures/image1.png[image,width=164,height=144]] a|
OceanGliders 1.0 format - metadata format +

Navigation: +

https://github.com/OceanGlidersCommunity/OG-format-user-manual[GitHub repository] +
https://oceangliderscommunity.github.io/OG-format-user-manual/OG_Format.html[Terms of reference] +
https://oceangliderscommunity.github.io/OG-format-user-manual/vocabularyCollection/tableOfControlledVocab.html[Vocabulary collections] +

|===========================================================================================

////
* [[Metadata format]]
////
= General information
The metadata format of OceanGliders (here after OG1.0.json) should be deliver by DACs along with OceanGliders trajectory files.
OG1.0.json metadata file contains descriptive information about an glider mission.
= File naming convention
OG1.0.json follow the file naming convention of the OG1.0.nc trajectory files. Metadata files should be named as follows:

- "<id>.json" (ex : "sp065_20210616T143025.json")

Where <id> = "<platform_serial>_<start_date>" (ex : "sp065_20210616T143025.json")

= File header
"0G_metadata_format_version": "1.0",

= Global attribute
The following attributes should appear in the global attribute section of the OG1.O.json.

0 comments on commit 3c87b03

Please sign in to comment.