Skip to content

OAEDataManagementProtocol

URI: OAEDataManagementProtocol

Name: OAEDataManagementProtocol

Classes

Class Description
AnalyzingInstrument Base class for scientific instruments used in analyzing samples for measurement.
        CO2GasDetector CO2 gas detector with standard gas calibration.
        CRMInstrument Instrument calibrated with Certified Reference Materials, used for DIC and TA measurements.
        PHInstrument pH measurement instrument with dye-based calibration.
Any None
BaseVariable Basic variable fields across all (including non-measured) variables
        NonMeasuredVariable Non-measured variable for data from external sources (e.g., satellite, model outputs, published data) that are not directly measured by the project but included in the dataset.
        Variable Base class for all variable types. Contains common identification and description fields shared by all variables. Reference: OAPMetadata XSD variables.xsd - variable, basic_variable
                CalculatedVariable Variable that is calculated or derived from other variables.
                ObservedPropertyVariable Variable that is directly measured in-situ using instruments. Reference: OAPMetadata XSD variables.xsd - basic_measured_observation_base
                        ContinuousMeasuredVariable Fields for continuous sampling information.
                                ContinuousDICVariable Dissolved Inorganic Carbon (DIC) measured variable from continuous autonomous sensor.
                                ContinuousPHVariable pH measured variable from continuous autonomous sensor
                                ContinuousSedimentVariable Measured sediment variable collected from continuous autonomous sensor
                                ContinuousTAVariable Total Alkalinity (TA) measured variable from continuous autonomous sensor
                        DiscreteMeasuredVariable Analyzing instrument information fields, only applied to discretely measured variables. The instrument type can be narrowed in subclasses using slot_usage.
                                DiscreteCO2Variable CO2 discrete (bottle) measured variable (pCO2/fCO2). Reference: OAPMetadata XSD variables.xsd - co2_discrete
                                DiscreteDICVariable Dissolved Inorganic Carbon (DIC) measured variable from discrete bottle samples. Uses CRM-calibrated instrument and includes sample preservation information. Reference: OAPMetadata XSD variables.xsd - DIC_measured
                                DiscretePHVariable pH measured variable with dye-based spectrophotometric measurement. Reference: OAPMetadata XSD variables.xsd - pH_measured
                                DiscreteSedimentVariable Measured sediment variable collected from discrete bottle samples
                                DiscreteTAVariable Total Alkalinity (TA) measured variable from discrete bottle samples
                                HPLCVariable HPLC (High-Performance Liquid Chromatography) measured variable for pigment analysis. Always measured, not calculated.
Calibration Base calibration information for instruments.
        CO2Calibration CO2 gas detector calibration with standard gas information.
        CRMCalibration Calibration using Certified Reference Materials, used for DIC and TA instruments.
        PHCalibration pH instrument calibration with dye information.
Container None
Dataset Abstract base class for all dataset types. Contains fields common to both field/observational and model simulation datasets. Generally following guidelines & best practices as outlined in science-on-schema.org
        FieldDataset A field or observational dataset related to an OAE experiment. Contains fields specific to in-situ data collection such as platform information, calibration files, QC flags, and measured variables.
        ModelOutputDataset A model simulation output dataset. Contains fields specific to computational model output including simulation configuration, output variables, and hardware information.
DosingConcentration Details of tracer concentration information
DosingDetails An abstract class (used as a mixin, not implemented directly) for detailing the required fields that are specific to an Experiment with active dosing (e.g. type "Tracer", "Intervention", or "InterventionWithDosing")
Experiment Abstract base class for all experiment types. Contains fields common to both in-situ and model experiments.
        InSituExperiment Experiment metadata for in-situ studies (interventions, tracer studies, etc.). Contains fields specific to field-based experiments that don't apply to model experiments.
                Intervention Additional metadata that applies to experiments where an intervention, such as an alkalinity addition, was conducted.
                        InterventionWithTracer Additional metadata that applies to hybrid experiments where an intervention was conducted simultaneously alongside a tracer study, using the same instrumentation.
                Tracer Additional metadata that applies to experiments where a tracer study was conducted
        Model A computational model experiment related to OAE.
