Class: Model

A computational model experiment related to OAE.

 classDiagram
    class Model
    click Model href "../Model"
      Experiment <|-- Model
        click Experiment href "../Experiment"

      Model : description

      Model : end_datetime

      Model : experiment_id

      Model : experiment_leads




    Model --> "1..*" Person : experiment_leads
    click Person href "../Person"


      Model : experiment_types




    Model --> "1..*" ExperimentType : experiment_types
    click ExperimentType href "../ExperimentType"


      Model : grid_details




    Model --> "*" ModelGrid : grid_details
    click ModelGrid href "../ModelGrid"


      Model : model_components




    Model --> "*" ModelComponent : model_components
    click ModelComponent href "../ModelComponent"


      Model : model_configuration

      Model : name

      Model : project_id

      Model : public_comments

      Model : spatial_coverage




    Model --> "1" SpatialCoverage : spatial_coverage
    click SpatialCoverage href "../SpatialCoverage"


      Model : spin_up_protocol

      Model : start_datetime

      Model : time_stepping_scheme

Inheritance

Experiment
- Model

Slots

Name	Cardinality and Range	Description	Inheritance
model_configuration	* uri	Links to model configuration files or documentation	direct
model_components	* ModelComponent	Components of the model (e	direct
grid_details	* ModelGrid	Details about the model grid(s)	direct
spin_up_protocol	0..1 String	Description of the model spin-up process	direct
time_stepping_scheme	0..1 String	Time-stepping method and time step used in the simulation	direct
name	0..1 String	Optional common name for experiment	Experiment
description	1 String	A narrative description of the experiment	Experiment
spatial_coverage	1 SpatialCoverage	Latitude/longitude bounds of observed data in experiment, expressed as a sche...	Experiment
project_id	1 String	The project to which the submitted data belong	Experiment
experiment_id	1 String	The experiment to which the data belong	Experiment
experiment_types	1..* ExperimentType	The type(s) of mCDR experiment conducted	Experiment
public_comments	0..1 recommended String	File name(s) of public comment related documents	Experiment
experiment_leads	1..* Person	Provide details for each experiment lead / principal investigator (PI) includ...	Experiment
start_datetime	1 Datetime	Start date and time of experiment in UTC ISO-8601	Experiment
end_datetime	0..1 Datetime	End date and time of experiment in UTC ISO-8601	Experiment

Identifier and Mapping Information

Schema Source

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

Mappings

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

LinkML Source

Direct

name: Model
description: A computational model experiment related to OAE.
from_schema: https://schema.oaedata.org/OAEDataSchema
is_a: Experiment
attributes:
  model_configuration:
    name: model_configuration
    description: Links to model configuration files or documentation.
    title: Model Configuration
    from_schema: Model
    rank: 1000
    domain_of:
    - Model
    range: uri
    multivalued: true
  model_components:
    name: model_components
    description: Components of the model (e.g., physics, biogeochemistry).
    title: Model Components
    from_schema: Model
    rank: 1000
    domain_of:
    - Model
    range: ModelComponent
    multivalued: true
    inlined: true
    inlined_as_list: true
  grid_details:
    name: grid_details
    description: Details about the model grid(s). Use multiple entries for nested
      grid configurations.
    title: Grid Details
    from_schema: Model
    rank: 1000
    domain_of:
    - Model
    range: ModelGrid
    multivalued: true
    inlined: true
    inlined_as_list: true
  spin_up_protocol:
    name: spin_up_protocol
    description: Description of the model spin-up process.
    title: Spin-up Protocol
    from_schema: Model
    rank: 1000
    domain_of:
    - Model
    range: string
  time_stepping_scheme:
    name: time_stepping_scheme
    description: Time-stepping method and time step used in the simulation.
    title: Time-stepping Scheme
    from_schema: Model
    rank: 1000
    domain_of:
    - Model
    range: string

Induced

name: Model
description: A computational model experiment related to OAE.
from_schema: https://schema.oaedata.org/OAEDataSchema
is_a: Experiment
attributes:
  model_configuration:
    name: model_configuration
    description: Links to model configuration files or documentation.
    title: Model Configuration
    from_schema: Model
    rank: 1000
    alias: model_configuration
    owner: Model
    domain_of:
    - Model
    range: uri
    multivalued: true
  model_components:
    name: model_components
    description: Components of the model (e.g., physics, biogeochemistry).
    title: Model Components
    from_schema: Model
    rank: 1000
    alias: model_components
    owner: Model
    domain_of:
    - Model
    range: ModelComponent
    multivalued: true
    inlined: true
    inlined_as_list: true
  grid_details:
    name: grid_details
    description: Details about the model grid(s). Use multiple entries for nested
      grid configurations.
    title: Grid Details
    from_schema: Model
    rank: 1000
    alias: grid_details
    owner: Model
    domain_of:
    - Model
    range: ModelGrid
    multivalued: true
    inlined: true
    inlined_as_list: true
  spin_up_protocol:
    name: spin_up_protocol
    description: Description of the model spin-up process.
    title: Spin-up Protocol
    from_schema: Model
    rank: 1000
    alias: spin_up_protocol
    owner: Model
    domain_of:
    - Model
    range: string
  time_stepping_scheme:
    name: time_stepping_scheme
    description: Time-stepping method and time step used in the simulation.
    title: Time-stepping Scheme
    from_schema: Model
    rank: 1000
    alias: time_stepping_scheme
    owner: Model
    domain_of:
    - Model
    range: string
  name:
    name: name
    description: Optional common name for experiment.
    title: Name
    from_schema: https://schema.oaedata.org/OAEDataSchema
    rank: 1000
    slot_uri: schema:name
    alias: name
    owner: Model
    domain_of:
    - Organization
    - NamedLink
    - ExternalProject
    - MonetaryGrant
    - Experiment
    - Person
    - Dataset
    - Platform
    - ModelComponent
    range: string
  description:
    name: description
    description: A narrative description of the experiment. For example, what part
      of the project do these data represent (e.g., baseline, intervention, control)
      and what do they contribute to the overall project? Are all project research
      questions listed in Project description relevant? What were the processes to
      achieve these goals and answer these questions? Data submitters are encouraged
      to note any significant changes to the original experimental plan due to unforeseen
      circumstances here.
    title: Experiment Description
    from_schema: https://schema.oaedata.org/OAEDataSchema
    rank: 1000
    slot_uri: schema:description
    alias: description
    owner: Model
    domain_of:
    - Project
    - ExternalProject
    - Experiment
    - VocabularyItemReference
    - Dataset
    - ModelComponent
    range: string
    required: true
  spatial_coverage:
    name: spatial_coverage
    description: Latitude/longitude bounds of observed data in experiment, expressed
      as a schema.org GeoShape bounding box.
    title: Spatial Coverage
    from_schema: https://schema.oaedata.org/OAEDataSchema
    rank: 1000
    slot_uri: schema:spatialCoverage
    alias: spatial_coverage
    owner: Model
    domain_of:
    - Project
    - ExternalProject
    - Experiment
    - ModelGrid
    range: SpatialCoverage
    required: true
  project_id:
    name: project_id
    description: 'The project to which the submitted data belong. A unique project
      identifier that can be used to link project data across data submissions, and
      link baseline data to intervention data, for example.

      If no Project ID has been assigned, one may be generated by combining: lead
      organizer surname and first initial or company, a unique date, and location.

      Any method that creates a unique ID that will link all project data is acceptable.'
    title: Project ID
    from_schema: https://schema.oaedata.org/OAEDataSchema
    rank: 1000
    alias: project_id
    owner: Model
    domain_of:
    - Project
    - Experiment
    - Dataset
    range: string
    required: true
  experiment_id:
    name: experiment_id
    description: 'The experiment to which the data belong. Any naming convention that
      produces a unique ID is usable. The recommended naming convention is:

      Project ID + Experiment type + Optional numerical indicator to differentiate
      between various experiments of the same type for a project. A two digit consecutive
      number beginning with 01'
    title: Experiment ID
    from_schema: https://schema.oaedata.org/OAEDataSchema
    rank: 1000
    alias: experiment_id
    owner: Model
    domain_of:
    - Experiment
    - Dataset
    range: string
    required: true
  experiment_types:
    name: experiment_types
    description: The type(s) of mCDR experiment conducted. See Controlled Vocabularies
      section for definitions.
    title: mCDR Experiment Type(s)
    from_schema: Experiment
    rank: 1000
    alias: experiment_types
    owner: Model
    domain_of:
    - Experiment
    range: ExperimentType
    required: true
    multivalued: true
  public_comments:
    name: public_comments
    description: File name(s) of public comment related documents. If possible, please
      provide public comments concatenated into a single pdf
    title: Public Comments
    from_schema: Experiment
    rank: 1000
    alias: public_comments
    owner: Model
    domain_of:
    - Experiment
    range: string
    recommended: true
  experiment_leads:
    name: experiment_leads
    description: 'Provide details for each experiment lead / principal investigator
      (PI) including: Name, institutional information (name, address), phone, email,
      ID type (e.g., ORCID, etc), researcher ID, and role.'
    title: Experiment Lead(s)
    from_schema: Experiment
    rank: 1000
    alias: experiment_leads
    owner: Model
    domain_of:
    - Experiment
    range: Person
    required: true
    multivalued: true
    inlined: true
    inlined_as_list: true
  start_datetime:
    name: start_datetime
    description: Start date and time of experiment in UTC ISO-8601
    title: Start Date and Time (UTC)
    from_schema: Experiment
    rank: 1000
    alias: start_datetime
    owner: Model
    domain_of:
    - Experiment
    - ModelOutputDataset
    range: datetime
    required: true
  end_datetime:
    name: end_datetime
    description: End date and time of experiment in UTC ISO-8601
    title: End Date and Time (UTC)
    from_schema: Experiment
    rank: 1000
    alias: end_datetime
    owner: Model
    domain_of:
    - Experiment
    - ModelOutputDataset
    range: datetime