base_catalogue_metadata.yaml

---
# DESY Public Dataset Metadata definition © 2024 by Deutsches
# Elektronen-Synchrotron DESY is licensed under CC BY 4.0
id: https://public-data.desy.de/metadata/base_catalogue
name: catalogue
prefixes:
  linkml: https://w3id.org/linkml/
  schema: http://schema.org/
imports: [linkml:types, base_types, base_sample]
default_range: string
classes:

  ScientificMetadataCommons:
    abstract: true
    description: The common part to scientific metadata of all datasets at DESY FS
    attributes:
      revision:
        description: e.g. version of the schema used
      Sample:
        # should be overwritten by specific sample type
        range: LiquidSurfaceSammple
      UserMetaData:
        range: objectidentifier
        description: Block of metadata that is fully under user control. No standardization enforced here!

  PetraScientificMetadata:
    is_a: ScientificMetadataCommons
    description: Adds PETRA specific metadata fields
    attributes:
      source:
        range: Source

  FlashScientificMetadata:
    is_a: ScientificMetadataCommons
    description: Adds FLASH specific metadata fields
  Source:
  #   description: X-ray Source properties
    attributes:
        # for the time being scicat does not support ranges in how about having either _min,_max OR just steady engery?
      beamline:
        range: string
        description: Name of the beamline used for the measurment
      instrument:
        range: string
        description: Name of the instrument used for the measurment
      photon_energy_min:
        range: EnergyMeasurement
        required: false
      photon_energy_max:
        range: EnergyMeasurement
        required: false
      photon_energy:
        range: EnergyMeasurement
        required: false
      #   # todo: find out how to specify that either min, max or photon_energy are required...
      machine_current:
        range: CurrentMeasurement
      machine_info:
        range: string
        description: Bunch mode etc.