ExternalProject A research project that is not directly managed by the OAE project, but whose location is proximal to the OAE project and whose data may be relevant to understanding the context or impacts of OAE activities.
GeoCoordinates A geographic coordinate in decimal degrees.
GeoShape The geographic shape of a place. A GeoShape can be described using several properties whose values are based on latitude/longitude pairs. Either whitespace or commas can be used to separate latitude and longitude; whitespace should be used when writing a list of several such points. (imported from schema.org)
HardwareConfiguration Details about the computational hardware used to run a model simulation.
InterventionDetails An abstract class (used as a mixin, not implemented directly) for detailing the required fields that are specific to an Experiment with type "Intervention"
MeasuredCO2Fields Fields applied to all measured CO2 variable types (discrete and continuous)
MeasuredDICFields Fields applied to all measured DIC variable types (discrete and continuous)
MeasuredPHFields Fields applied to all measured pH variable types (discrete and continuous)
MeasuredSedimentFields Fields applied to all measured sediment variable types (discrete and continuous)
MeasuredTAFields Fields applied to all measured TA variable types (discrete and continuous)
ModelComponent A component of a model (e.g., physics, biogeochemistry/ecosystem).
ModelGrid Details about a model grid. Use multiple ModelGrid entries to describe nested or multi-grid configurations.
ModelInputDetails Details about input data sources used to drive the model.
MonetaryGrant None
NamedLink A link to a resource with a name and URL.
Organization None
Permit A permit associated with the project.
Person Information about a researcher or investigator involved in the experiment.
Place A geospatial area of interest, defined by a bounding box, polygon/line, or a point designated as a pair of geo-coordinates.
        DosingLocation A specific location of dosing for an OAE intervention and/or tracer study. Can be a point, line, or bounding box
        SpatialCoverage A bounding box defined by latitude and longitude coordinates.
Platform None
Project A project conducting OAE field trials or modeling.
PropertyValue None
QCFields Quality control fields applicable to measured and calculated variables. Not applied to socioeconomic variables.
SamplePreservation Sample preservation information for DIC and TA measurements. Reference: OAPMetadata XSD variables.xsd - sample_preservation
StandardGas Standard gas used for CO2 calibration.
TracerDetails An abstract class (used as a mixin, not implemented directly) for detailing the required fields that are specific to an Experiment with type "Tracer"
VerticalExtent The vertical extent of a place or structure in meters.
VocabularyItemReference None

Slots

