Class: Experiment

Abstract base class for all experiment types. Contains fields common to both in-situ and model experiments.

classDiagram class Experiment click Experiment href "../Experiment" Experiment <|-- InSituExperiment click InSituExperiment href "../InSituExperiment" Experiment <|-- Model click Model href "../Model" Experiment : description Experiment : end_datetime Experiment : experiment_id Experiment : experiment_leads Experiment --> "1..*" Person : experiment_leads click Person href "../Person" Experiment : experiment_type Experiment --> "1" ExperimentType : experiment_type click ExperimentType href "../ExperimentType" Experiment : name Experiment : project_id Experiment : spatial_coverage Experiment --> "1" SpatialCoverage : spatial_coverage click SpatialCoverage href "../SpatialCoverage" Experiment : start_datetime

Inheritance

Experiment
- InSituExperiment
- Model

Slots

Name	Cardinality and Range	Description	Inheritance
name	0..1 String	Optional common name for experiment	direct
description	1 String	A narrative description of the experiment	direct
spatial_coverage	1 SpatialCoverage	Latitude/longitude bounds of observed data in experiment, provided in decimal...	direct
project_id	1 String	The project to which the submitted data belong	direct
experiment_id	1 String	The experiment to which the data belong	direct
experiment_type	1 ExperimentType	The type of mCDR experiment conducted	direct
experiment_leads	1..* Person	Provide details for each experiment lead / principal investigator (PI) includ...	direct
start_datetime	1 Datetime	Start date and time of experiment in UTC ISO-8601	direct
end_datetime	0..1 Datetime	End date and time of experiment in UTC ISO-8601	direct

Usages

used by	used in	type	used
Container	experiments	range	Experiment
Project	experiments	range	Experiment

Identifier and Mapping Information

Schema Source

from schema: OAEDataManagementProtocol

Mappings

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

LinkML Source

Direct

name: Experiment
description: Abstract base class for all experiment types. Contains fields common
  to both in-situ and model experiments.
from_schema: OAEDataManagementProtocol
slots:
- name
- description
- spatial_coverage
- project_id
- experiment_id
slot_usage:
  project_id:
    name: project_id
    required: true
  experiment_id:
    name: experiment_id
    required: true
  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
    required: true
  name:
    name: name
    description: Optional common name for experiment.
  spatial_coverage:
    name: spatial_coverage
    description: Latitude/longitude bounds of observed data in experiment, provided
      in decimal degrees as westernmost longitude, southernmost latitude, easternmost
      longitude, northernmost latitude. [S, W, N, E]
    required: true
attributes:
  experiment_type:
    name: experiment_type
    description: The type of mCDR experiment conducted. See Controlled Vocabularies
      section for definitions.
    title: mCDR Experiment Type
    from_schema: Experiment
    rank: 1000
    domain_of:
    - Experiment
    range: ExperimentType
    required: 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
    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
    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
    domain_of:
    - Experiment
    - ModelOutputDataset
    range: datetime

Induced

name: Experiment
description: Abstract base class for all experiment types. Contains fields common
  to both in-situ and model experiments.
from_schema: OAEDataManagementProtocol
slot_usage:
  project_id:
    name: project_id
    required: true
  experiment_id:
    name: experiment_id
    required: true
  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
    required: true
  name:
    name: name
    description: Optional common name for experiment.
  spatial_coverage:
    name: spatial_coverage
    description: Latitude/longitude bounds of observed data in experiment, provided
      in decimal degrees as westernmost longitude, southernmost latitude, easternmost
      longitude, northernmost latitude. [S, W, N, E]
    required: true
attributes:
  experiment_type:
    name: experiment_type
    description: The type of mCDR experiment conducted. See Controlled Vocabularies
      section for definitions.
    title: mCDR Experiment Type
    from_schema: Experiment
    rank: 1000
    alias: experiment_type
    owner: Experiment
    domain_of:
    - Experiment
    range: ExperimentType
    required: 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: Experiment
    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: Experiment
    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: Experiment
    domain_of:
    - Experiment
    - ModelOutputDataset
    range: datetime
  name:
    name: name
    description: Optional common name for experiment.
    title: Name
    from_schema: OAEDataManagementProtocol
    rank: 1000
    slot_uri: schema:name
    alias: name
    owner: Experiment
    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: OAEDataManagementProtocol
    rank: 1000
    slot_uri: schema:description
    alias: description
    owner: Experiment
    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, provided
      in decimal degrees as westernmost longitude, southernmost latitude, easternmost
      longitude, northernmost latitude. [S, W, N, E]
    title: Spatial Coverage
    from_schema: OAEDataManagementProtocol
    rank: 1000
    slot_uri: schema:spatialCoverage
    alias: spatial_coverage
    owner: Experiment
    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: OAEDataManagementProtocol
    rank: 1000
    alias: project_id
    owner: Experiment
    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: OAEDataManagementProtocol
    rank: 1000
    alias: experiment_id
    owner: Experiment
    domain_of:
    - Experiment
    - Dataset
    range: string
    required: true