ts_ids_core.schema.system module¶

Model Firmware[source]¶

Bases: IdsElement

System firmware metadata.

Show JSON schema

{
   "description": "System firmware metadata.",
   "type": "object",
   "properties": {
      "name": {
         "description": "Firmware name.",
         "type": [
            "string",
            "null"
         ]
      },
      "version": {
         "description": "Firmware version.",
         "type": [
            "string",
            "null"
         ]
      }
   },
   "additionalProperties": false,
   "required": [
      "name",
      "version"
   ]
}

Validators:

all_abstract_fields_implemented » all fields

field name: Required[Nullable[str]]¶: Firmware name.

field version: Required[Nullable[str]]¶: Firmware version.

Model Software[source]¶

Bases: IdsElement

Software application that most recently handled the data (file) or the application the data (file) is intended for. For example, applications can include Electronic Lab Notebooks (ELN), Instrument Control Software (ICS), Chromatography Data Systems (CDS), or instrument-specific analysis software.

Show JSON schema

{
   "description": "Software application that most recently handled the data (file) or the application\nthe data (file) is intended for. For example, applications can include Electronic\nLab Notebooks (ELN), Instrument Control Software (ICS), Chromatography Data Systems\n(CDS), or instrument-specific analysis software.",
   "type": "object",
   "properties": {
      "name": {
         "description": "Software name.",
         "type": [
            "string",
            "null"
         ]
      },
      "version": {
         "description": "Software version.",
         "type": [
            "string",
            "null"
         ]
      }
   },
   "additionalProperties": false,
   "required": [
      "name",
      "version"
   ]
}

Validators:

all_abstract_fields_implemented » all fields

field name: Required[Nullable[str]]¶: Software name.

field version: Required[Nullable[str]]¶: Software version.

Model System[source]¶

Bases: IdsElement

Metadata regarding the equipment, software, and firmware used in a run of an instrument or experiment.

Show JSON schema

{
   "description": "Metadata regarding the equipment, software, and firmware used in a run of an\ninstrument or experiment.",
   "type": "object",
   "properties": {
      "vendor": {
         "description": "The instrument vendor or manufacturer, like 'PerkinElmer' or 'Agilent'.",
         "type": [
            "string",
            "null"
         ]
      },
      "model": {
         "description": "A specific model instrument type from a vendor.",
         "type": [
            "string",
            "null"
         ]
      },
      "type": {
         "description": "Indicates the type of instrument that's generating data.",
         "type": [
            "string",
            "null"
         ]
      }
   },
   "additionalProperties": false,
   "required": [
      "vendor",
      "model",
      "type"
   ]
}

Validators:

all_abstract_fields_implemented » all fields

field model: Required[Nullable[str]]¶: A specific model instrument type from a vendor.

field type_: Required[Nullable[str]] (alias 'type')¶: Indicates the type of instrument that’s generating data.

field vendor: Required[Nullable[str]]¶: The instrument vendor or manufacturer, like ‘PerkinElmer’ or ‘Agilent’.

Model Firmware[source]¶

Bases: IdsElement

System firmware.

Show JSON schema

{
   "description": "System firmware.",
   "type": "object",
   "properties": {
      "firmware": {
         "description": "System firmware metadata.",
         "items": {
            "$ref": "#/definitions/Firmware"
         },
         "type": "array"
      }
   },
   "additionalProperties": false,
   "definitions": {
      "Firmware": {
         "additionalProperties": false,
         "description": "System firmware metadata.",
         "properties": {
            "name": {
               "description": "Firmware name.",
               "type": [
                  "string",
                  "null"
               ]
            },
            "version": {
               "description": "Firmware version.",
               "type": [
                  "string",
                  "null"
               ]
            }
         },
         "required": [
            "name",
            "version"
         ],
         "type": "object"
      }
   }
}

Validators:

all_abstract_fields_implemented » all fields

field firmware: List[system.Firmware]¶: System firmware metadata.

Model Id[source]¶

Bases: IdsElement

System ID.

Show JSON schema

{
   "description": "System ID.",
   "type": "object",
   "properties": {
      "id": {
         "description": "Identifier for the system. This is usually defined by the system owner or user, for example this may be created with a laboratory information management system or asset management software. Typically, an ID will not change over time, so that it can be used to track a particular system, unlike the system name which may change.",
         "type": [
            "string",
            "null"
         ]
      }
   },
   "additionalProperties": false
}

Validators:

all_abstract_fields_implemented » all fields

field id_: Nullable[str] (alias 'id')¶: Identifier for the system. This is usually defined by the system owner or user, for example this may be created with a laboratory information management system or asset management software. Typically, an ID will not change over time, so that it can be used to track a particular system, unlike the system name which may change.

Model Name[source]¶

Bases: IdsElement

System name.

Show JSON schema

{
   "description": "System name.",
   "type": "object",
   "properties": {
      "name": {
         "description": "Name for the system. This is usually a human-readable name defined by the system owner or user. It may be changed over time as the system is used for different purposes, unlike the ID which typically doesn't change.",
         "type": [
            "string",
            "null"
         ]
      }
   },
   "additionalProperties": false
}

Validators:

all_abstract_fields_implemented » all fields

field name: Nullable[str]¶: Name for the system. This is usually a human-readable name defined by the system owner or user. It may be changed over time as the system is used for different purposes, unlike the ID which typically doesn’t change.

Model SerialNumber[source]¶

Bases: IdsElement

System serial number.

Show JSON schema

{
   "description": "System serial number.",
   "type": "object",
   "properties": {
      "serial_number": {
         "description": "System serial number. Indicates a unique instrument identifier within the same model line from a specific vendor. This is provided by the system vendor, unlike an ID or name which are usually created by the system owner or user.",
         "type": [
            "string",
            "null"
         ]
      }
   },
   "additionalProperties": false
}

Validators:

all_abstract_fields_implemented » all fields

field serial_number: Nullable[str]¶: System serial number. Indicates a unique instrument identifier within the same model line from a specific vendor. This is provided by the system vendor, unlike an ID or name which are usually created by the system owner or user.

Model Software[source]¶

Bases: IdsElement

System software.

Show JSON schema

{
   "description": "System software.",
   "type": "object",
   "properties": {
      "software": {
         "description": "Software applications that most recently handled the data (file) or the applications the data (file) is intended for. For example, applications can include Electronic Lab Notebooks (ELN), Instrument Control Software (ICS), Chromatography Data Systems (CDS), or instrument-specific analysis software.",
         "items": {
            "$ref": "#/definitions/Software"
         },
         "type": "array"
      }
   },
   "additionalProperties": false,
   "definitions": {
      "Software": {
         "additionalProperties": false,
         "description": "Software application that most recently handled the data (file) or the application\nthe data (file) is intended for. For example, applications can include Electronic\nLab Notebooks (ELN), Instrument Control Software (ICS), Chromatography Data Systems\n(CDS), or instrument-specific analysis software.",
         "properties": {
            "name": {
               "description": "Software name.",
               "type": [
                  "string",
                  "null"
               ]
            },
            "version": {
               "description": "Software version.",
               "type": [
                  "string",
                  "null"
               ]
            }
         },
         "required": [
            "name",
            "version"
         ],
         "type": "object"
      }
   }
}

Validators:

all_abstract_fields_implemented » all fields

field software: List[system.Software]¶: Software applications that most recently handled the data (file) or the applications the data (file) is intended for. For example, applications can include Electronic Lab Notebooks (ELN), Instrument Control Software (ICS), Chromatography Data Systems (CDS), or instrument-specific analysis software.