Class: Intervention

name: Intervention
description: Additional metadata that applies to experiments where an intervention,
  such as an alkalinity addition, was conducted.
from_schema: OAEDataManagementProtocol
is_a: InSituExperiment
mixins:
- InterventionDetails
- DosingDetails
rules:
- preconditions:
    slot_conditions:
      alkalinity_feedstock:
        name: alkalinity_feedstock
        equals_string: other
  postconditions:
    slot_conditions:
      alkalinity_feedstock_custom:
        name: alkalinity_feedstock_custom
        required: true
- preconditions:
    slot_conditions:
      alkalinity_feedstock_processing:
        name: alkalinity_feedstock_processing
        equals_string: other
  postconditions:
    slot_conditions:
      alkalinity_feedstock_processing_custom:
        name: alkalinity_feedstock_processing_custom
        required: true

name: Intervention
description: Additional metadata that applies to experiments where an intervention,
  such as an alkalinity addition, was conducted.
from_schema: OAEDataManagementProtocol
is_a: InSituExperiment
mixins:
- InterventionDetails
- DosingDetails
attributes:
  alkalinity_feedstock_processing:
    name: alkalinity_feedstock_processing
    description: Method(s) used to process the alkalinity feedstock. See Controlled
      Vocabularies section for definitions.
    title: Alkalinity Feedstock Processing
    from_schema: Experiment
    rank: 1000
    alias: alkalinity_feedstock_processing
    owner: Intervention
    domain_of:
    - InterventionDetails
    range: AlkalinityFeedstockProcessing
    required: true
  alkalinity_feedstock_processing_custom:
    name: alkalinity_feedstock_processing_custom
    description: Custom description of alkalinity feedstock processing method when
      'other' is selected in alkalinity_feedstock_processing.
    title: Alkalinity Feedstock Processing (Custom)
    from_schema: Experiment
    rank: 1000
    alias: alkalinity_feedstock_processing_custom
    owner: Intervention
    domain_of:
    - InterventionDetails
    range: string
  alkalinity_feedstock_form:
    name: alkalinity_feedstock_form
    description: The phase upon delivery to the ocean. See Controlled Vocabularies
      section for definitions.
    title: Alkalinity Feedstock Form
    from_schema: Experiment
    rank: 1000
    alias: alkalinity_feedstock_form
    owner: Intervention
    domain_of:
    - InterventionDetails
    range: AlkalinityFeedstockForm
    required: true
  alkalinity_feedstock:
    name: alkalinity_feedstock
    description: 'Examples may include: olivine, potassium hydroxide, magnesium hydroxide,
      lime, portlandite, calcium carbonate, anorthite, dolomite, periclase, brucite,
      magnesite, forsterite, sodium hydroxide, natrite, nahcolite, akermanite, akermanite,
      alunoakermanite, etc.

      See Controlled Vocabularies section for selected examples (this list is not
      exhaustive, you may need to include your unique feedstock).'
    title: Alkalinity Feedstock
    from_schema: Experiment
    rank: 1000
    alias: alkalinity_feedstock
    owner: Intervention
    domain_of:
    - InterventionDetails
    range: FeedstockType
    required: true
  alkalinity_feedstock_custom:
    name: alkalinity_feedstock_custom
    description: Custom description of alkalinity feedstock when using a feedstock
      type not listed in the controlled vocabulary.
    title: Alkalinity Feedstock (Custom)
    from_schema: Experiment
    rank: 1000
    alias: alkalinity_feedstock_custom
    owner: Intervention
    domain_of:
    - InterventionDetails
    range: string
  alkalinity_feedstock_co2_removal_potential:
    name: alkalinity_feedstock_co2_removal_potential
    description: Maximum CO₂ removal potential of a feedstock material. We recommend
      using an adjusted version of the Steinour equation (Gunning et al., 2010), which
      uses bulk elemental oxide composition to estimate the maximum CO₂ removal potential
      of a feedstock material. The calculation output is in the form of kg of CO₂
      per tonne of feedstock and represents the quantitative hypothetical potential
      of the material to capture CO₂ as bicarbonate or carbonate. See Isometric's
      CO2 removal potential module for details.
    title: Alkalinity Feedstock CO₂ Removal Potential
    from_schema: Experiment
    rank: 1000
    alias: alkalinity_feedstock_co2_removal_potential
    owner: Intervention
    domain_of:
    - InterventionDetails
    range: float
    required: true
  alkalinity_feedstock_description:
    name: alkalinity_feedstock_description
    description: 'Information such as feedstock source, characteristics, impurities,
      dilution prior to dosing, and concentration. For feedstock other than NaOH:
      trace metal composition and particulate grain size. Any variable information
      must be provided in the dosing data file, in this case include the data file
      and column header names here provided as variables. See Intervention Data for
      details.'
    title: Alkalinity Feedstock Description
    from_schema: Experiment
    rank: 1000
    alias: alkalinity_feedstock_description
    owner: Intervention
    domain_of:
    - InterventionDetails
    range: string
    required: true
  equilibration:
    name: equilibration
    description: Whether the feedstock was pre-equilibrated or unequilibrated
    title: Equilibration
    from_schema: Experiment
    rank: 1000
    alias: equilibration
    owner: Intervention
    domain_of:
    - InterventionDetails
    range: EquilibrationStatus
    required: true
  alkalinity_dosing_effluent_density:
    name: alkalinity_dosing_effluent_density
    description: Fixed density or provide link/source to effluent density data if
      applicable. Please include whether density is directly measured or a derived
      value. If this is a variable included with your data, please note so here as
      'alkalinity dosing effluent density is provided as a variable' and use 'dosing_effluent_density'
      for your column header name.
    title: Alkalinity Dosing Effluent Density
    from_schema: Experiment
    rank: 1000
    alias: alkalinity_dosing_effluent_density
    owner: Intervention
    domain_of:
    - InterventionDetails
    range: DosingConcentration
    required: true
  dosing_delivery_type:
    name: dosing_delivery_type
    description: Type of dosing delivery method. See Controlled Vocabularies for definitions.
    title: Dosing Delivery Type
    from_schema: Experiment
    rank: 1000
    alias: dosing_delivery_type
    owner: Intervention
    domain_of:
    - DosingDetails
    range: DosingDeliveryType
    required: true
  dosing_location:
    name: dosing_location
    description: Provide latitude and longitude in decimal degrees. Depending on your
      method of dispersal, this information may be provided as a point source, vector,
      or bounding box. If provided as a vector, the latitude and longitude values
      should be included in the dosing data file.
    title: Dosing Location
    from_schema: Experiment
    rank: 1000
    alias: dosing_location
    owner: Intervention
    domain_of:
    - DosingDetails
    range: DosingLocation
    required: true
  dosing_dispersal_hydrologic_location:
    name: dosing_dispersal_hydrologic_location
    description: Descriptive dosing location
    title: Dosing Dispersal Hydrologic Location
    from_schema: Experiment
    rank: 1000
    alias: dosing_dispersal_hydrologic_location
    owner: Intervention
    domain_of:
    - DosingDetails
    range: HydrologicLocation
    required: true
  dosing_depth:
    name: dosing_depth
    description: Depth in meters. If this is variable, please include the schedule
      of depth changes and depths, or as a vector in meters with the data.
    title: Dosing Depth
    from_schema: Experiment
    rank: 1000
    alias: dosing_depth
    owner: Intervention
    domain_of:
    - DosingDetails
    range: string
    required: true
  dosing_regimen:
    name: dosing_regimen
    description: A human readable summary description of the dosing regimen / frequency.
      Exact details must be provided in the corresponding dosing file with exact timestamps
      for dosing on/off schedule.
    title: Dosing Regimen
    from_schema: Experiment
    rank: 1000
    alias: dosing_regimen
    owner: Intervention
    domain_of:
    - DosingDetails
    range: string
    required: true
  dosing_description:
    name: dosing_description
    description: 'Please be descriptive. Information about the dosing mechanism must
      be included (outflow from pipe, diffuser, doser, manual placement)

      E.g., outflow from existing facility pipe directly to ocean, manual riverine
      introduction, coastal distribution at three separate 30 meter long sections,
      pier-based diffuser to intercoastal bay, distributed from stationary barge 10
      miles offshore.'
    title: Dosing Description
    from_schema: Experiment
    rank: 1000
    alias: dosing_description
    owner: Intervention
    domain_of:
    - DosingDetails
    range: string
    required: true
  vertical_coverage:
    name: vertical_coverage
    description: Minimum and maximum depths of observations in meters.
    title: Vertical Coverage
    from_schema: OAEDataManagementProtocol
    rank: 1000
    alias: vertical_coverage
    owner: Intervention
    domain_of:
    - InSituExperiment
    range: VerticalExtent
  permits:
    name: permits
    description: Associated permit number(s).
    title: Permits
    from_schema: OAEDataManagementProtocol
    rank: 1000
    alias: permits
    owner: Intervention
    domain_of:
    - InSituExperiment
    range: Permit
    multivalued: true
    inlined: true
    inlined_as_list: true
  data_conflicts_and_unreported_data:
    name: data_conflicts_and_unreported_data
    description: If data exist that are or have been used by the project but are not
      provided due to conflicts (e.g., geopolitical or other), data availability (e.g.,
      a dataset is no longer available), it may be noted here.
    title: Data Conflicts and Unreported Data
    from_schema: Experiment
    rank: 1000
    alias: data_conflicts_and_unreported_data
    owner: Intervention
    domain_of:
    - InSituExperiment
    range: string
  meteorological_and_tidal_data:
    name: meteorological_and_tidal_data
    description: Include links to relevant open datasets if referenced in the experiment
      but not provided in the submission.
    title: Meteorological and Tidal Data
    from_schema: Experiment
    rank: 1000
    alias: meteorological_and_tidal_data
    owner: Intervention
    domain_of:
    - InSituExperiment
    range: NamedLink
    multivalued: true
    inlined: true
    inlined_as_list: true
  additional_details:
    name: additional_details
    description: Open text area to include additional information. These may include
      information for sediment processes data, biological data, or any other required
      information if not included in the main metadata or data files; see General
      Guidelines for Your Data for relevant sections of your data. Additional informational
      files, such as digitized laboratory notebooks, blogs, etc., may be linked here.
    title: Additional Details
    from_schema: Experiment
    alias: additional_details
    owner: Intervention
    domain_of:
    - Project
    - InSituExperiment
    range: string
  name:
    name: name
    description: Optional common name for experiment.
    title: Name
    from_schema: OAEDataManagementProtocol
    rank: 1000
    slot_uri: schema:name
    alias: name
    owner: Intervention
    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: Intervention
    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: Intervention
    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: Intervention
    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: Intervention
    domain_of:
    - Experiment
    - Dataset
    range: string
    required: true
  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: Intervention
    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: Intervention
    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: Intervention
    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: Intervention
    domain_of:
    - Experiment
    - ModelOutputDataset
    range: datetime
rules:
- preconditions:
    slot_conditions:
      alkalinity_feedstock:
        name: alkalinity_feedstock
        equals_string: other
  postconditions:
    slot_conditions:
      alkalinity_feedstock_custom:
        name: alkalinity_feedstock_custom
        required: true
- preconditions:
    slot_conditions:
      alkalinity_feedstock_processing:
        name: alkalinity_feedstock_processing
        equals_string: other
  postconditions:
    slot_conditions:
      alkalinity_feedstock_processing_custom:
        name: alkalinity_feedstock_processing_custom
        required: true