From 21734e1e03c292c917c9f4a0f29c73417fbf23ce Mon Sep 17 00:00:00 2001 From: Victor Turpin Date: Thu, 25 Apr 2024 15:03:55 +0200 Subject: [PATCH] Create tableOfControlledVocab.adoc (#162) * Create tableOfControlledVocab.adoc Create the vocabulary section * Update tableOfControlledVocab.adoc * Update tableOfControlledVocab.adoc * Update tableOfControlledVocab.adoc * Update tableOfControlledVocab.adoc * Update tableOfControlledVocab.adoc * Update tableOfControlledVocab.adoc * Update tableOfControlledVocab.adoc * Update tableOfControlledVocab.adoc * Update tableOfControlledVocab.adoc * Update tableOfControlledVocab.adoc * Update tableOfControlledVocab.adoc * Update tableOfControlledVocab.adoc * Update tableOfControlledVocab.adoc * Update tableOfControlledVocab.adoc * Update tableOfControlledVocab.adoc * Update tableOfControlledVocab.adoc * Update README.md * Update README.md * Update README.md * Update adoc_build.yml Change Main to vturpin-patch-3-Vocab branch Change name of file to build * Create test_adoc_build.yml storing the test I did trying to build the vocab doc. * Update test_adoc_build.yml my test * Create test_adoc_build.yml test in the right repo * Delete .github/test_adoc_build.yml * Update adoc_build.yml * Update tableOfControlledVocab.adoc * Update tableOfControlledVocab.adoc * Update tableOfControlledVocab.adoc * Update tableOfControlledVocab.adoc * Update tableOfControlledVocab.adoc * Update tableOfControlledVocab.adoc * Create sensorModel.md * Update tableOfControlledVocab.adoc add the link to platform collection * Create contributors_role.md create table * Update tableOfControlledVocab.adoc * Update tableOfControlledVocab.adoc * Update tableOfControlledVocab.adoc * Create agencies_role * Update contributors_role.md * Update agencies_role * Update tableOfControlledVocab.adoc * Update and rename agencies_role to agencies_role.md * Update tableOfControlledVocab.adoc * Create rtqc_method.md * Update tableOfControlledVocab.adoc * Create platform_type.md * Update tableOfControlledVocab.adoc * Create platform_model.md * Update platform_model.md * Update platform_type.md * Update platform_model.md * Update platform_model.md * Update tableOfControlledVocab.adoc * Update tableOfControlledVocab.adoc * Create platform_maker.md * Update platform_maker.md * Update tableOfControlledVocab.adoc * Update tableOfControlledVocab.adoc * Create battery_type.md * Update platform_maker.md * Update and rename sensorModel.md to sensor_model.md * Update battery_type.md * Update tableOfControlledVocab.adoc * Create telecom_type.md * Update tableOfControlledVocab.adoc * Create tracking_system.md * Update tableOfControlledVocab.adoc * Create data_mode.md * Update tableOfControlledVocab.adoc * Create phase.md * Update tableOfControlledVocab.adoc * Update tableOfControlledVocab.adoc * Update tableOfControlledVocab.adoc * Update tableOfControlledVocab.adoc * Create variable_names.md * Delete .github/workflows/test_adoc_build.yml * Update OG_Format.adoc Move to section on vocab instead of a github page align with latest version of OG1.0 (step back from groups) * Update OG_Format.adoc remove logo * Update OG_Format.adoc link og variable vocab at NVS * Update OG_Format.adoc * Update OG_Format.adoc * Update README.md remove link to github page for vocab; Now vocab is a section in the OG.adoc * Update tableOfControlledVocab.adoc * Update tableOfControlledVocab.adoc-clarity Made more clear that we have a set of collection (written as if we had a collection of collections making language unclear) * Update contributors_role.md-clarity grammar and consistency * Update battery_type.md lower case for all * Update agencies_role.md-consistency use lower case for all, grammar, clarity * Update README.md-grammar * Update README.md-clarity * Update OG_Format.adoc-float references removed * Update rtqc_method.md add link to UEA RTQC toolbox * aligning with Emma.adoc Aligning with Emma's version - step1 * Update tableOfControlledVocab.adoc Align with EMMA suggestion - step 2 Add the exemplars * Update tableOfControlledVocab.adoc Continuing this effort - STEP 3 * Update tableOfControlledVocab.adoc * Update tableOfControlledVocab.adoc * Update rtqc_method.md * Update rtqc_method.md * Update tableOfControlledVocab.adoc * Update tableOfControlledVocab.adoc * Update tableOfControlledVocab.adoc * Update tableOfControlledVocab.adoc * Update tableOfControlledVocab.adoc * Update tableOfControlledVocab.adoc * Update tableOfControlledVocab.adoc * Update tableOfControlledVocab.adoc * Update rtqc_method.md * Update tableOfControlledVocab.adoc * Update tableOfControlledVocab.adoc * Update tableOfControlledVocab.adoc * Create serial_number_prefix.md * Update serial_number_prefix.md * Update tableOfControlledVocab.adoc * Update tableOfControlledVocab.adoc * Update and rename serial_number_prefix.md to platform_serial_number_prefix.md * Update tableOfControlledVocab.adoc --------- Co-authored-by: Daniel Hayes <91136952+glidermann@users.noreply.github.com> Co-authored-by: Callum Rollo --- OG_Format.adoc | 528 ++++++++++-------- README.md | 2 +- vocabularyCollection/agencies_role.md | 6 + vocabularyCollection/battery_type.md | 8 + vocabularyCollection/contributors_role.md | 10 + vocabularyCollection/data_mode.md | 7 + vocabularyCollection/phase.md | 9 + vocabularyCollection/platform_maker.md | 11 + vocabularyCollection/platform_model.md | 16 + .../platform_serial_number_prefix.md | 6 + vocabularyCollection/platform_type.md | 4 + vocabularyCollection/rtqc_method.md | 9 + vocabularyCollection/sensor_model.md | 2 + .../tableOfControlledVocab.adoc | 147 +++++ vocabularyCollection/telecom_type.md | 6 + vocabularyCollection/tracking_system.md | 6 + vocabularyCollection/variable_names.md | 2 + 17 files changed, 531 insertions(+), 248 deletions(-) create mode 100644 vocabularyCollection/agencies_role.md create mode 100644 vocabularyCollection/battery_type.md create mode 100644 vocabularyCollection/contributors_role.md create mode 100644 vocabularyCollection/data_mode.md create mode 100644 vocabularyCollection/phase.md create mode 100644 vocabularyCollection/platform_maker.md create mode 100644 vocabularyCollection/platform_model.md create mode 100644 vocabularyCollection/platform_serial_number_prefix.md create mode 100644 vocabularyCollection/platform_type.md create mode 100644 vocabularyCollection/rtqc_method.md create mode 100644 vocabularyCollection/sensor_model.md create mode 100644 vocabularyCollection/tableOfControlledVocab.adoc create mode 100644 vocabularyCollection/telecom_type.md create mode 100644 vocabularyCollection/tracking_system.md create mode 100644 vocabularyCollection/variable_names.md diff --git a/OG_Format.adoc b/OG_Format.adoc index 4d412500..d7c79907 100644 --- a/OG_Format.adoc +++ b/OG_Format.adoc @@ -127,17 +127,15 @@ The global attribute section is used for data discovery. The following global at |*Global attribute* |*Definition* |*Requirement status* |*Format, fixed value or example* |title |A short phrase or sentence describing the dataset. |mandatory |ex.: “OceanGliders trajectory file” |platform a| -Category of the platform that supported the sensor data used to create this data set or product. +Name of the platform(s) that supported the sensors data used to create this data set or product. -It is common to any OceanGliders data sets and define by platform_vocabulary. +https://vocab.nerc.ac.uk/collection/L06/current/[_https://vocab.nerc.ac.uk/collection/L06/current/_] - |mandatory |fixed value: "sub-surface gliders" + |mandatory |"sub-surface gliders" |platform_vocabulary |Controlled vocabulary for the names used in the "platform" attribute. |mandatory |https://vocab.nerc.ac.uk/collection/L06/current/27/[_https://vocab.nerc.ac.uk/collection/L06/current/27/_] |id a| Formatted mission name: __ -data_mode_vocabulary = “”; - |mandatory | ex.: @@ -195,14 +193,16 @@ ex.: |contributor_id |Unique id of the contributors to the glider mission. Multiple contributors’ ids are separated by commas. |highly desirable | |contributor_role |Role of the contributors to the glider mission. Multiple contributors’ roles are separated by commas. |PI vocabulary is mandatory | |contributor_role_vocabulary |Controlled vocabulary for the roles used in the "contributors_role". Multiple contributors’ roles and vocabularies are separated by commas. |PI vocabulary is mandatory |http://vocab.nerc.ac.uk/search_nvs/W08/[_http://vocab.nerc.ac.uk/search_nvs/W08/_] -|agency |Name of institutions involved in the glider mission. Multiple institutions are separated by commas. |operating institution is mandatory | -|agency_role |Role of the institutions involved in the glider mission. Multiple institutions' roles are separated by a comma. |operating institution role is mandatory | -|agency_role_vocabulary |The controlled vocabulary of the role used in the institution's role. Multiple vocabularies are separated by commas. |operating institution vocabulary is mandatory |https://vocab.nerc.ac.uk/collection/C86/current/[_https://vocab.nerc.ac.uk/collection/C86/current/_] -|agency_id |code of the institution involved in the glider mission. Multiple ids are separated by a comma. |highly desirable | -|agency_id_vocabulary |url to the repository of the id |highly desirable |EDMO, ROR, etc. +|institution |Name of institutions involved in the glider mission. Multiple institutions are separated by commas. |operating institution is mandatory | +|institution_role |Role of the institutions involved in the glider mission. Multiple institutions' roles are separated by a comma. |operating institution role is mandatory | +|institution_role_vocabulary |The controlled vocabulary of the role used in the institution's role. Multiple vocabularies are separated by commas. |operating institution vocabulary is mandatory |https://vocab.nerc.ac.uk/collection/C86/current/[_https://vocab.nerc.ac.uk/collection/C86/current/_] +|institution_id |code of the institution involved in the glider mission. Multiple ids are separated by a comma. |highly desirable | +|institution_id_vocabulary |url to the repository of the id |highly desirable |EDMO, ROR, etc. |uri |Other universal resource identifiers relevant to be linked to this dataset. Multiple uris are separated by a comma. |suggested |EDIOS, CSR, EDMERP, EDMED, CDI, ICES, etc. |data_url |url link to OG1.0 data file |mandatory | |doi |The digital object identifier of the OG1.0 data file |highly desirable | +|rtqc_method |The method used by DAC to apply real-time quality control to the data set |mandatory | +|rtqc_method_doi |The digital object identifier of the methodology used to apply real-time quality control to the data set. |mandatory | |web_link |url that provides useful information about anything related to the glider mission. Multiple urls are separated by commas. |suggested | |comment |Miscellaneous information about the data or methods used to produce it. |suggested | |date_created |date of creation of this data set |mandatory |iso 8601 @@ -223,15 +223,13 @@ image:figures/image2.png[image,width=515,height=171] //// == Dimension and definition -[cols=",,,",options="header",] +[cols=",,",options="header",] |================================================================================================================================================================================================================================================================= - -|*Name* |*Definition* |*Comment*| -|N_MEASUREMENTS |N_MEASUREMENTS = unlimited; |Number of recorded locations| -|N_SENSOR| N_SENSOR = ; | Number of sensors mounted on the float and used to measure the parameters. -Example for a float with a CTD, an ECO_FLBBCD and an OPTODE: Sensors are : CTD_TEMP, CTD_PRES, CTD_CNDC, OPTODE_DOXY, FLUOROMETER_CHLA, FLUOROMETER_CDOM, BACKSCATTERINGMETER_BBP700 ; N_SENSOR = 7| -|N_PARAM |N_PARAM = ; |Number of parameters measured or calculated for a pressure sample. Examples for a float with CTD, ECO_FLBBCD and OPTODE : PRES, TEMP, CNDC, PSAL, MOLAR_DOXY, TEMP_DOXY, CHLA, CDOM, BETA700) : N_PARAM = 9| - +|*Name* |*Definition* |*Comment* +|N_MEASUREMENTS |N_MEASUREMENTS = unlimited; |Number of recorded locations. +| N_SENSOR| N_SENSOR = ; | Number of sensors mounted on the glider and used to measure the parameters. +Example for a glider with CTD, ECO_FLBBCD and OPTODE: CTD_TEMP, CTD_PRES, CTD_CNDC, OPTODE_DOXY, FLUOROMETER_CHLA, FLUOROMETER_CDOM, BACKSCATTERINGMETER_BBP700 ; N_SENSOR = 7 +|N_PARAM |N_PARAM = ; |Number of parameters measured or calculated for a pressure sample. Examples for a glider with CTD, ECO_FLBBCD and OPTODE : PRES, TEMP, CNDC, PSAL, MOLAR_DOXY, TEMP_DOXY, CHLA, CDOM, BETA700) : N_PARAM = 9 |================================================================================================================================================================================================================================================================= //// @@ -286,7 +284,6 @@ OG1.0 requirements cover the GPS variables delivered by the glider when at the s * dimension: N_MEASUREMENTS | * long_name = “time of each GPS location”; -* standard_name = “time”; * calendar = "gregorian" ; * units = “seconds since 1970-01-01T00:00:00Z”; * _FillValue = -1.0 ; @@ -352,8 +349,7 @@ OG1.0 requirements cover positioning variables and geolocating any scientific me * data type: double * dimension: N_MEASUREMENTS | -* long_name = “time of measurement and GPS location”; -* standard_name = “time”; +* long_name = “time of measurement”; * calendar = "gregorian" ; * units = “seconds since 1970-01-01T00:00:00Z”; * _FillValue = -1.0 ; @@ -385,26 +381,32 @@ In this following section, two options, “encapsulate variable” and “indivi //// == Trajectory Name -[cols="1a,2a,1",options="header",] -|============================================================ +[cols=",,",options="header",] +|=========================================================================================================================== |*VARIABLE NAME* |*variable attributes* |*requirement status* -|TRAJECTORY +|TRAJECTORY a| +string TRAJECTORY -* data type: string | +TRAJECTORY:cf_role = "trajectory_id" -* cf_role = "trajectory_id"; -* long_name = “trajectory name”; -* data_mode_vocabulary = “”; +TRAJECTORY:long_name = “trajectory name”; -| mandatory +TRAJECTORY:data_mode_vocabulary = “”; + a| +mandatory Value: _ -Where refers to the name of the glider, refers to the deployment start UTC date under iso 8601. *Ex : eltanin_20210909T1605* +Where refers to the name of the glider, refers to the deployment start UTC date under iso 8601, -If the glider has no use instead to create the TRAJECTORY. *Ex.: sp042_20210218T2325* -|============================================================ +Ex : eltanin_20210909T1605 + +If the glider has no use instead to create the TRAJECTORY + +Ex.: sp042_20210218T2325 + +|=========================================================================================================================== //// * [[platform-information]] @@ -412,58 +414,60 @@ If the glider has no use instead to cre //// === Platform information -[cols="1a,2a,1",options="header",] -|============================================================ +[cols=",,",options="header",] +|======================================================================================== |*VARIABLE NAME* |*variable attributes* |*requirement status* -|PLATFORM_MODEL +|PLATFORM_MODEL a| +string PLATFORM_MODEL + +PLATFORM_MODEL:long_name: “model of the glider”; + +PLATFORM_MODEL:platform_model_vocabulary = “”; -* data type: string| -* long_name: “model of the glider”; -* platform_model_vocabulary = “”; |mandatory +|WMO_IDENTIFIER a| +string WMO_IDENTIFIER -|WMO_IDENTIFIER +WMO_IDENTIFIER:long_name = “wmo id”; -* data type: string| -* long_name = “wmo id”; |mandatory +|PLATFORM_SERIAL_NUMBER a| +string PLATFORM_SERIAL_NUMBER -|PLATFORM_SERIAL_NUMBER +PLATFORM_SERIAL_NUMBER:long_name = “glider serial number”; -* data type: string| -* long_name = “glider serial number”; |highly desirable +|PLATFORM_NAME a| +string PLATFORM_NAME -|PLATFORM_NAME +PLATFORM_NAME:long_name = “Local or nickname of the glider”; -* data type: string| -* long_name = “unique identifying name of glider”; - |mandatory + |highly desirable +|PLATFORM_DEPTH_RATING a| +integer PLATFORM_DEPTH_RATING - The platform name should be constructed from the manufacturer prefix and the platform serial number e.g. "sea001" (seaglider), unit001 (slocum), sea001 (seaexplorer), sp001 (spray). Where the serial number of the platform is not known, a local nickname can be used e.g. "orca", "sverdrup", "ammonite". +PLATFORM_DEPTH_RATING:long_name = “depth limit in meters of the glider for this mission”; -|PLATFORM_DEPTH_RATING +PLATFORM_DEPTH_RATING:convention = “positive value expected - e.g. 100m depth = 100”; -* data type: integer -* dimension: SCALAR| -* long_name = “depth limit in meters of the glider for this mission”; -* convention = “positive value expected - e.g. 100m depth = 100”; |highly desirable +|ICES_CODE a| +string ICES_CODE + +ICES_CODE:long_name = “ICES platform code of the glider” ; -|ICES_CODE +ICES_CODE :ices_code_vocabulary = “” ; -* data type: string| -* long_name = “ICES platform code of the glider” ; -* ICES_CODE :ices_code_vocabulary = “” ; |highly desirable +|PLATFORM_MAKER a| +string PLATFORM_MAKER -|PLATFORM_MAKER +PLATFORM_MAKER:long_name = “glider manufacturer”; + +PLATFORM_MAKER:platform_maker_vocabulary = “”; -* data type: string| -* long_name = “glider manufacturer”; -* platform_maker_vocabulary = “”; |suggested -|============================================================ +|======================================================================================== //// * [[deployment-information]] @@ -471,45 +475,31 @@ If the glider has no use instead to cre //// === Deployment information -[cols="1a,2a,1",options="header",] +[cols=",,",options="header",] |============================================================ |*VARIABLE NAME* |*variable attributes* |*requirement status* -|DEPLOYMENT_TIME +|DEPLOYMENT_TIME a| +double DEPLOYMENT_TIME -* data type: double -* dimension: SCALAR | +DEPLOYMENT_TIME:long_name = “date of deployment”; -* long_name = = “date of deployment”; -* standard_name = "time"; -* calendar = "gregorian"; -* units = "seconds since 1970-01-01T00:00:00Z"; -* _FillValue = -1.0 ; -* valid_min = 1e9 ; -* valid_max = 4e9 ; +DEPLOYMENT_TIME:standard_name = "time"; - |mandatory -|DEPLOYMENT_LATITUDE +DEPLOYMENT_TIME:calendar = "gregorian"; -* data type: double -* dimension: SCALAR | - -* long_name = “latitude of deployment”; -* units = “degrees_north”; -* _FillValue = -9999.9; -* valid_min = -90.0; -* valid_max = 90.0; +DEPLOYMENT_TIME:units = "seconds since 1970-01-01T00:00:00Z"; |mandatory -|DEPLOYMENT_LONGITUDE +|DEPLOYMENT_LATITUDE a| +double DEPLOYMENT_LATITUDE -* data type: double -* dimension: SCALAR | +DEPLOYMENT_LATITUDE:long_name = “latitude of deployment”; -* long_name = “longitude of deployment” -* units = “degrees_east”; -* _FillValue = -9999.9; -* valid_min = -180.0; -* valid_max = 180.0; + |mandatory +|DEPLOYMENT_LONGITUDE a| +double DEPLOYMENT_LONGITUDE + +long_name = “longitude of deployment”; |mandatory |============================================================ @@ -523,16 +513,18 @@ If the glider has no use instead to cre //// === Field comparison information -[cols="1a,2a,1",options="header",] -|============================================================ +[cols=",,",options="header",] +|========================================================================================================================================= |*VARIABLE NAME* |*variable attributes* |*requirement status* -|FIELD_COMPARISON_REFERENCE +|FIELD_COMPARISON_REFERENCE a| +String FIELD_COMPARISON_REFERENCE: + +FIELD_COMPARISON_REFERENCE:long_name = “links (uri or url) to supplementary data that can provide field comparison for platform sensors.”; + +FIELD_COMPARISON_REFERENCE:comment = “multiple links are separated by a comma” -* data type: string| -* long_name = “links (uri or url) to supplementary data that can provide field comparison for platform sensors.”; -* comment = “multiple links are separated by a comma” |highly desirable -|============================================================ +|========================================================================================================================================= Note: FIELD_COMPARISON_REFERENCE is applicable to deployment, recovery, and delayed versions. @@ -542,34 +534,36 @@ Note: FIELD_COMPARISON_REFERENCE is applicable to deployment, recovery, and dela //// === Hardware information -[cols="1a,2a,1",options="header",] -|============================================================ +[cols=",,",options="header",] +|============================================================================= |*VARIABLE NAME* |*variable attributes* |*requirement status* -|GLIDER_FIRMWARE_VERSION +|GLIDER_FIRMWARE_VERSION a| +string GLIDER_FIRMWARE_VERSION + +GLIDER_FIRMWARE_VERSION:long_name = “version of the internal glider firmware”; -* data type: string| -* long_name = “version of the internal glider firmware”; |highly desirable +|LANDSTATION_VERSION a| +string LANDSTATION_VERSION -|LANDSTATION_VERSION +LANDSTATION_VERSION:long_name = “version of the server onshore”; -* data type: string| -* long_name = “version of the server onshore”; |highly desirable +|BATTERY_TYPE a| +string BATTERY_TYPE + +BATTERY_TYPE:long_name = “type of the battery”; -|BATTERY_TYPE +BATTERY_TYPE:battery_type_vocabulary = “”; -* data type: string| -* long_name = “type of the battery”; -* battery_type_vocabulary = “”; |suggested +|BATTERY_PACK a| +string BATTERY_PACK -|BATTERY_PACK +BATTERY_PACK:long_name = “battery packaging”; -* data type: string| -* long_name = “battery packaging”; |suggested -|============================================================ +|============================================================================= //// * [[telecom-information]] @@ -577,23 +571,26 @@ Note: FIELD_COMPARISON_REFERENCE is applicable to deployment, recovery, and dela //// === Telecom information -[cols="1a,2a,1",options="header",] -|============================================================ +[cols=",,",options="header",] +|=============================================================================== |*VARIABLE NAME* |*variable attributes* |*requirement status* -|TELECOM_TYPE +|TELECOM_TYPE a| +string TELECOM_TYPE + +TELECOM_TYPE:long_name = “type of telecommunication systems used by the glider”; + +TELECOM_TYPE:telecom_type_vocabulary = “”; -* data type: string| -* long_name = “type of telecommunication systems used by the glider”; -* telecom_type_vocabulary = “”; |highly desirable +|TRACKING_SYSTEM a| +string TRACKING_SYSTEM + +TRACKING_SYSTEM:long_name = “type of tracking systems used by the glider”; -|TRACKING_SYSTEM +TRACKING_SYSTEM:tracking_system_vocabulary = “”; -* data type: string| -* long_name = “type of tracking systems used by the glider”; -* tracking_system_vocabulary = “”; |highly desirable -|============================================================ +|=============================================================================== //// * [[phase-variable]] @@ -609,34 +606,46 @@ Phase calculation methodologies need publishing as a best practice document sepa The tables below describe the mandatory information to PHASE stored in two ways. -[cols="1a,2a,1",options="header",] -|============================================================ +[cols=",,",options="header",] +|============================================================= |*VARIABLES NAME* |*variable attributes* |*requirement status* -|PHASE - -* data_type: byte -* dimension: N_MEASUREMENTS| -* long_name = “behavior of the glider at sea”; -* phase_vocabulary: “url to phase vocab list”; -* _FillValue = 0b ; -* ancillary_variables = "PHASE_QC" -* phase_calculation_method = “”; -* phase_calculation_method_vocabulary = “”; -* phase_calculation_method_doi = “”; +|PHASE a| +Byte PHASE(N_MEASUREMENTS) + +PHASE:long_name = “behavior of the glider at sea”; + +PHASE:phase_vocabulary: “url to phase vocab list”; + +PHASE:_FillValue = 0b ; + +PHASE:phase_calculation_method = “”; + +PHASE:phase_calculation_method_vocabulary = “”; + +PHASE:phase_calculation_method_doi = “”; + +PHASE: ancillary_variables = "PHASE_QC" + |Highly desirable +|PHASE_QC a| +Byte PHASE_QC(N_MEASUREMENTS) + +PHASE_QC:long_name = "quality flag"; + +PHASE_QC:_FillValue = " "; + +PHASE_QC:valid_range = 0b, 1b, 2b, 3b, 4b; -|PHASE_QC +PHASE_QC:flag_values = 0b, 1b, 2b, 3b, 4b; -* data type: byte -*dimension: N_MEASUREMENTS| +PHASE_QC:flag_meanings = "No QC has been applied + Good data + Probably good data + Probably bad data + Bad data" ; -* long_name = "quality flag"; -* _FillValue = " "; -* valid_range = 0b, 1b, 2b, 3b, 4b; -* flag_values = 0b, 1b, 2b, 3b, 4b; -* flag_meanings = "No QC has been applied, Good data, Probably good data, Probably bad data, Bad data" ; |Highly desirable -|============================================================ +|============================================================= Note 1: For a simple case, PHASE calculation is relatively easy. But in some cases, PHASE calculation remains difficult. When code will be available publicly and described in some published best practices, PHASE will become mandatory. Note 2: Quality control of the PHASE could be useful to manage difficult cases. @@ -650,7 +659,7 @@ Note 2: PHASE is used to derive data product (profile, trajectory profiles, grid This section contains information about the sensors of the glider. Each ocean state variable to be recorded must be described with its sensor. Gears with multiple sensors (i.e. CTD) should consider separated sensors in particular if there is not a unique serial number and calibration date for the sensors. -A sensor is a device used to measure a physical parameter. Sensor outputs are provided in parameter counts and need to be converted into parameter physical units using a calibration equation. This conversion can be done onboard the float or during the decoding process. +A sensor is a device used to measure a physical parameter. Sensor outputs are provided in parameter counts and need to be converted into parameter physical units using a calibration equation. This conversion can be done onboard the glider or during the decoding process. [cols=",,",options="header",] |============================================================= @@ -707,7 +716,6 @@ SENSOR_UUID:exemplar: "TOOL0669_75" _" | suggested |============================================================= Note 1: SENSOR information is highly desirable to avoid ERDDAP configuration difficulties. When those difficulties will be overcome, some of the SENSOR information will become mandatory. - //// * [[parameters-information]] = Parameter’s information @@ -719,43 +727,30 @@ A parameter is a measurement of a physical phenomenon; it can be provided by a s This section contains information about the parameters measured by the glider or derived from glider measurements. The section is based on the approach used in Argo formats and enables parameter information interoperability with major stakeholders such as CMEMS. -[cols="1a,2a,1",options="header",] -|============================================================ -|*VARIABLE NAME* |*variable attributes* |*requirement status* -|PARAMETER - -* data_type: string -* dimension: N_PARAM| - -* long_name = “name of parameter computed from glider measurements”; - -* parameter_vocabulary = “_https://vocab.nerc.ac.uk/collection/OG1/current/_”; - - |highly desirable - -|PARAMETER_SENSOR - -* data_type: string -* dimension: N_PARAM| - -* long_name = “”; - -* parameter_sensor_vocabulary = “”; +[cols=",,",options="header",] +|======================================================================================================================================= +|*VARIABLE NAME* |*variable attributes* |*requirement status* +|PARAMETER a| +string PARAMETER(N_PARAM) -|highly desirable +PARAMETER:long_name = “name of parameter computed from glider measurements”; -|PARAMETER_UNITS +PARAMETER:parameter_vocabulary = “_https://vocab.nerc.ac.uk/collection/OG1/current/_”; -* data_type: string -* dimension: N_PARAM| + |highly desirable +|PARAMETER_SENSOR a| +string PARAMETER_SENSOR(N_PARAM) -* long_name = “”; +PARAMETER_SENSOR:long_name = “”; -* parameter_units_vocabulary = “”; + |highly desirable +|PARAMETER_UNITS a| +string PARAMETER_UNITS(N_PARAM) PARAMETER_UNITS:long_name = “”; -|highly desirable +PARAMETER_UNITS:parameter_units_vocabulary = “”; -|============================================================ + |highly desirable +|======================================================================================================================================= Note 1: PARAMETER information is highly desirable to avoid ERDDAP configuration difficulties. When those difficulties will be overcome, some of the PARAMETER information will become mandatory. @@ -763,87 +758,126 @@ Note 1: PARAMETER information is highly desirable to avoid ERDDAP configuration * [[geophysical-variables]] = Geophysical variables //// -== Geophysical variables - += Geophysical variables "The fill value should have the same data type as the variable and be outside of the range of possible data values." -[cols="1a,2a,1",options="header",] -|============================================================ +[cols=",,",options="header",] +|========================================================================================================================== |*VARIABLE NAME* |*variable attributes* |*requirement status* -| - -* data type: float -* dimension: N_MEASUREMENT| -* long_name = ""; -* standard_name = “"; -* _FillValue = ; -* units = ""; -* vocabulary = “_https://vocab.nerc.ac.uk/collection/OG1/current/_"; -* ancillary_variables = "PARAM_QC"; -* coordinates = "LATITUDE, LONGITUDE, DEPTH, TIME" - | mandatory +| a| +float (N_MEASUREMENT); + +:long_name = ""; :standard_name = “"; + +:vocabulary = “_https://vocab.nerc.ac.uk/collection/OG1/current/_"; + +:_FillValue = ; + +:units = ""; + +:ancillary_variables = "PARAM_QC"; + +:coordinates = "LATITUDE, LONGITUDE, DEPTH, TIME" + + a| +mandatory contains the values of a parameter listed in the control vocabulary related to OceanGliders parameters. : these fields are specified in the control vocabularies. -|_QC - -* data type: float -* dimension: N_MEASUREMENT| -* long_name = "quality flag"; -* _FillValue = " "; -* valid_range = 0b, 1b, 2b, 3b, 4b; -* flag_values = 0b, 1b, 2b, 3b, 4b; -* flag_meanings = "No QC has been applied, Good data, Probably good data, Probably bad data, Bad data" ; -* RTQC_methodology = “”; -* RTQC_methodology_vocabulary = “”; -* RTQC_methodology_doi = “”; - |higly desirable -|============================================================ +|_QC a| +Byte _QC(N_MEASUREMENT); _QC:long_name = "quality flag"; -Note: It is anticipated to upgrade the ancillary variable related to QC by refining the ancillary variable name like < PARAM >_qc_generic, < PARAM >_qc_spike_test, _qc_land_test, etc. Current _QC attributes based on CF guidance (https://cfconventions.org/Data/cf-conventions/cf-conventions-1.8/cf-conventions.html#flags) -and use the GOOS networks 0-4 flagging convention. +_QC:_FillValue = " "; -//// -* [[controlled-vocabularies]] -= Controlled vocabularies -//// -== Controlled vocabularies +_QC:valid_range = 0b, 1b, 2b, 3b, 4b; -A list of controlled vocabularies is used in this format to enable harmonization across multiple stakeholders. The different collections with hosts and managers are listed below. +_QC:flag_values = 0b, 1b, 2b, 3b, 4b; -Controlled vocabularies will cover the metadata listed in the table (with a summary of existing candidate vocabularies and proposed governance): +_QC:flag_meanings = "No QC has been applied + Good data + Probably good data + Probably bad data + Bad data" ; -[cols=",,,,",options="header",] -|=================================================================================================================================================================================== -|*Metadata field* |*Vocabulary exists* |*Link to vocabulary* |*host* |*Possible governance* -|platform |yes |https://vocab.nerc.ac.uk/collection/L06/current/25/[_https://vocab.nerc.ac.uk/collection/L06/current/25/_] |NVS |OceanGliders -|oceangliders_site |No |https://docs.google.com/document/d/1dN90xkw9oCbLs0sPPhOmszdOjLpwcqxiK5mjeZP7abA/edit?usp=sharing[_Interim Reference Document_] |NVS |OceanOPS -|contributors_role |No |https://docs.google.com/document/d/1dN90xkw9oCbLs0sPPhOmszdOjLpwcqxiK5mjeZP7abA/edit?usp=sharing[_Interim Reference Document_] |NVS |OceanGliders -|agencies_role |No |https://docs.google.com/document/d/1dN90xkw9oCbLs0sPPhOmszdOjLpwcqxiK5mjeZP7abA/edit?usp=sharing[_Interim Reference Document_] |NVS |OceanGliders -|agencies_id |Yes |https://edmo.seadatanet.org/[_https://edmo.seadatanet.org/_] |Maris |SeaDataNet -|naming_authority |Yes |https://edmo.seadatanet.org/[_https://edmo.seadatanet.org/_] |Maris |SeaDataNet -|institution |Yes |https://edmo.seadatanet.org/[_https://edmo.seadatanet.org/_] |Maris |SeaDataNet -|rtqc_method |No |https://docs.google.com/document/d/1dN90xkw9oCbLs0sPPhOmszdOjLpwcqxiK5mjeZP7abA/edit?usp=sharing[_Interim Reference Document_] |? |OceanGliders -|phase_calculation_methodology |No |https://docs.google.com/document/d/1dN90xkw9oCbLs0sPPhOmszdOjLpwcqxiK5mjeZP7abA/edit?usp=sharing[_Interim Reference Document_] |? |OceanGliders -|platform_model |Yes |https://docs.google.com/document/d/1dN90xkw9oCbLs0sPPhOmszdOjLpwcqxiK5mjeZP7abA/edit?usp=sharing[_Interim Reference Document_] |NVS |OceanGliders -|ICES_code |Yes |https://docs.google.com/document/d/1dN90xkw9oCbLs0sPPhOmszdOjLpwcqxiK5mjeZP7abA/edit?usp=sharing[_Interim Reference Document_] |? (ICES / NVS) |ICES -|platform_maker |Yes |https://docs.google.com/document/d/1dN90xkw9oCbLs0sPPhOmszdOjLpwcqxiK5mjeZP7abA/edit?usp=sharing[_Interim Reference Document_] |NVS |OceanGliders -|battery_type |No |https://docs.google.com/document/d/1dN90xkw9oCbLs0sPPhOmszdOjLpwcqxiK5mjeZP7abA/edit?usp=sharing[_Interim Reference Document_] |NVS |OceanGliders -|telecom_type |No |https://docs.google.com/document/d/1dN90xkw9oCbLs0sPPhOmszdOjLpwcqxiK5mjeZP7abA/edit?usp=sharing[_Interim Reference Document_] |NVS |OceanGliders -|tracking_system |No |https://docs.google.com/document/d/1dN90xkw9oCbLs0sPPhOmszdOjLpwcqxiK5mjeZP7abA/edit?usp=sharing[_Interim Reference Document_] |NVS |OceanGliders -|sensor_model |Yes |https://docs.google.com/document/d/1dN90xkw9oCbLs0sPPhOmszdOjLpwcqxiK5mjeZP7abA/edit?usp=sharing[_Interim Reference Document_] |NVS |OceanGliders -|data_mode |No |https://docs.google.com/document/d/1dN90xkw9oCbLs0sPPhOmszdOjLpwcqxiK5mjeZP7abA/edit?usp=sharing[_Interim Reference Document_] |? |OceanGliders -|phase |No |https://docs.google.com/document/d/1dN90xkw9oCbLs0sPPhOmszdOjLpwcqxiK5mjeZP7abA/edit?usp=sharing[_Interim Reference Document_] |NVS |OceanGliders -|variable names |Yes |https://docs.google.com/document/d/1dN90xkw9oCbLs0sPPhOmszdOjLpwcqxiK5mjeZP7abA/edit?usp=sharing[_Interim Reference Document_] |NVS |OceanGliders -|=================================================================================================================================================================================== +_QC:RTQC_methodology = “”; -_Notes:_ +_QC:RTQC_methodology_vocabulary = “”; -* Units are a special case to be discussed because the convention in GOOS is UD units which are a conflation of observed property and measurement scale. UD units are available in spreadsheet form but not on a vocabulary server. Efforts are ongoing in the internal community to harmonize a common unit's vocabulary. -* A sustainable model to resource the development and ongoing maintenance of vocabularies will need to be identified during the implementation phase of the OG1.0. +_QC:RTQC_methodology_doi = “”; + + |higly desirable +|========================================================================================================================== + +Note: It is anticipated to upgrade the ancillary variable related to QC by refining the ancillary variable name like < PARAM >_qc_generic, < PARAM >_qc_spike_test, _qc_land_test, etc. Current _QC attributes based on CF guidance (https://cfconventions.org/Data/cf-conventions/cf-conventions-1.8/cf-conventions.html#flags) +and use the GOOS networks 0-4 flagging convention. + +//// +* [[Vocabulary Collections]] +//// +== Vocabulary Collections + +Series of concept of the https://github.com/OceanGlidersCommunity/OG1.0-user-manual[OG1.0 format] are controlled by a collection of vocabularies managed by the OceanGliders data management team and other governance boddy. + +These concepts are listed in the table below. Each concept is linked to its collection of vocabularies. Each element of the collection has a status attribute. + +[square] +* The *validated* entries have been validated by the vocabulary working group and can be used in the OG1.0 format. + +* The *published* entries have been published by the host when it exist. + +* The *pending* entries are being discussed by the community and are not yet supported by the OG1.0 format. + + +Vocabularies that are not governed by OceanGliders do not follow the *status* convention described above. + +=== "host" and "governance" of vocabulary collection + +**host** : The host is the entity that is serving the *published* vocabularies. A collection served by host enable the machine to machine communication. + +**governance** : Governance refers to the entity in charge of the maintenance, evolution and publication of the vocabulary collection. + +=== Request a new entry + +To request a new entry in any of the collection listed below, you should submit an issue to this repository entitle `*_new entry for table _*` . +The issue must indicate the value of the new entry and all its relevant attributes described in the corresponding table. + +=== Validation process + +A working group on controlled vocabulary will review the requests for new vocabularies regularly. +While a continuous update of the controlled vocabularies is anticipated, the working group will update a new version of controlled vocabulary at least twice a year. +The aim is to update the collection on the host server at least once a year. + +=== Non synchronised list +It is expected that the vocabulary collections will not always been synchronized between this repository and the host services. There will be a lag between validating a entry here and this entry being published in the host. This lag is due to different governance and validation rules between governance and host. + + +`*The reference lists are the lists available below.*` + +=== Table of controlled vocabularies + +|=== +|Metadata fields | link to reference collection | Link to host | Governance | + + | platform | https://vocab.nerc.ac.uk/collection/L06/current/25/[collection] | https://vocab.nerc.ac.uk/collection/L06/current/25/ | OceanGliders | + | oceangliders_site | *tbd* | *tbd* | OceanOPS | + | contributors_role | https://github.com/OceanGlidersCommunity/OG-format-user-manual/blob/vturpin-patch-3-VocabularyCollectionSection/vocabularyCollection/contributors_role.md[collection] | *tbd* | OceanGliders | + | agencies_role | https://github.com/OceanGlidersCommunity/OG-format-user-manual/blob/vturpin-patch-3-VocabularyCollectionSection/vocabularyCollection/agencies_role[collection] | *tbd* | OceanGliders | + | agencies_id | https://edmo.seadatanet.org/[collection] | https://edmo.seadatanet.org/ | SeaDataNet | + | naming_authority | https://edmo.seadatanet.org/[collection] | https://edmo.seadatanet.org/ | SeaDataNet | + | institution | https://edmo.seadatanet.org/[collection] | https://edmo.seadatanet.org/ | SeaDataNet | + | rtqc_method | https://github.com/OceanGlidersCommunity/OG-format-user-manual/blob/vturpin-patch-3-VocabularyCollectionSection/vocabularyCollection/rtqc_method.md[collection] | https://vocab.nerc.ac.uk/collection/L06/current/25/ | OceanGliders | + | phase_calculation_methodology | *tbd* | *tbd* | OceanGliders | + | platform_type | https://github.com/OceanGlidersCommunity/OG-format-user-manual/blob/vturpin-patch-3-VocabularyCollectionSection/vocabularyCollection/platform_type.md[collection] | http://vocab.nerc.ac.uk/collection/L06/current/27/ | OceanGliders | + | platform_model | https://github.com/OceanGlidersCommunity/OG-format-user-manual/blob/vturpin-patch-3-VocabularyCollectionSection/vocabularyCollection/platform_model.md[collection] | *tbd* | OceanGliders | + | ICES_code | https://vocab.ices.dk/?codetypeguid=7f9a91e1-fb57-464a-8eb0-697e4b0235b5[collection] | https://vocab.ices.dk/?codetypeguid=7f9a91e1-fb57-464a-8eb0-697e4b0235b5 | ICES | + | platform_maker | https://github.com/OceanGlidersCommunity/OG-format-user-manual/blob/vturpin-patch-3-VocabularyCollectionSection/vocabularyCollection/platform_maker.md[collection] | *tbd* | OceanGliders | + | battery_type | https://github.com/OceanGlidersCommunity/OG-format-user-manual/blob/vturpin-patch-3-VocabularyCollectionSection/vocabularyCollection/battery_type.md[collection] | *tbd* | OceanGliders | + | telecom_type | https://github.com/OceanGlidersCommunity/OG-format-user-manual/blob/vturpin-patch-3-VocabularyCollectionSection/vocabularyCollection/telecom_type.md[collection] | *tbd* | OceanGliders | + | tracking_system | https://github.com/OceanGlidersCommunity/OG-format-user-manual/blob/vturpin-patch-3-VocabularyCollectionSection/vocabularyCollection/tracking_system.md[collection] | *tbd* | OceanGliders | + | sensor | *tbd* | *tbd* | OceanGliders | + | sensor_model | *tbd* | *tbd* | OceanGliders | + | data_mode | https://github.com/OceanGlidersCommunity/OG-format-user-manual/blob/vturpin-patch-3-VocabularyCollectionSection/vocabularyCollection/data_mode.md[collection] | *tbd* | OceanGliders | + | phase | https://github.com/OceanGlidersCommunity/OG-format-user-manual/blob/vturpin-patch-3-VocabularyCollectionSection/vocabularyCollection/phase.md[collection] | *tbd* | OceanGliders | + | parameter | *tbd* | http://vocab.nerc.ac.uk/collection/OG1/current/ | OceanGliders | +|=== + + + -Vocabularies will be fully defined during the implementation phase of the OG1.0. The current version of the vocabulary collections is available here: https://docs.google.com/document/d/1dN90xkw9oCbLs0sPPhOmszdOjLpwcqxiK5mjeZP7abA/edit?usp=sharing[_Interim Reference Document_] //// * [[best-practices]] @@ -921,4 +955,4 @@ Example 7: * platform: stella_20180207 * Program: MARS Glider program * Site: no site -* Network: Alter_ECO +* Network: Alter_ECO \ No newline at end of file diff --git a/README.md b/README.md index e84bf88c..40fe0ea9 100644 --- a/README.md +++ b/README.md @@ -5,7 +5,7 @@ Here we review issues related to OceanGliders (OG) format and vocabularies. A discussion section is also available for any question or comment related to OG format and vocabulary. -You can find the most recent version of the [OG format](https://oceangliderscommunity.github.io/OG-format-user-manual/) +[Here](https://oceangliderscommunity.github.io/OG-format-user-manual/) is the most recent version of the user manual. ### Example files diff --git a/vocabularyCollection/agencies_role.md b/vocabularyCollection/agencies_role.md new file mode 100644 index 00000000..bf8e9b6c --- /dev/null +++ b/vocabularyCollection/agencies_role.md @@ -0,0 +1,6 @@ +| agencies_role | definition | status | +|:------ |:------ |:------ | +| funding agency | agency funding entire or part of the operation at sea, including any relevant aspect of the operation | pending | +| operating agency | agency responsible for the operations at sea | pending | +| data assembly center | agency responsible for the processing of the raw data acquired, including conversion into the community format | pending | +| global data assembly cente | agency responsible for the collection of all OceanGliders data sets under the common format | pending | diff --git a/vocabularyCollection/battery_type.md b/vocabularyCollection/battery_type.md new file mode 100644 index 00000000..7c515a4a --- /dev/null +++ b/vocabularyCollection/battery_type.md @@ -0,0 +1,8 @@ +| battery_type | definition | status | +|:------ |:------ |:------ | +| lithium rechargeable | Rechargeable lithium battery pack | pending | +| alkaline rechargeable | Rechargeable alkaline battery pack | pending | +| alkaline | alkaline battery pack | pending | +| lithium | lithium battery pack | pending | +| alkaline + lithium | alkaline and lithium battery pack | pending | +| lithium primary | | pending | diff --git a/vocabularyCollection/contributors_role.md b/vocabularyCollection/contributors_role.md new file mode 100644 index 00000000..88010472 --- /dev/null +++ b/vocabularyCollection/contributors_role.md @@ -0,0 +1,10 @@ +| contributors_role | definition | status | +|:--------- |:-------- |:--------- | +| glider pilot | person (or one of the persons) piloting the glider during the mission | pending | +| principal operator | person responsible for the operations from deployment to recovery of the glider. Operations do not cover piloting, data management and science | pending | +| operator | person involved in operations from pre-deployment to recovery of the glider. Operations do not cover piloting, data management and science | pending | +| principal investigator | person leading the scientific aspects of the glider mission | pending | +| scientist | person involved in the scientific aspects of the glider mission | pending | +| data manager | person responsible of the collection, processing and archiving of the data and metadata acquired during the glider mission | pending | +| data curator | person responsible for overseeing the organization, maintenance, and quality of the dataset | pending | + diff --git a/vocabularyCollection/data_mode.md b/vocabularyCollection/data_mode.md new file mode 100644 index 00000000..4a4c4210 --- /dev/null +++ b/vocabularyCollection/data_mode.md @@ -0,0 +1,7 @@ +| data_mode | descritpion | status | +|:------ |:------- |:-------| +| R | Real-time data. Data coming from the glider through a communication channel without physical access to the instruments, disassembly or recovery of the platform | pending | +| P | Provisional data. Data obtained after the glider has been recovered or serviced | pending | +| A | Real-time adjusted data. Real-time or provisional data that have been adjusted by real-time automatic procedures | pending | +| D | Delayed-mode data. Data published after all calibrations and quality control procedures have been applied on the internally recorded or best available original data. This is the best possible version of processed data | pending | +| M | Mixed data. This value indicates that the file contains data in more than one of the above states | pending | diff --git a/vocabularyCollection/phase.md b/vocabularyCollection/phase.md new file mode 100644 index 00000000..91a5da96 --- /dev/null +++ b/vocabularyCollection/phase.md @@ -0,0 +1,9 @@ +| phase | description | status | +|:----- |:------ |:------ | +| ascent | the platform is moving up toward surface with no internal command on the pitch angle | pending | +| descent | the platform is moving down toward targeted depth of operation with no internal command on the pitch angle | pending | +| surfacing | the platform is drifting at the surface for communication, recovery or safety purpose | pending | +| parking | the platform is maintained at a parking depth | pending | +| inflexion | the platform is changing pitch angle to move from a phase to another | pending | +| propelled | the platform momentum is increased by the propeller | pending | +| transition | These particular points could be part of the previous as well as the following phase | pending | diff --git a/vocabularyCollection/platform_maker.md b/vocabularyCollection/platform_maker.md new file mode 100644 index 00000000..524cb70a --- /dev/null +++ b/vocabularyCollection/platform_maker.md @@ -0,0 +1,11 @@ +| platform_maker | definition | status | +|:----- |:----- |:----- | +| Teledyne Webb Research | [uri](http://vocab.nerc.ac.uk/collection/B75/current/ORG01077/)| pending | +| Kongsberg Maritime AS | [uri](http://vocab.nerc.ac.uk/collection/B75/current/ORG00360/)| pending | +| Scripps Institution of Oceanography | [uri](https://edmo.seadatanet.org/report/1390) | pending | +| Alseamar | [uri](https://edmo.seadatanet.org/report/5241) | pending | +| University of Washington | [uri](https://edmo.seadatanet.org/report/3839) | pending | +| IRobot | [uri](http://vocab.nerc.ac.uk/collection/B75/current/ORG01747/) | pending | +| Hydroid Inc. | [uri](http://vocab.nerc.ac.uk/collection/B75/current/ORG01760/) | pending | +| Huntington Ingalls Industries | [uri](https://edmo.seadatanet.org/report/5678) | pending | +| Hefring Engineering | Manufacturer of the Oceanscout glider model. [url](https://www.hefring.com/) | pending | diff --git a/vocabularyCollection/platform_model.md b/vocabularyCollection/platform_model.md new file mode 100644 index 00000000..c99e2cd8 --- /dev/null +++ b/vocabularyCollection/platform_model.md @@ -0,0 +1,16 @@ +| platform_model | definition | status | +|:------ |:------- |:------- | +| Seaglider | Generic name for Seaglider models | pending | +| iRobot Seaglider M1 | [uri](http://vocab.nerc.ac.uk/collection/B76/current/B7600025/) | pending | +| UoW Seaglider M1 | [uri](http://vocab.nerc.ac.uk/collection/B76/current/B7600024/) | pending | +| KM Seaglider M1 | [uri](http://vocab.nerc.ac.uk/collection/B76/current/B7600002/) | pending | +| HYD Seaglider M1 | [uri](http://vocab.nerc.ac.uk/collection/B76/current/B7600026/) | pending | +| UoW Seaglider M6 | [uri](http://vocab.nerc.ac.uk/collection/B76/current/B7600030/) | pending | +| Slocum | Generic name for Slocum glider models | pending | +| Slocum G1 | [uri](http://vocab.nerc.ac.uk/collection/B76/current/B7600013/) | pending | +| Slocum G2 | [uri](http://vocab.nerc.ac.uk/collection/B76/current/B7600001/) | pending | +| Slocum G3 | [uri](http://vocab.nerc.ac.uk/collection/B76/current/B7600014/) | pending | +| Seaexplorer | Glider manufactured by Alseamar. [url](https://www.alseamar-alcen.com/index.php/products/underwater-glider/seaexplorer) | pending | +| SIO Spray | [uri](http://vocab.nerc.ac.uk/collection/B76/current/B7600027/) | pending | +| SIO Spray2 | [uri](http://vocab.nerc.ac.uk/collection/B76/current/B7600028/) | pending | +| OceanScout | Glider model manufactured by Hefring Engineering [url](https://www.hefring.com/oceanscout) | pending | diff --git a/vocabularyCollection/platform_serial_number_prefix.md b/vocabularyCollection/platform_serial_number_prefix.md new file mode 100644 index 00000000..8481be2b --- /dev/null +++ b/vocabularyCollection/platform_serial_number_prefix.md @@ -0,0 +1,6 @@ +| platform_serial_number_prefix | definition | status | +|:------ |:------ |:------ | +| unit | serial number prefix for Slocum | pending | +| sg | serial number prefix for SeaGliders | pending | +| sea | serial number prefix for SeaExplorer | pending | +| sp | serial number prefix for Spray | pending | diff --git a/vocabularyCollection/platform_type.md b/vocabularyCollection/platform_type.md new file mode 100644 index 00000000..217b0994 --- /dev/null +++ b/vocabularyCollection/platform_type.md @@ -0,0 +1,4 @@ +| platform_type | definition | status | +|:------- |:------- |:------- | +| sub-surface gliders | http://vocab.nerc.ac.uk/collection/L06/current/27/ | pending | + diff --git a/vocabularyCollection/rtqc_method.md b/vocabularyCollection/rtqc_method.md new file mode 100644 index 00000000..540d2265 --- /dev/null +++ b/vocabularyCollection/rtqc_method.md @@ -0,0 +1,9 @@ +| rtqc_method | definition | status | +|:---------|:-------|:--------| +| QUARTOD | [url](https://ioos.noaa.gov/project/qartod/) | pending | +| ego quality control manual | [DOI](http://doi.org/10.13155/51485) | pending | +| SOCIB QC manual | [DOI](https://doi.org/10.25704/q4zs-tspv) | pending | +| gliders tools – SOCCO | [DOI](https://doi.org/10.3389/fmars.2019.00738) | pending | +| UEA Seaglider toolbox | [url](https://bitbucket.org/bastienqueste/uea-seaglider-toolbox/src/toolbox/) | pending | +| CoTeDe | [DOI](https://doi:10.21105/joss.02063) | pending | +| ANFOG data management user's manual | [url](https://imos.org.au/fileadmin/user_upload/shared/ANFOG/ANFOG_DataManagement_UsersManual_v5_Nov28.pdf) | pending | diff --git a/vocabularyCollection/sensor_model.md b/vocabularyCollection/sensor_model.md new file mode 100644 index 00000000..3814daf6 --- /dev/null +++ b/vocabularyCollection/sensor_model.md @@ -0,0 +1,2 @@ +| sensor_model | definition | status | +|:----------|:----------|:----------| diff --git a/vocabularyCollection/tableOfControlledVocab.adoc b/vocabularyCollection/tableOfControlledVocab.adoc new file mode 100644 index 00000000..c902d1ae --- /dev/null +++ b/vocabularyCollection/tableOfControlledVocab.adoc @@ -0,0 +1,147 @@ +[cols=",",options="header",] +|=========================================================================================== +|image:figures/image1.png[image,width=164,height=144] a| +OceanGliders 1.0 format - Vocabulary Collections + +|=========================================================================================== + +//// +* [[Vocabulary Collections]] +//// +== Vocabulary Collections +The series of concepts of the https://github.com/OceanGlidersCommunity/OG1.0-user-manual[OG1.0 format] are controlled by a set of vocabulary collections managed by the OceanGliders data management team and other governance bodies. + +These concepts are listed in the table below. Each concept is linked to its collection of vocabularies. Each collection has a status attribute. + +[square] +* The *pending* entries are being discussed by the community and are not yet supported by the OG1.0 format. + +* The *validated* entries have been validated by the vocabulary working group and can be used in the OG1.0 format. + +* The *published* entries have been published by the host when it exists. + + +Vocabulary collections that are not governed by OceanGliders do not follow the *status* convention described above. + +=== "host" and "governance" of the vocabulary collection + +**host** : The host is the entity that is serving the *published* vocabulary collections and enable machine to machine communication. + +**governance** : Governance refers to the entity in charge of the maintenance, evolution and publication of the vocabulary collection. + +=== Request a new entry +**TO BE UPDATED WITH EMMA and NVS TEAM** + +To request a new entry in the table below, one should submit an issue to this repository entitle `*_new entry for table _*` . +The issue must indicate the value of the new entry and all its relevant attributes described in the corresponding table. + +=== Validation process + +A working group on controlled vocabulary collections will review the requests regularly. +While a continuous update of the controlled vocabularies is anticipated, the working group will update the vocabulary collection at least twice a year. + +=== Table of controlled vocabularies + +|=== +|OceanGliders reference name | Collection name | OceanGliders subset | Request new terms | Governance + + | platform | https://vocab.nerc.ac.uk/collection/L06/current/[L06 - SeaVoX Platform Categories] | https://vocab.nerc.ac.uk/collection/L06/current/27/[OceanGliders vocabulary subset] | https://github.com/nvs-vocabs/L06/issues | OceanGliders + | institution | https://edmo.seadatanet.org/[EDMO code] | No subset available for this collection | *tbd* | SeaDataNet + | platform_serial_number_prefix | *tbd* | https://github.com/OceanGlidersCommunity/OG-format-user-manual/blob/vturpin-patch-3-VocabularyCollectionSection/vocabularyCollection/serial_number_prefix.md[pending list] | *tbd* | OceanGliders + | program | *tbd* | *tbd* | *tbd* | OceanOPS + | oceangliders_site | *tbd* | *tbd* | *tbd* | OceanOPS + | contributors_role | *tbd* | *OceanGliders vocabulary subset tbd* https://github.com/OceanGlidersCommunity/OG-format-user-manual/blob/vturpin-patch-3-VocabularyCollectionSection/vocabularyCollection/contributors_role.md[pending list] | *tbd* | OceanGliders + | agencies_role | https://vocab.nerc.ac.uk/search_nvs/C86/[C86 - SeaDataNet contact and security access roles] | *OceanGliders vocabulary subset tbd* https://github.com/OceanGlidersCommunity/OG-format-user-manual/blob/vturpin-patch-3-VocabularyCollectionSection/vocabularyCollection/agencies_role.md[pending list] | *tbd* | OceanGliders + | agencies_id | https://edmo.seadatanet.org/[EDMO code] | No subset available for this collection | *tbd* | SeaDataNet + | naming_authority | https://edmo.seadatanet.org/[EDMO code] | No subset available for this collection | *tbd* | SeaDataNet + | institution | https://edmo.seadatanet.org/[EDMO code] | No subset available for this collection | *tbd* | SeaDataNet + | rtqc_method | https://github.com/OceanGlidersCommunity/OG-format-user-manual/blob/vturpin-patch-3-VocabularyCollectionSection/vocabularyCollection/rtqc_method.md[Real Time Quality Control methods] | *tbd* https://github.com/OceanGlidersCommunity/OG-format-user-manual/blob/vturpin-patch-3-VocabularyCollectionSection/vocabularyCollection/rtqc_method.md[pending list] | *tbd* | OceanGliders + | phase_calculation_methodology | Phase calculation methods | *tbd* | *tbd* |OceanGliders + | platform_model | https://vocab.nerc.ac.uk/search_nvs/B76/[B76 - BODC Platform Models] | *OceanGliders vocabulary subset tbd* https://github.com/OceanGlidersCommunity/OG-format-user-manual/blob/vturpin-patch-3-VocabularyCollectionSection/vocabularyCollection/platform_model.md[pending list] | *tbd* | OceanGliders + | ICES_code | https://vocab.ices.dk/?codetypeguid=7f9a91e1-fb57-464a-8eb0-697e4b0235b5[ICES reference table] | No subset available for this collection | *tbd* | ICES + | platform_maker | http://vocab.nerc.ac.uk/collection/L35/current/[L35 - SenseOcean device developers and manufacturers] | *OceanGliders vocabulary subset tbd* https://github.com/OceanGlidersCommunity/OG-format-user-manual/blob/vturpin-patch-3-VocabularyCollectionSection/vocabularyCollection/platform_maker.md[pending list] | *tbd* | OceanGliders + | battery_type | *tbd* | *tbd* https://github.com/OceanGlidersCommunity/OG-format-user-manual/blob/vturpin-patch-3-VocabularyCollectionSection/vocabularyCollection/battery_type.md[pending list] | *tbd* | OceanGliders + | telecom_type | https://vocab.nerc.ac.uk/search_nvs/R10/[*_e.g. R10 - Argo transmission systems_*] | *tbd* https://github.com/OceanGlidersCommunity/OG-format-user-manual/blob/vturpin-patch-3-VocabularyCollectionSection/vocabularyCollection/telecom_type.md[pending list] | *tbd* | OceanGliders + | tracking_system | *tbd* | *tbd* https://github.com/OceanGlidersCommunity/OG-format-user-manual/blob/vturpin-patch-3-VocabularyCollectionSection/vocabularyCollection/tracking_system.md[pending list] | *tbd* | OceanGliders + | sensor_model | https://vocab.nerc.ac.uk/search_nvs/L22/[L22 - Seavox Device Catalog] | https://vocabdev.nerc.ac.uk/scheme/GLIDER_SENSORS/current/[OceanGliders vocabulary subset] | https://github.com/nvs-vocabs/L22/issues | OceanGliders + | data_mode | *tbd* | *tbd* https://github.com/OceanGlidersCommunity/OG-format-user-manual/blob/vturpin-patch-3-VocabularyCollectionSection/vocabularyCollection/data_mode.md[pending list] | *tbd* | OceanGliders + | phase | *tbd* | *tbd* https://github.com/OceanGlidersCommunity/OG-format-user-manual/blob/vturpin-patch-3-VocabularyCollectionSection/vocabularyCollection/phase.md[pending list] | *tbd* | OceanGliders + | variable names | https://vocab.nerc.ac.uk/search_nvs/OG1/[OG1 - OceanGliders Parameter Usage Vocabulary] | https://vocab.nerc.ac.uk/search_nvs/OG1/ | https://github.com/nvs-vocabs/OG1/issues | OceanGliders + | sensor type | http://vocab.nerc.ac.uk/collection/R25/current/[*_e.g. R25 - Argo sensor types_*] | http://vocab.nerc.ac.uk/collection/R25/current/ | *tbd* | OceanGliders + + +|=== + +* sensor type will be added to the list of control vocab in the format following emma exemplar. + +# Exemplars + +## Global attributes + + +|=== +| Global attribute | Exemples + +| platform | :platform = "sub-surface gliders"; +| platform_vocabulary | :platform_vocabulary = https://vocab.nerc.ac.uk/collection/L06/current/27/; +| institution | :institution = "OGS"; +| institution_vocabulary | :institution_vocabulary = "https://edmo.seadatanet.org/report/120"; +*_HERE WE NEED TO ADD institution_vocabulary IN THE FORMAT_* +| program | :program = "OGS glider program" ; +| program_vocabulary | :program_vocabulary = ; +*_HERE WE NEED TO ADD program_vocabulary IN THE FORMAT_* +| oceangliders_site | :oceangliders_site = "CONVEX"; +| oceangliders_site_vocabulary | :oceangliders_site_vocabulary = ; +*_HERE WE NEED TO ADD oceangliders_site_vocabulary IN THE FORMAT_* +| contributor | :contributor = "Elena Mauri,Silvina Logarzo" +| contributor_role | :contributor_role = "principal investigator,Data scientist"; +| contributor_role_vocabulary | :contributor_role_vocabulary = "http://vocab.nerc.ac.uk/collection/W08/current/CONT0004/,http://vocab.nerc.ac.uk/collection/W08/current/CONT0006/"; +| agency | :agency = "OGS,CNR,Coriolis"; +| agency_vocabulary | :agency_vocabulary = "https://edmo.seadatanet.org/report/120,https://edmo.seadatanet.org/report/227,https://edmo.seadatanet.org/report/227"; +*_HERE WE NEED TO ADD agency_vocabulary IN THE FORMAT_* +| agency_role | :agency = "operating agency,funding agency,data assembly center"; +| agency_role_vocabulary | :agency_role_vocabulary = ",,"; + +|=== + +## Variable Attributes +### Platform Information +*_Which option do we follow here?_* +|=== +| Variable | Variable attribute | exemplar + +| PLATFORM_MODEL | + +:long_name = "model of the glider"; + +:platform_model_vocabulary = "https://vocab.nerc.ac.uk/collection/B76/current/B7600002"; + + + +:long_name = "model of the glider"; + +:platform_model_vocabulary = "https://vocab.nerc.ac.uk/collection/B76/current/B7600001/"; | +Kongsberg Maritime Seaglider M1 glider + +Teledyne Webb Research Slocum G2 glider + +| *OR* | | + +| ICES_CODE | +:long_name = "Trieste_1"; + +:ices_code_vocabulary = "https://vocab.ices.dk/?CodeID=230740"; | + + + +| PLATFORM_MAKER | +:long_name = "Kongsberg Maritime AS"; + +:platform_maker_vocabulary = "https://vocab.nerc.ac.uk/collection/B75/current/ORG00360/"; + + + +:long_name = "Teledyne Webb Research"; + +:platform_maker_vocabulary = "https://vocab.nerc.ac.uk/collection/B75/current/ORG01077/"; | +|=== + + +https://github.com/OceanGlidersCommunity/OG-format-user-manual/edit/emma/Vocabs/src/vocabularyCollection/vocabulary_guidance.md[Check Emma's branch here] + + + diff --git a/vocabularyCollection/telecom_type.md b/vocabularyCollection/telecom_type.md new file mode 100644 index 00000000..4c560750 --- /dev/null +++ b/vocabularyCollection/telecom_type.md @@ -0,0 +1,6 @@ +| telecom_type | description | status | +|:------ |:------- |:------ | +| iridium| Communication system based on IRIDIUM satellite constellation use by the glider when surfacing to relay to landstation (auto attendant computer) navigational fix, data and receive further instruction for command and control | pending | +| freewave | Communication system based on Free Wave RF Modem (line of sight) use to relay to landstation (auto attendant computer) navigational fix, data and receive further instructions for command and control | pending | +| argos | | pending | +| cellular mobile | | pending | diff --git a/vocabularyCollection/tracking_system.md b/vocabularyCollection/tracking_system.md new file mode 100644 index 00000000..375de8de --- /dev/null +++ b/vocabularyCollection/tracking_system.md @@ -0,0 +1,6 @@ +| tracking_system | description | status | +|:------ |:------ |:------ | +| gps | Global Positioning System is a satellite based radionavigation system | pending | +| argos doppler | ARGOS constellation satellite-based system used to distribute location data | pending | +| Beidou | | pending | +| acoustic | underwater location tracking | pending | diff --git a/vocabularyCollection/variable_names.md b/vocabularyCollection/variable_names.md new file mode 100644 index 00000000..fc93c982 --- /dev/null +++ b/vocabularyCollection/variable_names.md @@ -0,0 +1,2 @@ +| variable_names| description | status | +|:------ |:------ |:------|