ts_ids_components.chromatography.system module#

Model Module[source]#

Bases: IdsElement

Properties of the modules in the chromatography unit. Modules may include e.g. column compartments, detectors, autosamplers, or pumps.

Show JSON schema

{
   "description": "Properties of the modules in the chromatography unit. Modules may include\ne.g. column compartments, detectors, autosamplers, or pumps.",
   "type": "object",
   "properties": {
      "pk": {
         "@primary_key": true,
         "description": "Primary key for system modules.",
         "type": "string"
      },
      "fk_system": {
         "@foreign_key": "/properties/systems/items/properties/pk",
         "description": "Foreign key to the system.",
         "type": "string"
      },
      "name": {
         "description": "Module name as specified by the audit trail.",
         "type": [
            "string",
            "null"
         ]
      },
      "manufacturer": {
         "description": "Module manufacturer.",
         "type": [
            "string",
            "null"
         ]
      },
      "type": {
         "description": "Type of module.",
         "type": [
            "string",
            "null"
         ]
      },
      "detector_type": {
         "description": "Type of detector; defined only when the module is identified as a detector.",
         "type": [
            "string",
            "null"
         ]
      },
      "part_number": {
         "description": "Part number or model number of the module.",
         "type": [
            "string",
            "null"
         ]
      },
      "serial_number": {
         "description": "Module serial number.",
         "type": [
            "string",
            "null"
         ]
      },
      "firmware_version": {
         "description": "Module firmware version.",
         "type": [
            "string",
            "null"
         ]
      },
      "driver_version": {
         "description": "Module driver version.",
         "type": [
            "string",
            "null"
         ]
      }
   },
   "additionalProperties": false,
   "required": [
      "pk",
      "fk_system"
   ]
}

Validators:

field detector_type: str | None#: Type of detector; defined only when the module is identified as a detector.

field driver_version: str | None#: Module driver version.

field firmware_version: str | None#: Module firmware version.

field fk_system: str#

Foreign key to the system.

Constraints:

func = <function validate_uuid at 0x7f83f18f3550>
json_schema_input_type = PydanticUndefined
ids_field_arg = primary_key
pk_reference_field = @foreign_key

field manufacturer: str | None#: Module manufacturer.

field name: str | None#: Module name as specified by the audit trail.

field part_number: str | None#: Part number or model number of the module.

field pk: str#

Primary key for system modules.

Constraints:

func = <function validate_uuid at 0x7f83f18f3550>
json_schema_input_type = PydanticUndefined

field serial_number: str | None#: Module serial number.

field type: str | None#: Type of module.

Model Column[source]#

Bases: IdsElement

Properties of the column(s) in the chromatography system.

Show JSON schema

{
   "description": "Properties of the column(s) in the chromatography system.",
   "type": "object",
   "properties": {
      "pk": {
         "@primary_key": true,
         "description": "Primary key for columns in the chromatography system.",
         "type": "string"
      },
      "fk_system": {
         "@foreign_key": "/properties/systems/items/properties/pk",
         "description": "Foreign key to the system.",
         "type": "string"
      },
      "fk_module": {
         "@foreign_key": "/properties/modules/items/properties/pk",
         "description": "A foreign key that links a column to its respective column compartment",
         "type": "string"
      },
      "name": {
         "description": "Name for the column entered by the user.",
         "type": [
            "string",
            "null"
         ]
      },
      "product_number": {
         "description": "Manufacturer's product/catalog number for the column.",
         "type": [
            "string",
            "null"
         ]
      },
      "serial_number": {
         "description": "Column serial number.",
         "type": [
            "string",
            "null"
         ]
      },
      "batch_number": {
         "description": "Manufacturer's batch number for column production.",
         "type": [
            "string",
            "null"
         ]
      },
      "void_volume": {
         "$ref": "#/definitions/RawValueUnit",
         "description": "Void volume of the column, equal to the volume of mobile phase in the column."
      },
      "length": {
         "$ref": "#/definitions/RawValueUnit",
         "description": "Column length."
      },
      "diameter": {
         "$ref": "#/definitions/RawValueUnit",
         "description": "Column diameter."
      },
      "max_pressure": {
         "$ref": "#/definitions/RawValueUnit",
         "description": "Manufacturer's maximum rating for the column pressure."
      },
      "max_temperature": {
         "$ref": "#/definitions/RawValueUnit",
         "description": "Manufacturer's maximum rating for the column temperature."
      }
   },
   "additionalProperties": false,
   "required": [
      "pk",
      "fk_system",
      "fk_module"
   ],
   "definitions": {
      "RawValueUnit": {
         "additionalProperties": false,
         "description": "A value with a unit, including the raw representation of the value from the primary data.",
         "properties": {
            "value": {
               "description": "A numerical value.",
               "type": [
                  "number",
                  "null"
               ]
            },
            "unit": {
               "description": "Unit for the numerical value.",
               "type": [
                  "string",
                  "null"
               ]
            },
            "raw_value": {
               "description": "The raw, untransformed value from the primary data.",
               "type": [
                  "string",
                  "null"
               ]
            }
         },
         "required": [
            "value",
            "unit",
            "raw_value"
         ],
         "type": "object"
      }
   }
}

Validators:

field batch_number: str | None#: Manufacturer’s batch number for column production.

field diameter: RawValueUnit#: Column diameter.

field fk_module: str#

A foreign key that links a column to its respective column compartment

Constraints:

func = <function validate_uuid at 0x7f83f18f3550>
json_schema_input_type = PydanticUndefined
ids_field_arg = primary_key
pk_reference_field = @foreign_key

field fk_system: str#

Foreign key to the system.

Constraints:

func = <function validate_uuid at 0x7f83f18f3550>
json_schema_input_type = PydanticUndefined
ids_field_arg = primary_key
pk_reference_field = @foreign_key

field length: RawValueUnit#: Column length.

field max_pressure: RawValueUnit#: Manufacturer’s maximum rating for the column pressure.

field max_temperature: RawValueUnit#: Manufacturer’s maximum rating for the column temperature.

field name: str | None#: Name for the column entered by the user.

field pk: str#

Primary key for columns in the chromatography system.

Constraints:

func = <function validate_uuid at 0x7f83f18f3550>
json_schema_input_type = PydanticUndefined

field product_number: str | None#: Manufacturer’s product/catalog number for the column.

field serial_number: str | None#: Column serial number.

field void_volume: RawValueUnit#: Void volume of the column, equal to the volume of mobile phase in the column.

class ChromatographyType(value)[source]#

Bases: str, Enum

Possible values are Ion Chromatography, 2D High Performance Liquid Chromatography, High Performance Liquid Chromatography, or Gas Chromatography.

Model System[source]#

Bases: System

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": "Type of chromatography system.",
         "example_values": [
            "Ion Exchange Chromatography",
            "High Performance Liquid Chromatography",
            "2D High Performance Liquid Chromatography",
            "Gas Chromatography"
         ],
         "type": [
            "string",
            "null"
         ]
      },
      "pk": {
         "@primary_key": true,
         "description": "Primary key for the system.",
         "type": "string"
      }
   },
   "additionalProperties": false,
   "required": [
      "vendor",
      "model",
      "type",
      "pk"
   ]
}

Validators:

field pk: str#

Primary key for the system.

Constraints:

func = <function validate_uuid at 0x7f83f18f3550>
json_schema_input_type = PydanticUndefined

field type_: str | None (alias 'type')#: Type of chromatography system.