Skip to content

Class: ModelOutputVariable

A variable output by a model simulation (e.g., air-sea CO2 flux, dissolved inorganic carbon, total alkalinity, pH, temperature, salinity from an OAE model run). Model outputs are produced by the simulation itself, so they carry none of the sampling, instrument, calibration or in-situ QC metadata that field-collected variables do — how the output was produced is described by the simulation configuration on the parent ModelOutputDataset.

URI: oae:ModelOutputVariable

 classDiagram
    class ModelOutputVariable
    click ModelOutputVariable href "../ModelOutputVariable"
      Variable <|-- ModelOutputVariable
        click Variable href "../Variable"

      ModelOutputVariable : dataset_variable_name

      ModelOutputVariable : long_name

      ModelOutputVariable : schema_class

      ModelOutputVariable : standard_identifier




    ModelOutputVariable --> "0..1" VocabularyItemReference : standard_identifier
    click VocabularyItemReference href "../VocabularyItemReference"


      ModelOutputVariable : units

      ModelOutputVariable : variable_type




    ModelOutputVariable --> "1" ModelVariableType : variable_type
    click ModelVariableType href "../ModelVariableType"

Inheritance

Slots

Name Cardinality and Range Description Inheritance
units 1
String		 Unit of measurement for this variable Variable
variable_type 1
ModelVariableType		 Which model output quantity this variable holds Variable
schema_class 1
String		 The schema class name for this variable (e Variable
standard_identifier 0..1
VocabularyItemReference		 Variable
dataset_variable_name 1
String		 The name for the variable as it is identified in the dataset data file Variable
long_name 1
String		 Full descriptive name of the variable Variable

Usages

used by used in type used
ModelOutputDataset variables range ModelOutputVariable

Identifier and Mapping Information

Schema Source

  • from schema: https://schema.oaedata.org/OAEDataSchema

Mappings

Mapping Type Mapped Value
self oae:ModelOutputVariable
native oae:ModelOutputVariable

LinkML Source

Direct

name: ModelOutputVariable
description: A variable output by a model simulation (e.g., air-sea CO2 flux, dissolved
  inorganic carbon, total alkalinity, pH, temperature, salinity from an OAE model
  run). Model outputs are produced by the simulation itself, so they carry none of
  the sampling, instrument, calibration or in-situ QC metadata that field-collected
  variables do — how the output was produced is described by the simulation configuration
  on the parent ModelOutputDataset.
from_schema: https://schema.oaedata.org/OAEDataSchema
is_a: Variable
slot_usage:
  units:
    name: units
    required: true
  variable_type:
    name: variable_type
    description: Which model output quantity this variable holds. There is only one
      model variable class, so this classifies the variable rather than selecting
      a schema class.
    title: Model Output Variable
    range: ModelVariableType
    required: true

Induced

name: ModelOutputVariable
description: A variable output by a model simulation (e.g., air-sea CO2 flux, dissolved
  inorganic carbon, total alkalinity, pH, temperature, salinity from an OAE model
  run). Model outputs are produced by the simulation itself, so they carry none of
  the sampling, instrument, calibration or in-situ QC metadata that field-collected
  variables do — how the output was produced is described by the simulation configuration
  on the parent ModelOutputDataset.
from_schema: https://schema.oaedata.org/OAEDataSchema
is_a: Variable
slot_usage:
  units:
    name: units
    required: true
  variable_type:
    name: variable_type
    description: Which model output quantity this variable holds. There is only one
      model variable class, so this classifies the variable rather than selecting
      a schema class.
    title: Model Output Variable
    range: ModelVariableType
    required: true
attributes:
  units:
    name: units
    description: Unit of measurement for this variable.
    title: Unit
    from_schema: https://schema.oaedata.org/OAEDataSchema
    rank: 1000
    alias: units
    owner: ModelOutputVariable
    domain_of:
    - Variable
    range: string
    required: true
  variable_type:
    name: variable_type
    description: Which model output quantity this variable holds. There is only one
      model variable class, so this classifies the variable rather than selecting
      a schema class.
    title: Model Output Variable
    from_schema: https://schema.oaedata.org/OAEDataSchema
    rank: 1000
    alias: variable_type
    owner: ModelOutputVariable
    domain_of:
    - Variable
    range: ModelVariableType
    required: true
  schema_class:
    name: schema_class
    description: The schema class name for this variable (e.g., "DiscretePHVariable").
      Auto-populated by the metadata builder.
    from_schema: Variable
    rank: 1000
    designates_type: true
    alias: schema_class
    owner: ModelOutputVariable
    domain_of:
    - Variable
    range: string
    required: true
  standard_identifier:
    name: standard_identifier
    from_schema: Variable
    rank: 1000
    alias: standard_identifier
    owner: ModelOutputVariable
    domain_of:
    - Variable
    range: VocabularyItemReference
  dataset_variable_name:
    name: dataset_variable_name
    description: The name for the variable as it is identified in the dataset data
      file. This could be the column header in a CSV or the variable name in a NetCDF
      file. Standard common recommended column header names can be found in protocol
      documentation [here](https://www.carbontosea.org/oae-data-protocol/1-0-0/#column-header-name).
    title: Dataset variable name
    from_schema: Variable
    rank: 1000
    alias: dataset_variable_name
    owner: ModelOutputVariable
    domain_of:
    - Variable
    range: string
    required: true
  long_name:
    name: long_name
    description: Full descriptive name of the variable.
    title: Variable full name
    from_schema: Variable
    rank: 1000
    alias: long_name
    owner: ModelOutputVariable
    domain_of:
    - Variable
    range: string
    required: true