 |
OceanGliders 1.0 format - Vocabulary Collections Navigation: Github repository Terms of reference Vocabulary collections |
|---|
Controlled vocabulary
A controlled vocabulary is a curated list of terms that have been pre-defined and approved for use within a specific context, such as data management. This type of vocabulary serves as a standardized set of terms used to monitor content consistently, ensuring uniformity, precision and analysis.
Use controlled vocabulary
Each OG1.0 controlled vocabulary (list of terms) is referenced in this document. To find the appropriate term, click on the link to the list and find the term that suits your needs.
Each attribute or variable controlled by a vocabulary is associated with a attribute called *_vocabulary in the format. This attribute refers to the uri of the term.
For instance global attribute platform is a controlled vocabulary. In the format description it is followed by the global attribute platform_vocabulary.
In this case:
-
platform = "sub-surface gliders" ;
-
platform_vocabulary = "https://vocab.nerc.ac.uk/collection/L06/current/27/" ;
Vocabulary Collections
The series of concepts of the 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.
-
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.
Requesting a new term
To request a new term for an existing vocabularly collection please create an new issue in the OceanGliders repository including the label 'vocab'.
New terms may also be requested via the 'Request new term' URLs in the table below. Please clearly indicate in the ticket 'for approval by OceanGliders vocabularly working group' and include as much detail as possible.
Requesting a new collection
If you are unsure where a new term fits and believe a new collection is needed, please create an issue in the OceanGliders repository clearly including the title 'vocab'.
Validation process
A working group for controlled vocabulary collections will review the requests regularly to approve new terms. Simple terms adding to existing collections will have a quick turnaround. Requests for new vocabularly collections will take longer to review and approve.
Table of controlled vocabularies for "mandatory" metadata in the OG 1.0 format
| OceanGliders reference name | Collection URL or Scheme URL | Examples | Request new terms | Governance |
|---|---|---|---|---|
platform |
SeaDataNet and MarineXML Vocabulary Content Governance Group |
|||
contributors_role |
Sensor Web Enablement Marine Profiles |
|||
contributing_institutions_role |
Sensor Web Enablement Marine Profiles |
|||
institution_id |
SeaDataNet |
|||
rtqc_method** |
pending |
OceanGliders |
||
platform_model |
British Oceanographic Data Centre |
|||
sensor type |
SeaDataNet |
|||
sensor_model |
GLIDER_SENSORS from collection L22 - SeaVoX Device Catalogue |
OceanGliders |
||
data_mode** |
pending |
OceanGliders |
||
parameter |
OceanGliders |
*only operating institution is mandatory **still in development
Table of controlled vocabularies for "highly desirable" or "suggested" metadata in the OG 1.0 format
| OceanGliders reference name | Collection name | OceanGliders subset | Request new terms | Governance |
|---|---|---|---|---|
platform_serial_number_prefix_*** |
tbd |
tbd |
OceanGliders |
|
program** |
tbd |
tbd |
tbd |
OceanOPS |
oceangliders_site |
tbd |
tbd |
tbd |
OceanOPS |
naming_authority |
No subset available for this collection |
tbd |
SeaDataNet |
|
ICES_code |
No subset available for this collection |
tbd |
ICES |
|
platform_maker & sensor_maker |
OceanGliders vocabulary subset tbd pending list |
tbd |
OceanGliders |
|
battery_type** |
tbd |
tbd pending list |
tbd |
OceanGliders |
telecom_type** |
tbd pending list |
tbd |
OceanGliders |
|
tracking_system** |
tbd |
tbd pending list |
tbd |
OceanGliders |
phase |
tbd |
tbd pending list |
tbd |
OceanGliders |
QC_flag |
IODE Primary Level quality flags |
n/a |
IODE |
**still in development
===Examples Examles of how vocabularies are implemented in the OG file are in the og_format_examples.
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/"; |