Slot Description
accuracy Accuracy of the instrument measurements
additional_details Open text area to include additional information
affiliation Institutional affiliation of the investigator
agency_contact The point of contact at the permitting agency
alkalinity_dosing_effluent_density Fixed density or provide link/source to effluent density data if applicable
alkalinity_feedstock Examples may include: olivine, potassium hydroxide, magnesium hydroxide, lime...
alkalinity_feedstock_co2_removal_potential Maximum CO₂ removal potential of a feedstock material
alkalinity_feedstock_custom Custom description of alkalinity feedstock when using a feedstock type not li...
alkalinity_feedstock_description Information such as feedstock source, characteristics, impurities, dilution p...
alkalinity_feedstock_form The phase upon delivery to the ocean
alkalinity_feedstock_processing Method(s) used to process the alkalinity feedstock
alkalinity_feedstock_processing_custom Custom description of alkalinity feedstock processing method when 'other' is ...
alkalinity_perturbation_description Description of the alkalinity perturbation applied in the simulation
amount
analyzing_instrument Instrument used to analyze the water samples or measure the water body contin...
analyzing_method Additional information describing how the sample was analyzed
appropriate_use_quality Climate quality is defined as measurements of quality sufficient to assess lo...
approval_document Filename(s) of permitting documents included, separated by commas
arrangement The grid arrangement of orthogonal physical quantities (e
atmospheric_forcing Atmospheric forcing data source(s)
author_list_for_citation Author list in the format of Lastname1, Firstname1 Middlename1; Lastname2, Fi...
bathymetry Bathymetry data source(s)
blank_correction Whether the reported variables were corrected for blank, and if so, how they ...
boundary_conditions Boundary condition data source(s)
box A box defined by two latitude-longitude points, southwest and northeast
calculation_method_and_parameters Information about how the variable was calculated and the parameters used in ...
calculation_software_version Version of the software used to calculate reported values from raw values
calibration Calibration information for this instrument
calibration_certificates Information about calibration certificates
calibration_files A list of supplementary file names containing coefficients and techniques use...
calibration_location Factory calibration, lab calibration, or field calibration
calibration_temperature Temperature at which calibration was performed
changes_to_evolution_of_permit_criteria e
co2_reported_temperature In Celsius
codebase Link to model code repository
colocated_operations A description is required if any nearby operations exist that may influence t...
concentration Concentrations of the CO2 standard gases that are used to calibrate the CO2 s...
concentration_basis Whether measurements are expressed per unit volume or per unit mass (for DIC,...
correction_description Description of how the preservative effect was corrected for
correction_for_unpurified_dye Correction method applied if dye was not purified
country The country in which the organization belongs
cpu_gpu_details Details about CPU/GPU hardware or link to specifications
crm_batch_number Batch number of the Certified Reference Material
crm_manufacturer Manufacturer of the Certified Reference Material (e
curve_fitting_method Curve fitting method used to determine the alkalinity
data_conflicts_and_unreported_data If data exist that are or have been used by the project but are not provided ...
data_product_type "Controlled vocabulary" One of the three choices: (a) Originally collected da...
data_submitter
dataset_type Selected controlled vocabularies for data types relevant to mCDR have been re...
dataset_type_custom Custom "data type" when an appropriate value is not found in the controlled v...
dataset_variable_name The name for the variable as it is identified in the dataset data file
dataset_variable_name_qc_flag If applicable, the column header name used for the quality control flag corre...
dataset_variable_name_raw If applicable, the column header name used for the raw data corresponding to ...
datasets
description A narrative description of the thing
detector_type Type of the CO2 gas detector (E
dosing_delivery_type Type of dosing delivery method
dosing_depth Depth in meters
dosing_description Please be descriptive
dosing_dispersal_hydrologic_location Descriptive dosing location
dosing_location Provide latitude and longitude in decimal degrees
dosing_location_file Exact path and filename for the location file (relative to root path of proje...
dosing_regimen A human readable summary description of the dosing regimen / frequency
dye_correction_method Method used to correct for dye effects
dye_purified Whether the dye has been purified
dye_type_and_manufacturer Type of indicator dye and any detailed information about it, e
email Contact email address
end_date
end_datetime End date and time of experiment in UTC ISO-8601
equilibration Whether the feedstock was pre-equilibrated or unequilibrated
experiment_id The experiment to which the data belong
experiment_leads Provide details for each experiment lead / principal investigator (PI) includ...
experiment_type The type of mCDR experiment conducted
experiments
fair_use_data_request A statement from the data producer regarding how this dataset should be used
field_replicate_information Repetition of sample collection and measurement, e
filenames
frequency How often the instrument was calibrated
funder
funding Include the name of the funder, funder country, project title, project ID, an...
genesis
geo Entities that have a somewhat fixed, physical extension
grid_details Details about the model grid(s)
grid_geometry Descriptive structure of the grid (e
grid_name Name of the grid (e
grid_type Role of this grid in a nested or multi-grid configuration
hardware_configuration Details about the computational hardware used for the simulation
headspace_volume Volume (in mL) of headspace (water displaced in the flask plus volume of the ...
horizontal_resolution_range Description of horizontal resolution (e
hplc_lab The name of the lab where the HPLC analysis was run (e
hplc_lab_technician Name and contact information for HPLC technician
identifier A unique identifier for the thing
identifier_type Type of Researcher ID (e
initial_conditions Initial condition data source(s)
input_details Details about input data sources used to drive the model
instrument_type Type of instrument used to analyze samples or measure continuously
instrument_type_custom
is_derived_value Indicates that the field in question is a derived value as opposed to one mea...
is_provided_as_a_file Indicates that the field in question is provided as a file
last_calibration_date Date and time of most recent calibration in UTC
latitude Latitude in decimal degrees of a location
license Link a Dataset to its license to document legal constraints by adding a schem...
line A line is a point-to-point path consisting of two or more points
long_name Full descriptive name of the variable
longitude Longitude in decimal degrees of a location
machine Name of the machine or cluster (e
manufacturer Manufacturer name of the instrument
max_depth_in_m Maximum depth of observation in meters
max_height_in_m Maximum height of observation (in meters) for above ground aerial coverage
mcdr_pathway The Marine Carbon Dioxide Removal (MCDR) pathway being studied
measurement_researcher The name of the PI whose research team measured or derived this parameter
measurement_temperature Temperature at which pH was measured
memory Memory available (e
metadata_builder_git_hash Git commit hash of the metadata-builder UI
meteorological_and_tidal_data Include links to relevant open datasets if referenced in the experiment but n...
method_reference Citation or reference for the calibration method
min_depth_in_m Minimum depth of observation in meters
min_height_in_m Minimum height of observation (in meters) for above ground aerial coverage
missing_value_indicators The indicator used to represent missing values in the data file, e
model Model number or name of the instrument
model_component_type The type of model component (physics, BGC/ecosystem, or other)
model_component_type_custom
model_components Components of the model (e
model_configuration Links to model configuration files or documentation
model_output_variables Checklist of variables included in the model simulation output
n_nodes Number of nodes in the grid (for unstructured grids)
n_x Number of grid points in the x-direction
n_y Number of grid points in the y-direction
n_z Number of vertical coordinate levels
name A human-readable name for the thing
observation_type
operating_system Operating system used (e
other_detailed_information Any additional information about this variable
output_frequency Frequency of model output (e
owner Institution that owns the platform
parallelization Parallelization details (e
permit_id The unique identifier or number associated with this permit
permit_type The category of permit (E
permits Associated permit number(s)
permitting_authority The group that issued the permit
ph_of_standards pH values of the calibration standards used
ph_reported_temperature The input could be a constant temperature value, or something like, in-situ t...
phone Contact phone number
physical_site_description Provide information to help characterize the field site and provide context w...
platform_id Synonymous with glider ID, cruise ID
platform_info
platform_type Controlled vocabularies for the types of the platform: https://www
precision Precision of the instrument measurements
preservative As described, e
previous_or_ongoing_colocated_research This field is required for co-located operations that potentially impact the ...
processing_code If applicable, link to any code for processing of raw forcing and input data ...
processing_of_input_data Narrative description of any processing applied to input data before use in t...
project
project_id The project to which the submitted data belong
project_leads Provide details for each project lead / principal investigator (PI) including...
protocol_git_hash Git commit hash of the oae-data-protocol
public_comments If possible, please provide public comments concatenated into a single pdf
qc_flag_scheme Describe what the quality control flags stand for, e
qc_researcher The name of the PI whose research team QCed this parameter
qc_researcher_institution The institution of the PI whose research team QCed this parameter
qc_steps_taken Describe what QC steps have been taken to improve the quality of the data (e
raw_data_calculation_method The method used to calculate reported values from raw sensor data
references Links or DOIs to any reference(s) relevant to the model components/developmen...
region Region covered by the grid
related_links Links to websites or documents related to the external research project
research_project Project, which the data collection is part of
resolution Resolution of the CO2 sensor
river_sediment_flux_details River and/or sediment flux data source(s)
role Role of the investigator in the experiment (e
sample_preservation How the samples were preserved for analysis
sampling
sampling_instrument_type
sampling_instrument_type_custom
sampling_method Method used to collect samples
sea_names Names of the seas where the data collection takes place, See Controlled Vocab...
seawater_volume Volume (in mL) of seawater in the flask
sediment_sampling_depth Depth that sediment was collected below sediment surface
sediment_sampling_method e
sediment_sampling_water_depth Water depth where sediment was collected
sediment_type e
serial_number Serial number of the instrument
simulation_type Whether this is a counterfactual (control/baseline) or perturbation simulatio...
social_context_site_description Details may include:
social_research_conducted_to_date A description of any social research conducted to date
spatial_coverage Latitude/longitude bounds of project site (e
spin_up_protocol Description of the model spin-up process
standard_gas_info Standard gases used for calibration
standard_identifier
start_date
start_datetime Start date and time of experiment in UTC ISO-8601
storage Storage available (e
storage_method How the samples were stored before the measurement
technique_description Details of the calibration technique used
temperature_correction_method Method used to correct pH for temperature
temporal_coverage Start date and end date (if known) of the project in ISO-8601 interval format...
term
tidal_forcing Tidal forcing data source(s)
time_period The time period during which the permit will be applicable, or expected durat...
time_stepping_scheme Time-stepping method and time step used in the simulation
titration_cell_type Whether the titration cell is open or closed
titration_type Type of the titration used to determine alkalinity
tracer_concentration Fixed concentration or provide link/source to tracer concentration separately...
tracer_details state the kind of tracer used (e
tracer_form The form of tracer upon delivery to the ocean (e
uncertainty It is recommended to provide uncertainty for each data point in the data file
uncertainty_definition A description of the uncertainties involved in this method
unit
units Unit of measurement for this variable
uri
url The URL of the linked resource
variables
version Version of the oae-data-protocol
vertical_coordinate_type The vertical grid coordinate type (e
vertical_coverage Minimum and maximum depths of observation in meters
vertical_resolution_range Description of vertical resolution (e
volume The volume of preservative used
water_vapor_correction_method How the water vapor pressure inside the equilibrator was determined

Enumerations

Enumeration Description
AlkalinityFeedstockForm Physical form of the alkalinity feedstock upon ocean delivery
AlkalinityFeedstockProcessing Methods used to process alkalinity feedstock
AnalyzingInstrumentType
AppropriateUseQuality
CalibrationLocation Where the calibration was performed
ConcentrationBasis Whether concentration measurements are expressed per unit volume or per unit ...
DataProductType
DatasetType Type of dataset being submitted
DosingDeliveryType Types of dosing delivery methods
EquilibrationStatus Equilibration status of the alkalinity feedstock
ExperimentType Types of mCDR experiments
FeedstockType Types of materials used for alkalinity addition, as sourced from NCEI's OCADS...
GenesisType
GridType Type of grid in a multi-grid or nested model configuration
HydrologicLocation Hydrologic location types for dosing
MassConcentrationUnit
MCDRPathway Type of marine Carbon Dioxide Removal (mCDR) pathways
ModelComponentType Type of model component
ModelOutputVariable Variables commonly included in model simulation output datasets
ObservationType
PlatformType
ResearcherIDType
SamplingInstrumentType
SamplingType
SeaNames
SimulationType Type of model simulation dataset
TitrationCellType
TracerForm Forms of tracer used in tracer studies

Types

Type Description
Boolean A binary (true or false) value
Curie a compact URI
Date a date (year, month and day) in an idealized calendar
DateOrDatetime Either a date or a datetime
Datetime The combination of a date and time
Decimal A real number with arbitrary precision that conforms to the xsd:decimal speci...
Doi A Digital Object Identifier (DOI) for a digital object such as a document, da...
Double A real number that conforms to the xsd:double specification
Float A real number that conforms to the xsd:float specification
Integer An integer
Jsonpath A string encoding a JSON Path
Jsonpointer A string encoding a JSON Pointer
Ncname Prefix part of CURIE
Nodeidentifier A URI, CURIE or BNODE that represents a node in a model
Objectidentifier A URI or CURIE that represents an object in the model
Sparqlpath A string encoding a SPARQL Property Path
String A character string
Time A time object represents a (local) time of day, independent of any particular...
Uri a complete URI
Uriorcurie a URI or a CURIE

Subsets

Subset Description