Create metadataFormat.adoc

metadataFormat/metadataFormat.adoc

@@ -0,0 +1,117 @@
+[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.
+OG1.0.json defines some metadata and definitions (align with OG1.O ToR), as described in this document. Other types of metadata not framed by OG1.0.json can be included in OG1.0.josn metadata files. No control will be applied to those measurements.
+
+= 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.
+
+[%"header",cols="1,3,1,2a"]
+|====
+|*Global attribute* |*Definition* |*Requirement status* |*Format, fixed value or example*
+| id | Formatted mission name: <platform_serial>_<start_date>_<data_mode> | mandatory | **ex.:**
+
+* unit_1032_20230512T001245_delayed
+* sea008_20180715T012451_delayed
+* sp032_20150923T150451_R
+* sg041_20381221T000032_R
+| program | The overarching program(s) of which the dataset is a part. A program consists of a set (or portfolio) of related and possibly interdependent projects that meet an overarching objective. | Highly desirable | **ex:** NorGlider - NorEmso
+| network | A network is a group of platforms crossing the boundaries of a single program. It can represent a mutual scientific objective, a geographical focus, an array and/or a project. Multiple networks shall be separated by commas. | suggested | **ex.:** Boundary Ocean Observing Network (BOON), Mediterranean Ocean Observing Systems for the Environment (MOOSE), OceanGliders Water Transformation task team
+| project | The name of the project(s) principally responsible for originating this data. Multiple projects can be separated by commas. | suggested | **ex.:** "Biogeochemical processes and ecosystem function in changing polar systems and their global impacts (BIPOLE)"
+| comment | Miscellaneous information about the data or methods used to produce it. | suggest | **ex.:** "deployment and recovery in Skagerrak"
+| title | A short phrase or sentence describing the dataset. | mandatory | **ex.:** "OceanGliders trajectory file"
+| institution | The name of the institution where the original data was produced | highly desirable | **ex.:** "C-PROOF; Univserity of Victoria"
+| contributing_institution | Name of institutions involved in the glider mission. Multiple institutions are separated by commas. | Operator is mandatory | **ex.:** "Rutgers University, US IOOS, US IOOS, NOAA "
+| contributing_institution_role | Role of the institutions involved in the glider mission. Multiple institutions' roles are separated by a comma. | Operator is mandatory | **ex.:** "operator, data assembly center, global data assembly centre, funding agency"
+| contributing_institution_vocabulary | controlled vocabulary of the institution involved in the glider mission. Multiple ids are separated by a comma. | Highly suggested | **ex.:** "https://edmo.seadatanet.org/report/1435, https://edmo.seadatanet.org/report/3853, https://edmo.seadatanet.org/report/3853, https://edmo.seadatanet.org/report/4755"
+| contributors_name | Name of the contributors to the glider mission. Multiple contributors are separated by commas. | PI name is mandatory | **ex.:** "Louise Biddle, Callum Rolo"
+| contribtors_role | Role of the contributors to the glider mission. Multiple contributors’ roles are separated by commas. | PI is mandatory | **ex.:** "principal investigator, "
+| contributor_email | Email of the contributors to the glider mission. Multiple contributors' emails are separated by commas. | PI email is mandatory |  **ex.:** "louise.biddle@voiceoftheocean.org, callum.rolo@voiceoftheocean.org"
+| contributor_id | Unique id of the contributors to the glider mission. Multiple contributors’ ids are separated by commas.  | highly desirable | **ex.:** "https://orcid.org/0000-0002-4785-1959, "
+| data_url | A URL link to the source of this OG1.0 data file. | mandatory | https://linkedsystems.uk/erddap/files/Public_OG1_Data_001/Kelvin_20231205/Kelvin_620_R.nc
+| internal_mission_identifier | The mission identifier used by the institution principally responsible for originating this data | highly desirable | **ex.:** "Forster20201109" - "Estoc_2015_01"
+| doi | The digital object identifier of the OG1.0 data file | highly desirable | 
+| date_created | date of creation of this data set | mandatory | **format:** iso 8601
+
+|====
+
+= platform attribute
+The following attributes should appear in the platform attribute section of the OG1.O.json.
+
+[%"header",cols="1,3,1,2a"]
+|====
+|*Global attribute* |*Definition* |*Requirement status* |*Format, fixed value or example*
+| manufacturer | glider manufacturer | suggested | **ex.:** "Teledyne Webb Research"
+| platform_model | model of the glider | mandotory | **ex.:** "Slocum G2" 
+| platfrom_serial_number | "glider serial number. The platform serial should be constructed from the manufacturer prefix and the platform serial number | mandatory | **ex.:** "sea001" (seaglider), unit001 (slocum), sea001 (seaexplorer), sp001 (spray).
+| platform_depth_rating | depth limit in meters of the glider for this mission (positive value expected) | highly desirable | **ex.:** "100";
+| platform_name | Local or nickname of the glider" | mandatory | *ex.*: "platform_name":"orca" - "sverdrup" - "g638"
+| wmo_indentifier | WMO id | mandatory | **ex.:** “6800980“
+
+|====
+
+= deployment attribute
+The following attributes should appear in the deployment attribute section of the OG1.O.json.
+
+[%"header",cols="1,3,1,2a"]
+|====
+|*Global attribute* |*Definition* |*Requirement status* |*Format, fixed value or example*
+| site | The name of the regular sample line or area.| highly desirable | **ex.:** "Canales"
+| deployment time | date of deployment (iso 8601) | mandatory | **Format:** "YYYYmmddTHHMMss"
+
+**ex.:** "20240425T145805"
+
+| deployment_latitude | latitude of deployment | mandatory | **format:** "decimal degree" 
+
+**ex.:** "-45.654"
+
+| deployment_longitude | longitude of deployment | mandatory | **ex.:**  **format:** "decimal degree" 
+
+**ex.:** "-179.56"
+
+|====
+
+= sensor attribute
+The following attributes should appear in the sensor attribute section of the OG1.O.json.
+
+[%"header",cols="1,3,1,2a"]
+|====
+|*Global attribute* |*Definition* |*Requirement status* |*Format, fixed value or example*
+| sensor_type | type of the sensor | highly desirable | **ex.:** "CTD"
+| sensor_maker | sensor manufacturer of the sensor | highly desirable | **ex.:** "Sea-Bird Scientific"
+| sensor_model |  model of the sensor | mandatory | **ex.:** "SBE 41 CTD"
+| sensor_serial_number | serial number of the sensor  | highly desirable | **ex.:** "0865"
+| sensor_calibration_date | calibration date of the sensor  | highly desirable | **format:** iso 8601 - YYYYMMDD
+
+**ex.:** "20210412"
+
+|====
+
+*TO BE REORGANIZED*
+