dgbowl_schemas.yadg.dataschema_5_0 package
- pydantic model dgbowl_schemas.yadg.dataschema_5_0.DataSchema
Bases:
BaseModelA
pydantic.BaseModelimplementingDataSchema-5.0model introduced inyadg-5.0.Show JSON schema
{ "title": "DataSchema", "description": "A :class:`pydantic.BaseModel` implementing ``DataSchema-5.0`` model introduced in\n``yadg-5.0``.", "type": "object", "properties": { "metadata": { "$ref": "#/$defs/Metadata" }, "step_defaults": { "$ref": "#/$defs/StepDefaults", "default": { "timezone": "Etc/UTC", "locale": "en_US.UTF-8", "encoding": null } }, "steps": { "items": { "discriminator": { "mapping": { "basiccsv": "#/$defs/BasicCSV", "chromdata": "#/$defs/ChromData", "chromtrace": "#/$defs/ChromTrace", "dummy": "#/$defs/Dummy", "electrochem": "#/$defs/ElectroChem", "flowdata": "#/$defs/FlowData", "masstrace": "#/$defs/MassTrace", "meascsv": "#/$defs/MeasCSV", "qftrace": "#/$defs/QFTrace", "xpstrace": "#/$defs/XPSTrace", "xrdtrace": "#/$defs/XRDTrace" }, "propertyName": "parser" }, "oneOf": [ { "$ref": "#/$defs/Dummy" }, { "$ref": "#/$defs/BasicCSV" }, { "$ref": "#/$defs/MeasCSV" }, { "$ref": "#/$defs/FlowData" }, { "$ref": "#/$defs/ElectroChem" }, { "$ref": "#/$defs/ChromTrace" }, { "$ref": "#/$defs/ChromData" }, { "$ref": "#/$defs/MassTrace" }, { "$ref": "#/$defs/QFTrace" }, { "$ref": "#/$defs/XPSTrace" }, { "$ref": "#/$defs/XRDTrace" } ] }, "title": "Steps", "type": "array" } }, "$defs": { "Agilent_ch": { "additionalProperties": false, "properties": { "filetype": { "enum": [ "agilent.ch", "marda:agilent-ch" ], "title": "Filetype", "type": "string" }, "timezone": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Timezone" }, "locale": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Locale" }, "encoding": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Encoding" } }, "required": [ "filetype" ], "title": "Agilent_ch", "type": "object" }, "Agilent_csv": { "additionalProperties": false, "properties": { "filetype": { "const": "agilent.csv", "enum": [ "agilent.csv" ], "title": "Filetype", "type": "string" }, "timezone": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Timezone" }, "locale": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Locale" }, "encoding": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Encoding" } }, "required": [ "filetype" ], "title": "Agilent_csv", "type": "object" }, "Agilent_dx": { "additionalProperties": false, "properties": { "filetype": { "enum": [ "agilent.dx", "marda:agilent-dx" ], "title": "Filetype", "type": "string" }, "timezone": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Timezone" }, "locale": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Locale" }, "encoding": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Encoding" } }, "required": [ "filetype" ], "title": "Agilent_dx", "type": "object" }, "BasicCSV": { "additionalProperties": false, "description": "Customisable tabulated file parser.", "properties": { "tag": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Tag" }, "parser": { "const": "basiccsv", "enum": [ "basiccsv" ], "title": "Parser", "type": "string" }, "input": { "$ref": "#/$defs/Input" }, "extractor": { "$ref": "#/$defs/NoFileType" }, "parameters": { "$ref": "#/$defs/dgbowl_schemas__yadg__dataschema_5_0__step__BasicCSV__Parameters" }, "externaldate": { "anyOf": [ { "$ref": "#/$defs/ExternalDate" }, { "type": "null" } ], "default": null } }, "required": [ "parser", "input" ], "title": "BasicCSV", "type": "object" }, "ChromData": { "additionalProperties": false, "description": "Parser for processed chromatography data.", "properties": { "tag": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Tag" }, "parser": { "const": "chromdata", "enum": [ "chromdata" ], "title": "Parser", "type": "string" }, "input": { "$ref": "#/$defs/Input" }, "extractor": { "discriminator": { "mapping": { "empalc.csv": "#/$defs/EmpaLC_csv", "empalc.xlsx": "#/$defs/EmpaLC_xlsx", "fusion.csv": "#/$defs/Fusion_csv", "fusion.json": "#/$defs/Fusion_json", "fusion.zip": "#/$defs/Fusion_zip" }, "propertyName": "filetype" }, "oneOf": [ { "$ref": "#/$defs/Fusion_json" }, { "$ref": "#/$defs/Fusion_zip" }, { "$ref": "#/$defs/Fusion_csv" }, { "$ref": "#/$defs/EmpaLC_csv" }, { "$ref": "#/$defs/EmpaLC_xlsx" } ], "title": "Extractor" }, "parameters": { "anyOf": [ { "$ref": "#/$defs/dgbowl_schemas__yadg__dataschema_5_0__parameters__Parameters" }, { "type": "null" } ], "default": null }, "externaldate": { "anyOf": [ { "$ref": "#/$defs/ExternalDate" }, { "type": "null" } ], "default": null } }, "required": [ "parser", "input", "extractor" ], "title": "ChromData", "type": "object" }, "ChromTrace": { "additionalProperties": false, "description": "Parser for raw chromatography traces.\n\n.. note::\n\n For parsing processed (integrated) chromatographic data, use the\n :class:`ChromData` parser.", "properties": { "tag": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Tag" }, "parser": { "const": "chromtrace", "enum": [ "chromtrace" ], "title": "Parser", "type": "string" }, "input": { "$ref": "#/$defs/Input" }, "extractor": { "discriminator": { "mapping": { "agilent.ch": "#/$defs/Agilent_ch", "agilent.csv": "#/$defs/Agilent_csv", "agilent.dx": "#/$defs/Agilent_dx", "ezchrom.asc": "#/$defs/EZChrom_asc", "fusion.json": "#/$defs/Fusion_json", "fusion.zip": "#/$defs/Fusion_zip", "marda:agilent-ch": "#/$defs/Agilent_ch", "marda:agilent-dx": "#/$defs/Agilent_dx" }, "propertyName": "filetype" }, "oneOf": [ { "$ref": "#/$defs/EZChrom_asc" }, { "$ref": "#/$defs/Fusion_json" }, { "$ref": "#/$defs/Fusion_zip" }, { "$ref": "#/$defs/Agilent_ch" }, { "$ref": "#/$defs/Agilent_dx" }, { "$ref": "#/$defs/Agilent_csv" } ], "title": "Extractor" }, "parameters": { "anyOf": [ { "$ref": "#/$defs/dgbowl_schemas__yadg__dataschema_5_0__parameters__Parameters" }, { "type": "null" } ], "default": null }, "externaldate": { "anyOf": [ { "$ref": "#/$defs/ExternalDate" }, { "type": "null" } ], "default": null } }, "required": [ "parser", "input", "extractor" ], "title": "ChromTrace", "type": "object" }, "Drycal_csv": { "additionalProperties": false, "properties": { "filetype": { "const": "drycal.csv", "enum": [ "drycal.csv" ], "title": "Filetype", "type": "string" }, "timezone": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Timezone" }, "locale": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Locale" }, "encoding": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Encoding" } }, "required": [ "filetype" ], "title": "Drycal_csv", "type": "object" }, "Drycal_rtf": { "additionalProperties": false, "properties": { "filetype": { "const": "drycal.rtf", "enum": [ "drycal.rtf" ], "title": "Filetype", "type": "string" }, "timezone": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Timezone" }, "locale": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Locale" }, "encoding": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Encoding" } }, "required": [ "filetype" ], "title": "Drycal_rtf", "type": "object" }, "Drycal_txt": { "additionalProperties": false, "properties": { "filetype": { "const": "drycal.txt", "enum": [ "drycal.txt" ], "title": "Filetype", "type": "string" }, "timezone": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Timezone" }, "locale": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Locale" }, "encoding": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Encoding" } }, "required": [ "filetype" ], "title": "Drycal_txt", "type": "object" }, "Dummy": { "additionalProperties": false, "description": "Dummy parser type, useful for testing.", "properties": { "tag": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Tag" }, "parser": { "const": "dummy", "enum": [ "dummy" ], "title": "Parser", "type": "string" }, "input": { "$ref": "#/$defs/Input" }, "extractor": { "anyOf": [ { "$ref": "#/$defs/NoFileType" }, { "$ref": "#/$defs/Tomato_json" } ], "title": "Extractor" }, "parameters": { "anyOf": [ { "$ref": "#/$defs/dgbowl_schemas__yadg__dataschema_5_0__step__Dummy__Parameters" }, { "type": "null" } ], "default": null }, "externaldate": { "anyOf": [ { "$ref": "#/$defs/ExternalDate" }, { "type": "null" } ], "default": null } }, "required": [ "parser", "input" ], "title": "Dummy", "type": "object" }, "EClab_mpr": { "additionalProperties": false, "properties": { "filetype": { "enum": [ "eclab.mpr", "marda:biologic-mpr" ], "title": "Filetype", "type": "string" }, "timezone": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Timezone" }, "locale": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Locale" }, "encoding": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Encoding" } }, "required": [ "filetype" ], "title": "EClab_mpr", "type": "object" }, "EClab_mpt": { "additionalProperties": false, "properties": { "filetype": { "enum": [ "eclab.mpt", "marda:biologic-mpt" ], "title": "Filetype", "type": "string" }, "timezone": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Timezone" }, "locale": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Locale" }, "encoding": { "default": "windows-1252", "title": "Encoding", "type": "string" } }, "required": [ "filetype" ], "title": "EClab_mpt", "type": "object" }, "EZChrom_asc": { "additionalProperties": false, "properties": { "filetype": { "const": "ezchrom.asc", "enum": [ "ezchrom.asc" ], "title": "Filetype", "type": "string" }, "timezone": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Timezone" }, "locale": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Locale" }, "encoding": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Encoding" } }, "required": [ "filetype" ], "title": "EZChrom_asc", "type": "object" }, "ElectroChem": { "additionalProperties": false, "description": "Parser for electrochemistry files.", "properties": { "tag": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Tag" }, "parser": { "const": "electrochem", "enum": [ "electrochem" ], "title": "Parser", "type": "string" }, "input": { "$ref": "#/$defs/Input" }, "extractor": { "discriminator": { "mapping": { "eclab.mpr": "#/$defs/EClab_mpr", "eclab.mpt": "#/$defs/EClab_mpt", "marda:biologic-mpr": "#/$defs/EClab_mpr", "marda:biologic-mpt": "#/$defs/EClab_mpt", "tomato.json": "#/$defs/Tomato_json" }, "propertyName": "filetype" }, "oneOf": [ { "$ref": "#/$defs/EClab_mpr" }, { "$ref": "#/$defs/EClab_mpt" }, { "$ref": "#/$defs/Tomato_json" } ], "title": "Extractor" }, "parameters": { "anyOf": [ { "$ref": "#/$defs/dgbowl_schemas__yadg__dataschema_5_0__parameters__Parameters" }, { "type": "null" } ], "default": null }, "externaldate": { "anyOf": [ { "$ref": "#/$defs/ExternalDate" }, { "type": "null" } ], "default": null } }, "required": [ "parser", "input", "extractor" ], "title": "ElectroChem", "type": "object" }, "EmpaLC_csv": { "additionalProperties": false, "properties": { "filetype": { "const": "empalc.csv", "enum": [ "empalc.csv" ], "title": "Filetype", "type": "string" }, "timezone": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Timezone" }, "locale": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Locale" }, "encoding": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Encoding" } }, "required": [ "filetype" ], "title": "EmpaLC_csv", "type": "object" }, "EmpaLC_xlsx": { "additionalProperties": false, "properties": { "filetype": { "const": "empalc.xlsx", "enum": [ "empalc.xlsx" ], "title": "Filetype", "type": "string" }, "timezone": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Timezone" }, "locale": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Locale" }, "encoding": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Encoding" } }, "required": [ "filetype" ], "title": "EmpaLC_xlsx", "type": "object" }, "ExternalDate": { "additionalProperties": false, "description": "Supply timestamping information that are external to the processed file.", "properties": { "using": { "anyOf": [ { "$ref": "#/$defs/ExternalDateFile" }, { "$ref": "#/$defs/ExternalDateFilename" }, { "$ref": "#/$defs/ExternalDateISOString" }, { "$ref": "#/$defs/ExternalDateUTSOffset" } ], "title": "Using" }, "mode": { "default": "add", "enum": [ "add", "replace" ], "title": "Mode", "type": "string" } }, "required": [ "using" ], "title": "ExternalDate", "type": "object" }, "ExternalDateFile": { "additionalProperties": false, "description": "Read external date information from file.", "properties": { "file": { "$ref": "#/$defs/dgbowl_schemas__yadg__dataschema_5_0__externaldate__ExternalDateFile__Content" } }, "required": [ "file" ], "title": "ExternalDateFile", "type": "object" }, "ExternalDateFilename": { "additionalProperties": false, "description": "Read external date information from the file name.", "properties": { "filename": { "$ref": "#/$defs/dgbowl_schemas__yadg__dataschema_5_0__externaldate__ExternalDateFilename__Content" } }, "required": [ "filename" ], "title": "ExternalDateFilename", "type": "object" }, "ExternalDateISOString": { "additionalProperties": false, "description": "Read a constant external date using an ISO-formatted string.", "properties": { "isostring": { "title": "Isostring", "type": "string" } }, "required": [ "isostring" ], "title": "ExternalDateISOString", "type": "object" }, "ExternalDateUTSOffset": { "additionalProperties": false, "description": "Read a constant external date using a Unix timestamp offset.", "properties": { "utsoffset": { "title": "Utsoffset", "type": "number" } }, "required": [ "utsoffset" ], "title": "ExternalDateUTSOffset", "type": "object" }, "FlowData": { "additionalProperties": false, "description": "Parser for flow controller/meter data.", "properties": { "tag": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Tag" }, "parser": { "const": "flowdata", "enum": [ "flowdata" ], "title": "Parser", "type": "string" }, "input": { "$ref": "#/$defs/Input" }, "extractor": { "discriminator": { "mapping": { "drycal.csv": "#/$defs/Drycal_csv", "drycal.rtf": "#/$defs/Drycal_rtf", "drycal.txt": "#/$defs/Drycal_txt" }, "propertyName": "filetype" }, "oneOf": [ { "$ref": "#/$defs/Drycal_csv" }, { "$ref": "#/$defs/Drycal_rtf" }, { "$ref": "#/$defs/Drycal_txt" } ], "title": "Extractor" }, "parameters": { "anyOf": [ { "$ref": "#/$defs/dgbowl_schemas__yadg__dataschema_5_0__parameters__Parameters" }, { "type": "null" } ], "default": null }, "externaldate": { "anyOf": [ { "$ref": "#/$defs/ExternalDate" }, { "type": "null" } ], "default": null } }, "required": [ "parser", "input", "extractor" ], "title": "FlowData", "type": "object" }, "Fusion_csv": { "additionalProperties": false, "properties": { "filetype": { "const": "fusion.csv", "enum": [ "fusion.csv" ], "title": "Filetype", "type": "string" }, "timezone": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Timezone" }, "locale": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Locale" }, "encoding": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Encoding" } }, "required": [ "filetype" ], "title": "Fusion_csv", "type": "object" }, "Fusion_json": { "additionalProperties": false, "properties": { "filetype": { "const": "fusion.json", "enum": [ "fusion.json" ], "title": "Filetype", "type": "string" }, "timezone": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Timezone" }, "locale": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Locale" }, "encoding": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Encoding" } }, "required": [ "filetype" ], "title": "Fusion_json", "type": "object" }, "Fusion_zip": { "additionalProperties": false, "properties": { "filetype": { "const": "fusion.zip", "enum": [ "fusion.zip" ], "title": "Filetype", "type": "string" }, "timezone": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Timezone" }, "locale": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Locale" }, "encoding": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Encoding" } }, "required": [ "filetype" ], "title": "Fusion_zip", "type": "object" }, "Input": { "additionalProperties": false, "description": "Specification of input files/folders to be processed by the :class:`Step`.", "properties": { "folders": { "items": { "type": "string" }, "title": "Folders", "type": "array" }, "prefix": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Prefix" }, "suffix": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Suffix" }, "contains": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Contains" }, "exclude": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Exclude" } }, "required": [ "folders" ], "title": "Input", "type": "object" }, "LabView_csv": { "additionalProperties": false, "properties": { "filetype": { "const": "labview.csv", "enum": [ "labview.csv" ], "title": "Filetype", "type": "string" }, "timezone": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Timezone" }, "locale": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Locale" }, "encoding": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Encoding" } }, "required": [ "filetype" ], "title": "LabView_csv", "type": "object" }, "MassTrace": { "additionalProperties": false, "description": "Parser for mass spectroscopy traces.", "properties": { "tag": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Tag" }, "parser": { "const": "masstrace", "enum": [ "masstrace" ], "title": "Parser", "type": "string" }, "input": { "$ref": "#/$defs/Input" }, "extractor": { "$ref": "#/$defs/Quadstar_sac" }, "parameters": { "anyOf": [ { "$ref": "#/$defs/dgbowl_schemas__yadg__dataschema_5_0__parameters__Parameters" }, { "type": "null" } ], "default": null }, "externaldate": { "anyOf": [ { "$ref": "#/$defs/ExternalDate" }, { "type": "null" } ], "default": null } }, "required": [ "parser", "input", "extractor" ], "title": "MassTrace", "type": "object" }, "MeasCSV": { "additionalProperties": false, "description": "Legacy file parser for ``measurement.csv`` files from FHI.\n\n.. note::\n\n This parser is deprecated, and the :class:`BasicCSV` parser should be\n used instead.", "properties": { "tag": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Tag" }, "parser": { "const": "meascsv", "enum": [ "meascsv" ], "title": "Parser", "type": "string" }, "input": { "$ref": "#/$defs/Input" }, "extractor": { "$ref": "#/$defs/NoFileType" }, "parameters": { "$ref": "#/$defs/dgbowl_schemas__yadg__dataschema_5_0__step__MeasCSV__Parameters" }, "externaldate": { "anyOf": [ { "$ref": "#/$defs/ExternalDate" }, { "type": "null" } ], "default": null } }, "required": [ "parser", "input" ], "title": "MeasCSV", "type": "object" }, "Metadata": { "additionalProperties": false, "description": "The :class:`Metadata` is a container for any metadata of the :class:`DataSchema`.", "properties": { "version": { "const": "5.0", "enum": [ "5.0" ], "title": "Version", "type": "string" }, "provenance": { "$ref": "#/$defs/Provenance" } }, "required": [ "version", "provenance" ], "title": "Metadata", "type": "object" }, "NoFileType": { "additionalProperties": false, "properties": { "filetype": { "const": "None", "default": "None", "enum": [ "None" ], "title": "Filetype", "type": "string" }, "timezone": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Timezone" }, "locale": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Locale" }, "encoding": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Encoding" } }, "title": "NoFileType", "type": "object" }, "Panalytical_csv": { "additionalProperties": false, "properties": { "filetype": { "const": "panalytical.csv", "enum": [ "panalytical.csv" ], "title": "Filetype", "type": "string" }, "timezone": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Timezone" }, "locale": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Locale" }, "encoding": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Encoding" } }, "required": [ "filetype" ], "title": "Panalytical_csv", "type": "object" }, "Panalytical_xrdml": { "additionalProperties": false, "properties": { "filetype": { "enum": [ "panalytical.xrdml", "marda:panalytical-xrdml" ], "title": "Filetype", "type": "string" }, "timezone": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Timezone" }, "locale": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Locale" }, "encoding": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Encoding" } }, "required": [ "filetype" ], "title": "Panalytical_xrdml", "type": "object" }, "Panalytical_xy": { "additionalProperties": false, "properties": { "filetype": { "const": "panalytical.xy", "enum": [ "panalytical.xy" ], "title": "Filetype", "type": "string" }, "timezone": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Timezone" }, "locale": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Locale" }, "encoding": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Encoding" } }, "required": [ "filetype" ], "title": "Panalytical_xy", "type": "object" }, "Phi_spe": { "additionalProperties": false, "properties": { "filetype": { "enum": [ "phi.spe", "marda:phi-spe" ], "title": "Filetype", "type": "string" }, "timezone": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Timezone" }, "locale": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Locale" }, "encoding": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Encoding" } }, "required": [ "filetype" ], "title": "Phi_spe", "type": "object" }, "Provenance": { "additionalProperties": false, "properties": { "type": { "title": "Type", "type": "string" }, "metadata": { "anyOf": [ { "type": "object" }, { "type": "null" } ], "default": null, "title": "Metadata" } }, "required": [ "type" ], "title": "Provenance", "type": "object" }, "QFTrace": { "additionalProperties": false, "description": "Parser for network analyzer traces.", "properties": { "tag": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Tag" }, "parser": { "const": "qftrace", "enum": [ "qftrace" ], "title": "Parser", "type": "string" }, "input": { "$ref": "#/$defs/Input" }, "extractor": { "$ref": "#/$defs/LabView_csv" }, "parameters": { "anyOf": [ { "$ref": "#/$defs/dgbowl_schemas__yadg__dataschema_5_0__parameters__Parameters" }, { "type": "null" } ], "default": null }, "externaldate": { "anyOf": [ { "$ref": "#/$defs/ExternalDate" }, { "type": "null" } ], "default": null } }, "required": [ "parser", "input", "extractor" ], "title": "QFTrace", "type": "object" }, "Quadstar_sac": { "additionalProperties": false, "properties": { "filetype": { "const": "quadstar.sac", "enum": [ "quadstar.sac" ], "title": "Filetype", "type": "string" }, "timezone": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Timezone" }, "locale": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Locale" }, "encoding": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Encoding" } }, "required": [ "filetype" ], "title": "Quadstar_sac", "type": "object" }, "StepDefaults": { "additionalProperties": false, "description": "Configuration of defaults applicable for all steps.", "properties": { "timezone": { "default": "localtime", "title": "Timezone", "type": "string" }, "locale": { "anyOf": [ { "maxItems": 2, "minItems": 2, "prefixItems": [ { "type": "string" }, { "type": "string" } ], "type": "array" }, { "type": "string" }, { "type": "null" } ], "default": null, "title": "Locale" }, "encoding": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Encoding" } }, "title": "StepDefaults", "type": "object" }, "TimeDate": { "additionalProperties": false, "description": "Timestamp from a separate date and/or time column.", "properties": { "date": { "anyOf": [ { "$ref": "#/$defs/TimestampSpec" }, { "type": "null" } ], "default": null }, "time": { "anyOf": [ { "$ref": "#/$defs/TimestampSpec" }, { "type": "null" } ], "default": null } }, "title": "TimeDate", "type": "object" }, "Timestamp": { "additionalProperties": false, "description": "Timestamp from a column containing a single timestamp string.", "properties": { "timestamp": { "$ref": "#/$defs/TimestampSpec" } }, "required": [ "timestamp" ], "title": "Timestamp", "type": "object" }, "TimestampSpec": { "additionalProperties": false, "description": "Specification of the column index and string format of the timestamp.", "properties": { "index": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "title": "Index" }, "format": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Format" } }, "title": "TimestampSpec", "type": "object" }, "Tomato_json": { "additionalProperties": false, "properties": { "filetype": { "const": "tomato.json", "enum": [ "tomato.json" ], "title": "Filetype", "type": "string" }, "timezone": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Timezone" }, "locale": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Locale" }, "encoding": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Encoding" } }, "required": [ "filetype" ], "title": "Tomato_json", "type": "object" }, "UTS": { "additionalProperties": false, "description": "Timestamp from a column containing a Unix timestamp.", "properties": { "uts": { "$ref": "#/$defs/TimestampSpec" } }, "required": [ "uts" ], "title": "UTS", "type": "object" }, "XPSTrace": { "additionalProperties": false, "description": "Parser for XPS traces.", "properties": { "tag": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Tag" }, "parser": { "const": "xpstrace", "enum": [ "xpstrace" ], "title": "Parser", "type": "string" }, "input": { "$ref": "#/$defs/Input" }, "extractor": { "$ref": "#/$defs/Phi_spe" }, "parameters": { "anyOf": [ { "$ref": "#/$defs/dgbowl_schemas__yadg__dataschema_5_0__parameters__Parameters" }, { "type": "null" } ], "default": null }, "externaldate": { "anyOf": [ { "$ref": "#/$defs/ExternalDate" }, { "type": "null" } ], "default": null } }, "required": [ "parser", "input", "extractor" ], "title": "XPSTrace", "type": "object" }, "XRDTrace": { "additionalProperties": false, "description": "Parser for XRD traces.", "properties": { "tag": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Tag" }, "parser": { "const": "xrdtrace", "enum": [ "xrdtrace" ], "title": "Parser", "type": "string" }, "input": { "$ref": "#/$defs/Input" }, "extractor": { "anyOf": [ { "$ref": "#/$defs/Panalytical_xrdml" }, { "$ref": "#/$defs/Panalytical_xy" }, { "$ref": "#/$defs/Panalytical_csv" } ], "title": "Extractor" }, "parameters": { "anyOf": [ { "$ref": "#/$defs/dgbowl_schemas__yadg__dataschema_5_0__parameters__Parameters" }, { "type": "null" } ], "default": null }, "externaldate": { "anyOf": [ { "$ref": "#/$defs/ExternalDate" }, { "type": "null" } ], "default": null } }, "required": [ "parser", "input", "extractor" ], "title": "XRDTrace", "type": "object" }, "dgbowl_schemas__yadg__dataschema_5_0__externaldate__ExternalDateFile__Content": { "additionalProperties": false, "properties": { "path": { "title": "Path", "type": "string" }, "type": { "title": "Type", "type": "string" }, "match": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Match" } }, "required": [ "path", "type" ], "title": "Content", "type": "object" }, "dgbowl_schemas__yadg__dataschema_5_0__externaldate__ExternalDateFilename__Content": { "additionalProperties": false, "properties": { "format": { "title": "Format", "type": "string" }, "len": { "title": "Len", "type": "integer" } }, "required": [ "format", "len" ], "title": "Content", "type": "object" }, "dgbowl_schemas__yadg__dataschema_5_0__parameters__Parameters": { "additionalProperties": false, "description": "Empty parameters specification with no extras allowed.", "properties": {}, "title": "Parameters", "type": "object" }, "dgbowl_schemas__yadg__dataschema_5_0__step__BasicCSV__Parameters": { "additionalProperties": false, "properties": { "sep": { "default": ",", "title": "Sep", "type": "string" }, "strip": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Strip" }, "units": { "anyOf": [ { "additionalProperties": { "type": "string" }, "type": "object" }, { "type": "null" } ], "default": null, "title": "Units" }, "timestamp": { "anyOf": [ { "$ref": "#/$defs/Timestamp" }, { "$ref": "#/$defs/TimeDate" }, { "$ref": "#/$defs/UTS" }, { "type": "null" } ], "default": null, "title": "Timestamp" } }, "title": "Parameters", "type": "object" }, "dgbowl_schemas__yadg__dataschema_5_0__step__Dummy__Parameters": { "additionalProperties": true, "properties": {}, "title": "Parameters", "type": "object" }, "dgbowl_schemas__yadg__dataschema_5_0__step__MeasCSV__Parameters": { "additionalProperties": false, "properties": { "timestamp": { "anyOf": [ { "$ref": "#/$defs/Timestamp" }, { "$ref": "#/$defs/TimeDate" }, { "$ref": "#/$defs/UTS" } ], "default": { "timestamp": { "format": "%Y-%m-%d-%H-%M-%S", "index": 0 } }, "title": "Timestamp" } }, "title": "Parameters", "type": "object" } }, "additionalProperties": false, "required": [ "metadata", "steps" ] }
- Config:
extra: str = forbid
- field step_defaults: StepDefaults = StepDefaults(timezone='Etc/UTC', locale='en_US.UTF-8', encoding=None)
Default values for configuration of
yadg’s parsers.
- field steps: Sequence[Dummy | BasicCSV | MeasCSV | FlowData | ElectroChem | ChromTrace | ChromData | MassTrace | QFTrace | XPSTrace | XRDTrace] [Required]
Input commands for
yadg’s parsers, organised as a sequence of steps.
- update()
Submodules
dgbowl_schemas.yadg.dataschema_5_0.externaldate module
- pydantic model dgbowl_schemas.yadg.dataschema_5_0.externaldate.ExternalDateFile
Bases:
BaseModelRead external date information from file.
Show JSON schema
{ "title": "ExternalDateFile", "description": "Read external date information from file.", "type": "object", "properties": { "file": { "$ref": "#/$defs/Content" } }, "$defs": { "Content": { "additionalProperties": false, "properties": { "path": { "title": "Path", "type": "string" }, "type": { "title": "Type", "type": "string" }, "match": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Match" } }, "required": [ "path", "type" ], "title": "Content", "type": "object" } }, "additionalProperties": false, "required": [ "file" ] }
- Config:
extra: str = forbid
- pydantic model Content
Bases:
BaseModelShow JSON schema
{ "title": "Content", "type": "object", "properties": { "path": { "title": "Path", "type": "string" }, "type": { "title": "Type", "type": "string" }, "match": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Match" } }, "additionalProperties": false, "required": [ "path", "type" ] }
- Config:
extra: str = forbid
- field path: str [Required]
Path to the external date information file.
- field type: str [Required]
Type of the external date information file.
- field match: str | None = None
String to be matched within the file.
- pydantic model dgbowl_schemas.yadg.dataschema_5_0.externaldate.ExternalDateFilename
Bases:
BaseModelRead external date information from the file name.
Show JSON schema
{ "title": "ExternalDateFilename", "description": "Read external date information from the file name.", "type": "object", "properties": { "filename": { "$ref": "#/$defs/Content" } }, "$defs": { "Content": { "additionalProperties": false, "properties": { "format": { "title": "Format", "type": "string" }, "len": { "title": "Len", "type": "integer" } }, "required": [ "format", "len" ], "title": "Content", "type": "object" } }, "additionalProperties": false, "required": [ "filename" ] }
- Config:
extra: str = forbid
- pydantic model Content
Bases:
BaseModelShow JSON schema
{ "title": "Content", "type": "object", "properties": { "format": { "title": "Format", "type": "string" }, "len": { "title": "Len", "type": "integer" } }, "additionalProperties": false, "required": [ "format", "len" ] }
- Config:
extra: str = forbid
- field format: str [Required]
strptime-like format string for processing the date.
- field len: int [Required]
Number of characters from the start of the filename to parse.
- pydantic model dgbowl_schemas.yadg.dataschema_5_0.externaldate.ExternalDateISOString
Bases:
BaseModelRead a constant external date using an ISO-formatted string.
Show JSON schema
{ "title": "ExternalDateISOString", "description": "Read a constant external date using an ISO-formatted string.", "type": "object", "properties": { "isostring": { "title": "Isostring", "type": "string" } }, "additionalProperties": false, "required": [ "isostring" ] }
- Config:
extra: str = forbid
- field isostring: str [Required]
- pydantic model dgbowl_schemas.yadg.dataschema_5_0.externaldate.ExternalDateUTSOffset
Bases:
BaseModelRead a constant external date using a Unix timestamp offset.
Show JSON schema
{ "title": "ExternalDateUTSOffset", "description": "Read a constant external date using a Unix timestamp offset.", "type": "object", "properties": { "utsoffset": { "title": "Utsoffset", "type": "number" } }, "additionalProperties": false, "required": [ "utsoffset" ] }
- Config:
extra: str = forbid
- field utsoffset: float [Required]
- pydantic model dgbowl_schemas.yadg.dataschema_5_0.externaldate.ExternalDate
Bases:
BaseModelSupply timestamping information that are external to the processed file.
Show JSON schema
{ "title": "ExternalDate", "description": "Supply timestamping information that are external to the processed file.", "type": "object", "properties": { "using": { "anyOf": [ { "$ref": "#/$defs/ExternalDateFile" }, { "$ref": "#/$defs/ExternalDateFilename" }, { "$ref": "#/$defs/ExternalDateISOString" }, { "$ref": "#/$defs/ExternalDateUTSOffset" } ], "title": "Using" }, "mode": { "default": "add", "enum": [ "add", "replace" ], "title": "Mode", "type": "string" } }, "$defs": { "ExternalDateFile": { "additionalProperties": false, "description": "Read external date information from file.", "properties": { "file": { "$ref": "#/$defs/dgbowl_schemas__yadg__dataschema_5_0__externaldate__ExternalDateFile__Content" } }, "required": [ "file" ], "title": "ExternalDateFile", "type": "object" }, "ExternalDateFilename": { "additionalProperties": false, "description": "Read external date information from the file name.", "properties": { "filename": { "$ref": "#/$defs/dgbowl_schemas__yadg__dataschema_5_0__externaldate__ExternalDateFilename__Content" } }, "required": [ "filename" ], "title": "ExternalDateFilename", "type": "object" }, "ExternalDateISOString": { "additionalProperties": false, "description": "Read a constant external date using an ISO-formatted string.", "properties": { "isostring": { "title": "Isostring", "type": "string" } }, "required": [ "isostring" ], "title": "ExternalDateISOString", "type": "object" }, "ExternalDateUTSOffset": { "additionalProperties": false, "description": "Read a constant external date using a Unix timestamp offset.", "properties": { "utsoffset": { "title": "Utsoffset", "type": "number" } }, "required": [ "utsoffset" ], "title": "ExternalDateUTSOffset", "type": "object" }, "dgbowl_schemas__yadg__dataschema_5_0__externaldate__ExternalDateFile__Content": { "additionalProperties": false, "properties": { "path": { "title": "Path", "type": "string" }, "type": { "title": "Type", "type": "string" }, "match": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Match" } }, "required": [ "path", "type" ], "title": "Content", "type": "object" }, "dgbowl_schemas__yadg__dataschema_5_0__externaldate__ExternalDateFilename__Content": { "additionalProperties": false, "properties": { "format": { "title": "Format", "type": "string" }, "len": { "title": "Len", "type": "integer" } }, "required": [ "format", "len" ], "title": "Content", "type": "object" } }, "additionalProperties": false, "required": [ "using" ] }
- Config:
extra: str = forbid
- field using: ExternalDateFile | ExternalDateFilename | ExternalDateISOString | ExternalDateUTSOffset [Required]
Specification of the external date format.
- field mode: Literal['add', 'replace'] = 'add'
Whether the external timestamps should be added to or should replace the parsed data.
dgbowl_schemas.yadg.dataschema_5_0.filetype module
- pydantic model dgbowl_schemas.yadg.dataschema_5_0.filetype.FileType
Bases:
BaseModel,ABCTemplate abstract base class for parser classes.
Show JSON schema
{ "title": "FileType", "description": "Template abstract base class for parser classes.", "type": "object", "properties": { "filetype": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Filetype" }, "timezone": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Timezone" }, "locale": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Locale" }, "encoding": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Encoding" } }, "additionalProperties": false }
- Config:
extra: str = forbid
- Validators:
- field filetype: str | None = None
- field timezone: str | None = None
- Validated by:
- field locale: str | None = None
- Validated by:
- field encoding: str | None = None
- pydantic model dgbowl_schemas.yadg.dataschema_5_0.filetype.NoFileType
Bases:
FileTypeShow JSON schema
{ "title": "NoFileType", "type": "object", "properties": { "filetype": { "const": "None", "default": "None", "enum": [ "None" ], "title": "Filetype", "type": "string" }, "timezone": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Timezone" }, "locale": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Locale" }, "encoding": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Encoding" } }, "additionalProperties": false }
- Config:
extra: str = forbid
- Validators:
- field filetype: Literal['None'] = 'None'
- pydantic model dgbowl_schemas.yadg.dataschema_5_0.filetype.Tomato_json
Bases:
FileTypeShow JSON schema
{ "title": "Tomato_json", "type": "object", "properties": { "filetype": { "const": "tomato.json", "enum": [ "tomato.json" ], "title": "Filetype", "type": "string" }, "timezone": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Timezone" }, "locale": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Locale" }, "encoding": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Encoding" } }, "additionalProperties": false, "required": [ "filetype" ] }
- Config:
extra: str = forbid
- Validators:
- field filetype: Literal['tomato.json'] [Required]
- pydantic model dgbowl_schemas.yadg.dataschema_5_0.filetype.Drycal_csv
Bases:
FileTypeShow JSON schema
{ "title": "Drycal_csv", "type": "object", "properties": { "filetype": { "const": "drycal.csv", "enum": [ "drycal.csv" ], "title": "Filetype", "type": "string" }, "timezone": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Timezone" }, "locale": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Locale" }, "encoding": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Encoding" } }, "additionalProperties": false, "required": [ "filetype" ] }
- Config:
extra: str = forbid
- Validators:
- field filetype: Literal['drycal.csv'] [Required]
- pydantic model dgbowl_schemas.yadg.dataschema_5_0.filetype.Drycal_rtf
Bases:
FileTypeShow JSON schema
{ "title": "Drycal_rtf", "type": "object", "properties": { "filetype": { "const": "drycal.rtf", "enum": [ "drycal.rtf" ], "title": "Filetype", "type": "string" }, "timezone": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Timezone" }, "locale": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Locale" }, "encoding": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Encoding" } }, "additionalProperties": false, "required": [ "filetype" ] }
- Config:
extra: str = forbid
- Validators:
- field filetype: Literal['drycal.rtf'] [Required]
- pydantic model dgbowl_schemas.yadg.dataschema_5_0.filetype.Drycal_txt
Bases:
FileTypeShow JSON schema
{ "title": "Drycal_txt", "type": "object", "properties": { "filetype": { "const": "drycal.txt", "enum": [ "drycal.txt" ], "title": "Filetype", "type": "string" }, "timezone": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Timezone" }, "locale": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Locale" }, "encoding": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Encoding" } }, "additionalProperties": false, "required": [ "filetype" ] }
- Config:
extra: str = forbid
- Validators:
- field filetype: Literal['drycal.txt'] [Required]
- pydantic model dgbowl_schemas.yadg.dataschema_5_0.filetype.EClab_mpr
Bases:
FileTypeShow JSON schema
{ "title": "EClab_mpr", "type": "object", "properties": { "filetype": { "enum": [ "eclab.mpr", "marda:biologic-mpr" ], "title": "Filetype", "type": "string" }, "timezone": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Timezone" }, "locale": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Locale" }, "encoding": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Encoding" } }, "additionalProperties": false, "required": [ "filetype" ] }
- Config:
extra: str = forbid
- Validators:
- field filetype: Literal['eclab.mpr', 'marda:biologic-mpr'] [Required]
- pydantic model dgbowl_schemas.yadg.dataschema_5_0.filetype.EClab_mpt
Bases:
FileTypeShow JSON schema
{ "title": "EClab_mpt", "type": "object", "properties": { "filetype": { "enum": [ "eclab.mpt", "marda:biologic-mpt" ], "title": "Filetype", "type": "string" }, "timezone": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Timezone" }, "locale": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Locale" }, "encoding": { "default": "windows-1252", "title": "Encoding", "type": "string" } }, "additionalProperties": false, "required": [ "filetype" ] }
- Config:
extra: str = forbid
- Validators:
- field filetype: Literal['eclab.mpt', 'marda:biologic-mpt'] [Required]
- field encoding: str = 'windows-1252'
- pydantic model dgbowl_schemas.yadg.dataschema_5_0.filetype.EZChrom_asc
Bases:
FileTypeShow JSON schema
{ "title": "EZChrom_asc", "type": "object", "properties": { "filetype": { "const": "ezchrom.asc", "enum": [ "ezchrom.asc" ], "title": "Filetype", "type": "string" }, "timezone": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Timezone" }, "locale": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Locale" }, "encoding": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Encoding" } }, "additionalProperties": false, "required": [ "filetype" ] }
- Config:
extra: str = forbid
- Validators:
- field filetype: Literal['ezchrom.asc'] [Required]
- pydantic model dgbowl_schemas.yadg.dataschema_5_0.filetype.Fusion_json
Bases:
FileTypeShow JSON schema
{ "title": "Fusion_json", "type": "object", "properties": { "filetype": { "const": "fusion.json", "enum": [ "fusion.json" ], "title": "Filetype", "type": "string" }, "timezone": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Timezone" }, "locale": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Locale" }, "encoding": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Encoding" } }, "additionalProperties": false, "required": [ "filetype" ] }
- Config:
extra: str = forbid
- Validators:
- field filetype: Literal['fusion.json'] [Required]
- pydantic model dgbowl_schemas.yadg.dataschema_5_0.filetype.Fusion_zip
Bases:
FileTypeShow JSON schema
{ "title": "Fusion_zip", "type": "object", "properties": { "filetype": { "const": "fusion.zip", "enum": [ "fusion.zip" ], "title": "Filetype", "type": "string" }, "timezone": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Timezone" }, "locale": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Locale" }, "encoding": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Encoding" } }, "additionalProperties": false, "required": [ "filetype" ] }
- Config:
extra: str = forbid
- Validators:
- field filetype: Literal['fusion.zip'] [Required]
- pydantic model dgbowl_schemas.yadg.dataschema_5_0.filetype.Fusion_csv
Bases:
FileTypeShow JSON schema
{ "title": "Fusion_csv", "type": "object", "properties": { "filetype": { "const": "fusion.csv", "enum": [ "fusion.csv" ], "title": "Filetype", "type": "string" }, "timezone": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Timezone" }, "locale": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Locale" }, "encoding": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Encoding" } }, "additionalProperties": false, "required": [ "filetype" ] }
- Config:
extra: str = forbid
- Validators:
- field filetype: Literal['fusion.csv'] [Required]
- pydantic model dgbowl_schemas.yadg.dataschema_5_0.filetype.Agilent_ch
Bases:
FileTypeShow JSON schema
{ "title": "Agilent_ch", "type": "object", "properties": { "filetype": { "enum": [ "agilent.ch", "marda:agilent-ch" ], "title": "Filetype", "type": "string" }, "timezone": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Timezone" }, "locale": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Locale" }, "encoding": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Encoding" } }, "additionalProperties": false, "required": [ "filetype" ] }
- Config:
extra: str = forbid
- Validators:
- field filetype: Literal['agilent.ch', 'marda:agilent-ch'] [Required]
- pydantic model dgbowl_schemas.yadg.dataschema_5_0.filetype.Agilent_dx
Bases:
FileTypeShow JSON schema
{ "title": "Agilent_dx", "type": "object", "properties": { "filetype": { "enum": [ "agilent.dx", "marda:agilent-dx" ], "title": "Filetype", "type": "string" }, "timezone": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Timezone" }, "locale": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Locale" }, "encoding": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Encoding" } }, "additionalProperties": false, "required": [ "filetype" ] }
- Config:
extra: str = forbid
- Validators:
- field filetype: Literal['agilent.dx', 'marda:agilent-dx'] [Required]
- pydantic model dgbowl_schemas.yadg.dataschema_5_0.filetype.Agilent_csv
Bases:
FileTypeShow JSON schema
{ "title": "Agilent_csv", "type": "object", "properties": { "filetype": { "const": "agilent.csv", "enum": [ "agilent.csv" ], "title": "Filetype", "type": "string" }, "timezone": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Timezone" }, "locale": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Locale" }, "encoding": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Encoding" } }, "additionalProperties": false, "required": [ "filetype" ] }
- Config:
extra: str = forbid
- Validators:
- field filetype: Literal['agilent.csv'] [Required]
- pydantic model dgbowl_schemas.yadg.dataschema_5_0.filetype.EmpaLC_csv
Bases:
FileTypeShow JSON schema
{ "title": "EmpaLC_csv", "type": "object", "properties": { "filetype": { "const": "empalc.csv", "enum": [ "empalc.csv" ], "title": "Filetype", "type": "string" }, "timezone": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Timezone" }, "locale": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Locale" }, "encoding": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Encoding" } }, "additionalProperties": false, "required": [ "filetype" ] }
- Config:
extra: str = forbid
- Validators:
- field filetype: Literal['empalc.csv'] [Required]
- pydantic model dgbowl_schemas.yadg.dataschema_5_0.filetype.EmpaLC_xlsx
Bases:
FileTypeShow JSON schema
{ "title": "EmpaLC_xlsx", "type": "object", "properties": { "filetype": { "const": "empalc.xlsx", "enum": [ "empalc.xlsx" ], "title": "Filetype", "type": "string" }, "timezone": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Timezone" }, "locale": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Locale" }, "encoding": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Encoding" } }, "additionalProperties": false, "required": [ "filetype" ] }
- Config:
extra: str = forbid
- Validators:
- field filetype: Literal['empalc.xlsx'] [Required]
- pydantic model dgbowl_schemas.yadg.dataschema_5_0.filetype.Quadstar_sac
Bases:
FileTypeShow JSON schema
{ "title": "Quadstar_sac", "type": "object", "properties": { "filetype": { "const": "quadstar.sac", "enum": [ "quadstar.sac" ], "title": "Filetype", "type": "string" }, "timezone": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Timezone" }, "locale": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Locale" }, "encoding": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Encoding" } }, "additionalProperties": false, "required": [ "filetype" ] }
- Config:
extra: str = forbid
- Validators:
- field filetype: Literal['quadstar.sac'] [Required]
- dgbowl_schemas.yadg.dataschema_5_0.filetype.MassTraceFileTypes
alias of
Quadstar_sac
- pydantic model dgbowl_schemas.yadg.dataschema_5_0.filetype.LabView_csv
Bases:
FileTypeShow JSON schema
{ "title": "LabView_csv", "type": "object", "properties": { "filetype": { "const": "labview.csv", "enum": [ "labview.csv" ], "title": "Filetype", "type": "string" }, "timezone": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Timezone" }, "locale": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Locale" }, "encoding": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Encoding" } }, "additionalProperties": false, "required": [ "filetype" ] }
- Config:
extra: str = forbid
- Validators:
- field filetype: Literal['labview.csv'] [Required]
- dgbowl_schemas.yadg.dataschema_5_0.filetype.QFTraceFileTypes
alias of
LabView_csv
- pydantic model dgbowl_schemas.yadg.dataschema_5_0.filetype.Phi_spe
Bases:
FileTypeShow JSON schema
{ "title": "Phi_spe", "type": "object", "properties": { "filetype": { "enum": [ "phi.spe", "marda:phi-spe" ], "title": "Filetype", "type": "string" }, "timezone": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Timezone" }, "locale": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Locale" }, "encoding": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Encoding" } }, "additionalProperties": false, "required": [ "filetype" ] }
- Config:
extra: str = forbid
- Validators:
- field filetype: Literal['phi.spe', 'marda:phi-spe'] [Required]
- pydantic model dgbowl_schemas.yadg.dataschema_5_0.filetype.Panalytical_xrdml
Bases:
FileTypeShow JSON schema
{ "title": "Panalytical_xrdml", "type": "object", "properties": { "filetype": { "enum": [ "panalytical.xrdml", "marda:panalytical-xrdml" ], "title": "Filetype", "type": "string" }, "timezone": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Timezone" }, "locale": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Locale" }, "encoding": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Encoding" } }, "additionalProperties": false, "required": [ "filetype" ] }
- Config:
extra: str = forbid
- Validators:
- field filetype: Literal['panalytical.xrdml', 'marda:panalytical-xrdml'] [Required]
- pydantic model dgbowl_schemas.yadg.dataschema_5_0.filetype.Panalytical_xy
Bases:
FileTypeShow JSON schema
{ "title": "Panalytical_xy", "type": "object", "properties": { "filetype": { "const": "panalytical.xy", "enum": [ "panalytical.xy" ], "title": "Filetype", "type": "string" }, "timezone": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Timezone" }, "locale": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Locale" }, "encoding": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Encoding" } }, "additionalProperties": false, "required": [ "filetype" ] }
- Config:
extra: str = forbid
- Validators:
- field filetype: Literal['panalytical.xy'] [Required]
- pydantic model dgbowl_schemas.yadg.dataschema_5_0.filetype.Panalytical_csv
Bases:
FileTypeShow JSON schema
{ "title": "Panalytical_csv", "type": "object", "properties": { "filetype": { "const": "panalytical.csv", "enum": [ "panalytical.csv" ], "title": "Filetype", "type": "string" }, "timezone": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Timezone" }, "locale": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Locale" }, "encoding": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Encoding" } }, "additionalProperties": false, "required": [ "filetype" ] }
- Config:
extra: str = forbid
- Validators:
- field filetype: Literal['panalytical.csv'] [Required]
- pydantic model dgbowl_schemas.yadg.dataschema_5_0.filetype.ExtractorFactory
Bases:
BaseModelExtractor factory class.
Given an
extractor=dict(filetype=k, ...)argument, attempts to determine the correctFileType, parses any additionally supplied parameters for thatFileType, and back-fills defaults such astimezone,locale, andencoding.The following is the current usage pattern in
yadg:ftype = ExtractorFactory(extractor={"filetype": k}).extractor
Show JSON schema
{ "title": "ExtractorFactory", "description": "Extractor factory class.\n\nGiven an ``extractor=dict(filetype=k, ...)`` argument, attempts to determine the\ncorrect :class:`FileType`, parses any additionally supplied parameters for that\n:class:`FileType`, and back-fills defaults such as ``timezone``, ``locale``, and\n``encoding``.\n\nThe following is the current usage pattern in :mod:`yadg`:\n\n.. code-block::\n\n ftype = ExtractorFactory(extractor={\"filetype\": k}).extractor", "type": "object", "properties": { "extractor": { "discriminator": { "mapping": { "None": "#/$defs/NoFileType", "agilent.ch": "#/$defs/Agilent_ch", "agilent.csv": "#/$defs/Agilent_csv", "agilent.dx": "#/$defs/Agilent_dx", "drycal.csv": "#/$defs/Drycal_csv", "drycal.rtf": "#/$defs/Drycal_rtf", "drycal.txt": "#/$defs/Drycal_txt", "eclab.mpr": "#/$defs/EClab_mpr", "eclab.mpt": "#/$defs/EClab_mpt", "empalc.csv": "#/$defs/EmpaLC_csv", "empalc.xlsx": "#/$defs/EmpaLC_xlsx", "ezchrom.asc": "#/$defs/EZChrom_asc", "fusion.csv": "#/$defs/Fusion_csv", "fusion.json": "#/$defs/Fusion_json", "fusion.zip": "#/$defs/Fusion_zip", "labview.csv": "#/$defs/LabView_csv", "marda:agilent-ch": "#/$defs/Agilent_ch", "marda:agilent-dx": "#/$defs/Agilent_dx", "marda:biologic-mpr": "#/$defs/EClab_mpr", "marda:biologic-mpt": "#/$defs/EClab_mpt", "marda:panalytical-xrdml": "#/$defs/Panalytical_xrdml", "marda:phi-spe": "#/$defs/Phi_spe", "panalytical.csv": "#/$defs/Panalytical_csv", "panalytical.xrdml": "#/$defs/Panalytical_xrdml", "panalytical.xy": "#/$defs/Panalytical_xy", "phi.spe": "#/$defs/Phi_spe", "quadstar.sac": "#/$defs/Quadstar_sac", "tomato.json": "#/$defs/Tomato_json" }, "propertyName": "filetype" }, "oneOf": [ { "$ref": "#/$defs/NoFileType" }, { "$ref": "#/$defs/Tomato_json" }, { "$ref": "#/$defs/Drycal_csv" }, { "$ref": "#/$defs/Drycal_rtf" }, { "$ref": "#/$defs/Drycal_txt" }, { "$ref": "#/$defs/EClab_mpr" }, { "$ref": "#/$defs/EClab_mpt" }, { "$ref": "#/$defs/Fusion_json" }, { "$ref": "#/$defs/Fusion_zip" }, { "$ref": "#/$defs/Fusion_csv" }, { "$ref": "#/$defs/EmpaLC_csv" }, { "$ref": "#/$defs/EmpaLC_xlsx" }, { "$ref": "#/$defs/EZChrom_asc" }, { "$ref": "#/$defs/Agilent_ch" }, { "$ref": "#/$defs/Agilent_dx" }, { "$ref": "#/$defs/Agilent_csv" }, { "$ref": "#/$defs/Quadstar_sac" }, { "$ref": "#/$defs/LabView_csv" }, { "$ref": "#/$defs/Phi_spe" }, { "$ref": "#/$defs/Panalytical_xrdml" }, { "$ref": "#/$defs/Panalytical_xy" }, { "$ref": "#/$defs/Panalytical_csv" } ], "title": "Extractor" } }, "$defs": { "Agilent_ch": { "additionalProperties": false, "properties": { "filetype": { "enum": [ "agilent.ch", "marda:agilent-ch" ], "title": "Filetype", "type": "string" }, "timezone": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Timezone" }, "locale": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Locale" }, "encoding": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Encoding" } }, "required": [ "filetype" ], "title": "Agilent_ch", "type": "object" }, "Agilent_csv": { "additionalProperties": false, "properties": { "filetype": { "const": "agilent.csv", "enum": [ "agilent.csv" ], "title": "Filetype", "type": "string" }, "timezone": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Timezone" }, "locale": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Locale" }, "encoding": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Encoding" } }, "required": [ "filetype" ], "title": "Agilent_csv", "type": "object" }, "Agilent_dx": { "additionalProperties": false, "properties": { "filetype": { "enum": [ "agilent.dx", "marda:agilent-dx" ], "title": "Filetype", "type": "string" }, "timezone": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Timezone" }, "locale": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Locale" }, "encoding": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Encoding" } }, "required": [ "filetype" ], "title": "Agilent_dx", "type": "object" }, "Drycal_csv": { "additionalProperties": false, "properties": { "filetype": { "const": "drycal.csv", "enum": [ "drycal.csv" ], "title": "Filetype", "type": "string" }, "timezone": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Timezone" }, "locale": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Locale" }, "encoding": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Encoding" } }, "required": [ "filetype" ], "title": "Drycal_csv", "type": "object" }, "Drycal_rtf": { "additionalProperties": false, "properties": { "filetype": { "const": "drycal.rtf", "enum": [ "drycal.rtf" ], "title": "Filetype", "type": "string" }, "timezone": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Timezone" }, "locale": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Locale" }, "encoding": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Encoding" } }, "required": [ "filetype" ], "title": "Drycal_rtf", "type": "object" }, "Drycal_txt": { "additionalProperties": false, "properties": { "filetype": { "const": "drycal.txt", "enum": [ "drycal.txt" ], "title": "Filetype", "type": "string" }, "timezone": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Timezone" }, "locale": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Locale" }, "encoding": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Encoding" } }, "required": [ "filetype" ], "title": "Drycal_txt", "type": "object" }, "EClab_mpr": { "additionalProperties": false, "properties": { "filetype": { "enum": [ "eclab.mpr", "marda:biologic-mpr" ], "title": "Filetype", "type": "string" }, "timezone": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Timezone" }, "locale": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Locale" }, "encoding": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Encoding" } }, "required": [ "filetype" ], "title": "EClab_mpr", "type": "object" }, "EClab_mpt": { "additionalProperties": false, "properties": { "filetype": { "enum": [ "eclab.mpt", "marda:biologic-mpt" ], "title": "Filetype", "type": "string" }, "timezone": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Timezone" }, "locale": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Locale" }, "encoding": { "default": "windows-1252", "title": "Encoding", "type": "string" } }, "required": [ "filetype" ], "title": "EClab_mpt", "type": "object" }, "EZChrom_asc": { "additionalProperties": false, "properties": { "filetype": { "const": "ezchrom.asc", "enum": [ "ezchrom.asc" ], "title": "Filetype", "type": "string" }, "timezone": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Timezone" }, "locale": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Locale" }, "encoding": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Encoding" } }, "required": [ "filetype" ], "title": "EZChrom_asc", "type": "object" }, "EmpaLC_csv": { "additionalProperties": false, "properties": { "filetype": { "const": "empalc.csv", "enum": [ "empalc.csv" ], "title": "Filetype", "type": "string" }, "timezone": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Timezone" }, "locale": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Locale" }, "encoding": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Encoding" } }, "required": [ "filetype" ], "title": "EmpaLC_csv", "type": "object" }, "EmpaLC_xlsx": { "additionalProperties": false, "properties": { "filetype": { "const": "empalc.xlsx", "enum": [ "empalc.xlsx" ], "title": "Filetype", "type": "string" }, "timezone": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Timezone" }, "locale": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Locale" }, "encoding": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Encoding" } }, "required": [ "filetype" ], "title": "EmpaLC_xlsx", "type": "object" }, "Fusion_csv": { "additionalProperties": false, "properties": { "filetype": { "const": "fusion.csv", "enum": [ "fusion.csv" ], "title": "Filetype", "type": "string" }, "timezone": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Timezone" }, "locale": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Locale" }, "encoding": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Encoding" } }, "required": [ "filetype" ], "title": "Fusion_csv", "type": "object" }, "Fusion_json": { "additionalProperties": false, "properties": { "filetype": { "const": "fusion.json", "enum": [ "fusion.json" ], "title": "Filetype", "type": "string" }, "timezone": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Timezone" }, "locale": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Locale" }, "encoding": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Encoding" } }, "required": [ "filetype" ], "title": "Fusion_json", "type": "object" }, "Fusion_zip": { "additionalProperties": false, "properties": { "filetype": { "const": "fusion.zip", "enum": [ "fusion.zip" ], "title": "Filetype", "type": "string" }, "timezone": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Timezone" }, "locale": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Locale" }, "encoding": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Encoding" } }, "required": [ "filetype" ], "title": "Fusion_zip", "type": "object" }, "LabView_csv": { "additionalProperties": false, "properties": { "filetype": { "const": "labview.csv", "enum": [ "labview.csv" ], "title": "Filetype", "type": "string" }, "timezone": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Timezone" }, "locale": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Locale" }, "encoding": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Encoding" } }, "required": [ "filetype" ], "title": "LabView_csv", "type": "object" }, "NoFileType": { "additionalProperties": false, "properties": { "filetype": { "const": "None", "default": "None", "enum": [ "None" ], "title": "Filetype", "type": "string" }, "timezone": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Timezone" }, "locale": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Locale" }, "encoding": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Encoding" } }, "title": "NoFileType", "type": "object" }, "Panalytical_csv": { "additionalProperties": false, "properties": { "filetype": { "const": "panalytical.csv", "enum": [ "panalytical.csv" ], "title": "Filetype", "type": "string" }, "timezone": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Timezone" }, "locale": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Locale" }, "encoding": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Encoding" } }, "required": [ "filetype" ], "title": "Panalytical_csv", "type": "object" }, "Panalytical_xrdml": { "additionalProperties": false, "properties": { "filetype": { "enum": [ "panalytical.xrdml", "marda:panalytical-xrdml" ], "title": "Filetype", "type": "string" }, "timezone": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Timezone" }, "locale": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Locale" }, "encoding": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Encoding" } }, "required": [ "filetype" ], "title": "Panalytical_xrdml", "type": "object" }, "Panalytical_xy": { "additionalProperties": false, "properties": { "filetype": { "const": "panalytical.xy", "enum": [ "panalytical.xy" ], "title": "Filetype", "type": "string" }, "timezone": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Timezone" }, "locale": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Locale" }, "encoding": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Encoding" } }, "required": [ "filetype" ], "title": "Panalytical_xy", "type": "object" }, "Phi_spe": { "additionalProperties": false, "properties": { "filetype": { "enum": [ "phi.spe", "marda:phi-spe" ], "title": "Filetype", "type": "string" }, "timezone": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Timezone" }, "locale": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Locale" }, "encoding": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Encoding" } }, "required": [ "filetype" ], "title": "Phi_spe", "type": "object" }, "Quadstar_sac": { "additionalProperties": false, "properties": { "filetype": { "const": "quadstar.sac", "enum": [ "quadstar.sac" ], "title": "Filetype", "type": "string" }, "timezone": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Timezone" }, "locale": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Locale" }, "encoding": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Encoding" } }, "required": [ "filetype" ], "title": "Quadstar_sac", "type": "object" }, "Tomato_json": { "additionalProperties": false, "properties": { "filetype": { "const": "tomato.json", "enum": [ "tomato.json" ], "title": "Filetype", "type": "string" }, "timezone": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Timezone" }, "locale": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Locale" }, "encoding": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Encoding" } }, "required": [ "filetype" ], "title": "Tomato_json", "type": "object" } }, "required": [ "extractor" ] }
- Validators:
- field extractor: NoFileType | Tomato_json | Drycal_csv | Drycal_rtf | Drycal_txt | EClab_mpr | EClab_mpt | Fusion_json | Fusion_zip | Fusion_csv | EmpaLC_csv | EmpaLC_xlsx | EZChrom_asc | Agilent_ch | Agilent_dx | Agilent_csv | Quadstar_sac | LabView_csv | Phi_spe | Panalytical_xrdml | Panalytical_xy | Panalytical_csv [Required]
- Validated by:
dgbowl_schemas.yadg.dataschema_5_0.input module
- pydantic model dgbowl_schemas.yadg.dataschema_5_0.input.Input
Bases:
BaseModelSpecification of input files/folders to be processed by the
Step.Show JSON schema
{ "title": "Input", "description": "Specification of input files/folders to be processed by the :class:`Step`.", "type": "object", "properties": { "folders": { "items": { "type": "string" }, "title": "Folders", "type": "array" }, "prefix": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Prefix" }, "suffix": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Suffix" }, "contains": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Contains" }, "exclude": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Exclude" } }, "additionalProperties": false, "required": [ "folders" ] }
- Config:
extra: str = forbid
populate_by_name: bool = True
- field files: Sequence[str] [Required] (alias 'folders')
Files, or folders to be searched for matching files.
- field prefix: str | None = None
Prefix of the filenames to be matched.
- field suffix: str | None = None
Suffix of the filenames to be matched.
- field contains: str | None = None
A string the matched filenames must contain.
- field exclude: str | None = None
A string the matched filenames must not contain.
- paths() List[str]
Returns a list of files to be processed by the
Step.
dgbowl_schemas.yadg.dataschema_5_0.metadata module
- pydantic model dgbowl_schemas.yadg.dataschema_5_0.metadata.Metadata
Bases:
BaseModelThe
Metadatais a container for any metadata of theDataSchema.Show JSON schema
{ "title": "Metadata", "description": "The :class:`Metadata` is a container for any metadata of the :class:`DataSchema`.", "type": "object", "properties": { "version": { "const": "5.0", "enum": [ "5.0" ], "title": "Version", "type": "string" }, "provenance": { "$ref": "#/$defs/Provenance" } }, "$defs": { "Provenance": { "additionalProperties": false, "properties": { "type": { "title": "Type", "type": "string" }, "metadata": { "anyOf": [ { "type": "object" }, { "type": "null" } ], "default": null, "title": "Metadata" } }, "required": [ "type" ], "title": "Provenance", "type": "object" } }, "additionalProperties": false, "required": [ "version", "provenance" ] }
- Config:
extra: str = forbid
- pydantic model Provenance
Bases:
BaseModelShow JSON schema
{ "title": "Provenance", "type": "object", "properties": { "type": { "title": "Type", "type": "string" }, "metadata": { "anyOf": [ { "type": "object" }, { "type": "null" } ], "default": null, "title": "Metadata" } }, "additionalProperties": false, "required": [ "type" ] }
- Config:
extra: str = forbid
- field type: str [Required]
Provenance type. Common values include
'manual'etc.
- field metadata: Mapping[str, Any] | None = None
Detailed provenance metadata in a free-form
dict.
- field version: Literal['5.0'] [Required]
- field provenance: Provenance [Required]
dgbowl_schemas.yadg.dataschema_5_0.parameters module
- pydantic model dgbowl_schemas.yadg.dataschema_5_0.parameters.Parameters
Bases:
BaseModelEmpty parameters specification with no extras allowed.
Show JSON schema
{ "title": "Parameters", "description": "Empty parameters specification with no extras allowed.", "type": "object", "properties": {}, "additionalProperties": false }
- Config:
extra: str = forbid
dgbowl_schemas.yadg.dataschema_5_0.step module
- pydantic model dgbowl_schemas.yadg.dataschema_5_0.step.Parser
Bases:
BaseModel,ABCShow JSON schema
{ "title": "Parser", "type": "object", "properties": { "tag": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Tag" }, "parser": { "title": "Parser", "type": "string" }, "input": { "$ref": "#/$defs/Input" }, "extractor": { "anyOf": [ { "$ref": "#/$defs/FileType" }, { "type": "null" } ], "default": null }, "parameters": { "anyOf": [ { "$ref": "#/$defs/Parameters" }, { "type": "null" } ], "default": null }, "externaldate": { "anyOf": [ { "$ref": "#/$defs/ExternalDate" }, { "type": "null" } ], "default": null } }, "$defs": { "ExternalDate": { "additionalProperties": false, "description": "Supply timestamping information that are external to the processed file.", "properties": { "using": { "anyOf": [ { "$ref": "#/$defs/ExternalDateFile" }, { "$ref": "#/$defs/ExternalDateFilename" }, { "$ref": "#/$defs/ExternalDateISOString" }, { "$ref": "#/$defs/ExternalDateUTSOffset" } ], "title": "Using" }, "mode": { "default": "add", "enum": [ "add", "replace" ], "title": "Mode", "type": "string" } }, "required": [ "using" ], "title": "ExternalDate", "type": "object" }, "ExternalDateFile": { "additionalProperties": false, "description": "Read external date information from file.", "properties": { "file": { "$ref": "#/$defs/dgbowl_schemas__yadg__dataschema_5_0__externaldate__ExternalDateFile__Content" } }, "required": [ "file" ], "title": "ExternalDateFile", "type": "object" }, "ExternalDateFilename": { "additionalProperties": false, "description": "Read external date information from the file name.", "properties": { "filename": { "$ref": "#/$defs/dgbowl_schemas__yadg__dataschema_5_0__externaldate__ExternalDateFilename__Content" } }, "required": [ "filename" ], "title": "ExternalDateFilename", "type": "object" }, "ExternalDateISOString": { "additionalProperties": false, "description": "Read a constant external date using an ISO-formatted string.", "properties": { "isostring": { "title": "Isostring", "type": "string" } }, "required": [ "isostring" ], "title": "ExternalDateISOString", "type": "object" }, "ExternalDateUTSOffset": { "additionalProperties": false, "description": "Read a constant external date using a Unix timestamp offset.", "properties": { "utsoffset": { "title": "Utsoffset", "type": "number" } }, "required": [ "utsoffset" ], "title": "ExternalDateUTSOffset", "type": "object" }, "FileType": { "additionalProperties": false, "description": "Template abstract base class for parser classes.", "properties": { "filetype": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Filetype" }, "timezone": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Timezone" }, "locale": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Locale" }, "encoding": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Encoding" } }, "title": "FileType", "type": "object" }, "Input": { "additionalProperties": false, "description": "Specification of input files/folders to be processed by the :class:`Step`.", "properties": { "folders": { "items": { "type": "string" }, "title": "Folders", "type": "array" }, "prefix": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Prefix" }, "suffix": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Suffix" }, "contains": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Contains" }, "exclude": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Exclude" } }, "required": [ "folders" ], "title": "Input", "type": "object" }, "Parameters": { "additionalProperties": false, "description": "Empty parameters specification with no extras allowed.", "properties": {}, "title": "Parameters", "type": "object" }, "dgbowl_schemas__yadg__dataschema_5_0__externaldate__ExternalDateFile__Content": { "additionalProperties": false, "properties": { "path": { "title": "Path", "type": "string" }, "type": { "title": "Type", "type": "string" }, "match": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Match" } }, "required": [ "path", "type" ], "title": "Content", "type": "object" }, "dgbowl_schemas__yadg__dataschema_5_0__externaldate__ExternalDateFilename__Content": { "additionalProperties": false, "properties": { "format": { "title": "Format", "type": "string" }, "len": { "title": "Len", "type": "integer" } }, "required": [ "format", "len" ], "title": "Content", "type": "object" } }, "additionalProperties": false, "required": [ "parser", "input" ] }
- Config:
extra: str = forbid
- field tag: str | None = None
- field parser: str [Required]
- field parameters: Parameters | None = None
- field externaldate: ExternalDate | None = None
- pydantic model dgbowl_schemas.yadg.dataschema_5_0.step.Dummy
Bases:
ParserDummy parser type, useful for testing.
Show JSON schema
{ "title": "Dummy", "description": "Dummy parser type, useful for testing.", "type": "object", "properties": { "tag": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Tag" }, "parser": { "const": "dummy", "enum": [ "dummy" ], "title": "Parser", "type": "string" }, "input": { "$ref": "#/$defs/Input" }, "extractor": { "anyOf": [ { "$ref": "#/$defs/NoFileType" }, { "$ref": "#/$defs/Tomato_json" } ], "title": "Extractor" }, "parameters": { "anyOf": [ { "$ref": "#/$defs/Parameters" }, { "type": "null" } ], "default": null }, "externaldate": { "anyOf": [ { "$ref": "#/$defs/ExternalDate" }, { "type": "null" } ], "default": null } }, "$defs": { "ExternalDate": { "additionalProperties": false, "description": "Supply timestamping information that are external to the processed file.", "properties": { "using": { "anyOf": [ { "$ref": "#/$defs/ExternalDateFile" }, { "$ref": "#/$defs/ExternalDateFilename" }, { "$ref": "#/$defs/ExternalDateISOString" }, { "$ref": "#/$defs/ExternalDateUTSOffset" } ], "title": "Using" }, "mode": { "default": "add", "enum": [ "add", "replace" ], "title": "Mode", "type": "string" } }, "required": [ "using" ], "title": "ExternalDate", "type": "object" }, "ExternalDateFile": { "additionalProperties": false, "description": "Read external date information from file.", "properties": { "file": { "$ref": "#/$defs/dgbowl_schemas__yadg__dataschema_5_0__externaldate__ExternalDateFile__Content" } }, "required": [ "file" ], "title": "ExternalDateFile", "type": "object" }, "ExternalDateFilename": { "additionalProperties": false, "description": "Read external date information from the file name.", "properties": { "filename": { "$ref": "#/$defs/dgbowl_schemas__yadg__dataschema_5_0__externaldate__ExternalDateFilename__Content" } }, "required": [ "filename" ], "title": "ExternalDateFilename", "type": "object" }, "ExternalDateISOString": { "additionalProperties": false, "description": "Read a constant external date using an ISO-formatted string.", "properties": { "isostring": { "title": "Isostring", "type": "string" } }, "required": [ "isostring" ], "title": "ExternalDateISOString", "type": "object" }, "ExternalDateUTSOffset": { "additionalProperties": false, "description": "Read a constant external date using a Unix timestamp offset.", "properties": { "utsoffset": { "title": "Utsoffset", "type": "number" } }, "required": [ "utsoffset" ], "title": "ExternalDateUTSOffset", "type": "object" }, "Input": { "additionalProperties": false, "description": "Specification of input files/folders to be processed by the :class:`Step`.", "properties": { "folders": { "items": { "type": "string" }, "title": "Folders", "type": "array" }, "prefix": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Prefix" }, "suffix": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Suffix" }, "contains": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Contains" }, "exclude": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Exclude" } }, "required": [ "folders" ], "title": "Input", "type": "object" }, "NoFileType": { "additionalProperties": false, "properties": { "filetype": { "const": "None", "default": "None", "enum": [ "None" ], "title": "Filetype", "type": "string" }, "timezone": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Timezone" }, "locale": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Locale" }, "encoding": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Encoding" } }, "title": "NoFileType", "type": "object" }, "Parameters": { "additionalProperties": true, "properties": {}, "title": "Parameters", "type": "object" }, "Tomato_json": { "additionalProperties": false, "properties": { "filetype": { "const": "tomato.json", "enum": [ "tomato.json" ], "title": "Filetype", "type": "string" }, "timezone": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Timezone" }, "locale": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Locale" }, "encoding": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Encoding" } }, "required": [ "filetype" ], "title": "Tomato_json", "type": "object" }, "dgbowl_schemas__yadg__dataschema_5_0__externaldate__ExternalDateFile__Content": { "additionalProperties": false, "properties": { "path": { "title": "Path", "type": "string" }, "type": { "title": "Type", "type": "string" }, "match": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Match" } }, "required": [ "path", "type" ], "title": "Content", "type": "object" }, "dgbowl_schemas__yadg__dataschema_5_0__externaldate__ExternalDateFilename__Content": { "additionalProperties": false, "properties": { "format": { "title": "Format", "type": "string" }, "len": { "title": "Len", "type": "integer" } }, "required": [ "format", "len" ], "title": "Content", "type": "object" } }, "additionalProperties": false, "required": [ "parser", "input" ] }
- Config:
extra: str = forbid
- pydantic model Parameters
Bases:
BaseModelShow JSON schema
{ "title": "Parameters", "type": "object", "properties": {}, "additionalProperties": true }
- Config:
extra: str = allow
- field parser: Literal['dummy'] [Required]
- field parameters: Parameters | None = None
- field extractor: NoFileType | Tomato_json [Optional]
- pydantic model dgbowl_schemas.yadg.dataschema_5_0.step.BasicCSV
Bases:
ParserCustomisable tabulated file parser.
Show JSON schema
{ "title": "BasicCSV", "description": "Customisable tabulated file parser.", "type": "object", "properties": { "tag": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Tag" }, "parser": { "const": "basiccsv", "enum": [ "basiccsv" ], "title": "Parser", "type": "string" }, "input": { "$ref": "#/$defs/Input" }, "extractor": { "$ref": "#/$defs/NoFileType" }, "parameters": { "$ref": "#/$defs/Parameters" }, "externaldate": { "anyOf": [ { "$ref": "#/$defs/ExternalDate" }, { "type": "null" } ], "default": null } }, "$defs": { "ExternalDate": { "additionalProperties": false, "description": "Supply timestamping information that are external to the processed file.", "properties": { "using": { "anyOf": [ { "$ref": "#/$defs/ExternalDateFile" }, { "$ref": "#/$defs/ExternalDateFilename" }, { "$ref": "#/$defs/ExternalDateISOString" }, { "$ref": "#/$defs/ExternalDateUTSOffset" } ], "title": "Using" }, "mode": { "default": "add", "enum": [ "add", "replace" ], "title": "Mode", "type": "string" } }, "required": [ "using" ], "title": "ExternalDate", "type": "object" }, "ExternalDateFile": { "additionalProperties": false, "description": "Read external date information from file.", "properties": { "file": { "$ref": "#/$defs/dgbowl_schemas__yadg__dataschema_5_0__externaldate__ExternalDateFile__Content" } }, "required": [ "file" ], "title": "ExternalDateFile", "type": "object" }, "ExternalDateFilename": { "additionalProperties": false, "description": "Read external date information from the file name.", "properties": { "filename": { "$ref": "#/$defs/dgbowl_schemas__yadg__dataschema_5_0__externaldate__ExternalDateFilename__Content" } }, "required": [ "filename" ], "title": "ExternalDateFilename", "type": "object" }, "ExternalDateISOString": { "additionalProperties": false, "description": "Read a constant external date using an ISO-formatted string.", "properties": { "isostring": { "title": "Isostring", "type": "string" } }, "required": [ "isostring" ], "title": "ExternalDateISOString", "type": "object" }, "ExternalDateUTSOffset": { "additionalProperties": false, "description": "Read a constant external date using a Unix timestamp offset.", "properties": { "utsoffset": { "title": "Utsoffset", "type": "number" } }, "required": [ "utsoffset" ], "title": "ExternalDateUTSOffset", "type": "object" }, "Input": { "additionalProperties": false, "description": "Specification of input files/folders to be processed by the :class:`Step`.", "properties": { "folders": { "items": { "type": "string" }, "title": "Folders", "type": "array" }, "prefix": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Prefix" }, "suffix": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Suffix" }, "contains": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Contains" }, "exclude": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Exclude" } }, "required": [ "folders" ], "title": "Input", "type": "object" }, "NoFileType": { "additionalProperties": false, "properties": { "filetype": { "const": "None", "default": "None", "enum": [ "None" ], "title": "Filetype", "type": "string" }, "timezone": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Timezone" }, "locale": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Locale" }, "encoding": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Encoding" } }, "title": "NoFileType", "type": "object" }, "Parameters": { "additionalProperties": false, "properties": { "sep": { "default": ",", "title": "Sep", "type": "string" }, "strip": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Strip" }, "units": { "anyOf": [ { "additionalProperties": { "type": "string" }, "type": "object" }, { "type": "null" } ], "default": null, "title": "Units" }, "timestamp": { "anyOf": [ { "$ref": "#/$defs/Timestamp" }, { "$ref": "#/$defs/TimeDate" }, { "$ref": "#/$defs/UTS" }, { "type": "null" } ], "default": null, "title": "Timestamp" } }, "title": "Parameters", "type": "object" }, "TimeDate": { "additionalProperties": false, "description": "Timestamp from a separate date and/or time column.", "properties": { "date": { "anyOf": [ { "$ref": "#/$defs/TimestampSpec" }, { "type": "null" } ], "default": null }, "time": { "anyOf": [ { "$ref": "#/$defs/TimestampSpec" }, { "type": "null" } ], "default": null } }, "title": "TimeDate", "type": "object" }, "Timestamp": { "additionalProperties": false, "description": "Timestamp from a column containing a single timestamp string.", "properties": { "timestamp": { "$ref": "#/$defs/TimestampSpec" } }, "required": [ "timestamp" ], "title": "Timestamp", "type": "object" }, "TimestampSpec": { "additionalProperties": false, "description": "Specification of the column index and string format of the timestamp.", "properties": { "index": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "title": "Index" }, "format": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Format" } }, "title": "TimestampSpec", "type": "object" }, "UTS": { "additionalProperties": false, "description": "Timestamp from a column containing a Unix timestamp.", "properties": { "uts": { "$ref": "#/$defs/TimestampSpec" } }, "required": [ "uts" ], "title": "UTS", "type": "object" }, "dgbowl_schemas__yadg__dataschema_5_0__externaldate__ExternalDateFile__Content": { "additionalProperties": false, "properties": { "path": { "title": "Path", "type": "string" }, "type": { "title": "Type", "type": "string" }, "match": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Match" } }, "required": [ "path", "type" ], "title": "Content", "type": "object" }, "dgbowl_schemas__yadg__dataschema_5_0__externaldate__ExternalDateFilename__Content": { "additionalProperties": false, "properties": { "format": { "title": "Format", "type": "string" }, "len": { "title": "Len", "type": "integer" } }, "required": [ "format", "len" ], "title": "Content", "type": "object" } }, "additionalProperties": false, "required": [ "parser", "input" ] }
- Config:
extra: str = forbid
- pydantic model Parameters
Bases:
BaseModelShow JSON schema
{ "title": "Parameters", "type": "object", "properties": { "sep": { "default": ",", "title": "Sep", "type": "string" }, "strip": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Strip" }, "units": { "anyOf": [ { "additionalProperties": { "type": "string" }, "type": "object" }, { "type": "null" } ], "default": null, "title": "Units" }, "timestamp": { "anyOf": [ { "$ref": "#/$defs/Timestamp" }, { "$ref": "#/$defs/TimeDate" }, { "$ref": "#/$defs/UTS" }, { "type": "null" } ], "default": null, "title": "Timestamp" } }, "$defs": { "TimeDate": { "additionalProperties": false, "description": "Timestamp from a separate date and/or time column.", "properties": { "date": { "anyOf": [ { "$ref": "#/$defs/TimestampSpec" }, { "type": "null" } ], "default": null }, "time": { "anyOf": [ { "$ref": "#/$defs/TimestampSpec" }, { "type": "null" } ], "default": null } }, "title": "TimeDate", "type": "object" }, "Timestamp": { "additionalProperties": false, "description": "Timestamp from a column containing a single timestamp string.", "properties": { "timestamp": { "$ref": "#/$defs/TimestampSpec" } }, "required": [ "timestamp" ], "title": "Timestamp", "type": "object" }, "TimestampSpec": { "additionalProperties": false, "description": "Specification of the column index and string format of the timestamp.", "properties": { "index": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "title": "Index" }, "format": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Format" } }, "title": "TimestampSpec", "type": "object" }, "UTS": { "additionalProperties": false, "description": "Timestamp from a column containing a Unix timestamp.", "properties": { "uts": { "$ref": "#/$defs/TimestampSpec" } }, "required": [ "uts" ], "title": "UTS", "type": "object" } }, "additionalProperties": false }
- Config:
extra: str = forbid
- field sep: str = ','
Separator of table columns.
- field strip: str | None = None
A
strof characters to strip from headers & data.
- field units: Mapping[str, str] | None = None
A
dictcontainingcolumn: unitkeypairs.
- field parser: Literal['basiccsv'] [Required]
- field parameters: Parameters [Optional]
- field extractor: NoFileType [Optional]
- pydantic model dgbowl_schemas.yadg.dataschema_5_0.step.MeasCSV
Bases:
ParserLegacy file parser for
measurement.csvfiles from FHI.Note
This parser is deprecated, and the
BasicCSVparser should be used instead.Show JSON schema
{ "title": "MeasCSV", "description": "Legacy file parser for ``measurement.csv`` files from FHI.\n\n.. note::\n\n This parser is deprecated, and the :class:`BasicCSV` parser should be\n used instead.", "type": "object", "properties": { "tag": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Tag" }, "parser": { "const": "meascsv", "enum": [ "meascsv" ], "title": "Parser", "type": "string" }, "input": { "$ref": "#/$defs/Input" }, "extractor": { "$ref": "#/$defs/NoFileType" }, "parameters": { "$ref": "#/$defs/Parameters" }, "externaldate": { "anyOf": [ { "$ref": "#/$defs/ExternalDate" }, { "type": "null" } ], "default": null } }, "$defs": { "ExternalDate": { "additionalProperties": false, "description": "Supply timestamping information that are external to the processed file.", "properties": { "using": { "anyOf": [ { "$ref": "#/$defs/ExternalDateFile" }, { "$ref": "#/$defs/ExternalDateFilename" }, { "$ref": "#/$defs/ExternalDateISOString" }, { "$ref": "#/$defs/ExternalDateUTSOffset" } ], "title": "Using" }, "mode": { "default": "add", "enum": [ "add", "replace" ], "title": "Mode", "type": "string" } }, "required": [ "using" ], "title": "ExternalDate", "type": "object" }, "ExternalDateFile": { "additionalProperties": false, "description": "Read external date information from file.", "properties": { "file": { "$ref": "#/$defs/dgbowl_schemas__yadg__dataschema_5_0__externaldate__ExternalDateFile__Content" } }, "required": [ "file" ], "title": "ExternalDateFile", "type": "object" }, "ExternalDateFilename": { "additionalProperties": false, "description": "Read external date information from the file name.", "properties": { "filename": { "$ref": "#/$defs/dgbowl_schemas__yadg__dataschema_5_0__externaldate__ExternalDateFilename__Content" } }, "required": [ "filename" ], "title": "ExternalDateFilename", "type": "object" }, "ExternalDateISOString": { "additionalProperties": false, "description": "Read a constant external date using an ISO-formatted string.", "properties": { "isostring": { "title": "Isostring", "type": "string" } }, "required": [ "isostring" ], "title": "ExternalDateISOString", "type": "object" }, "ExternalDateUTSOffset": { "additionalProperties": false, "description": "Read a constant external date using a Unix timestamp offset.", "properties": { "utsoffset": { "title": "Utsoffset", "type": "number" } }, "required": [ "utsoffset" ], "title": "ExternalDateUTSOffset", "type": "object" }, "Input": { "additionalProperties": false, "description": "Specification of input files/folders to be processed by the :class:`Step`.", "properties": { "folders": { "items": { "type": "string" }, "title": "Folders", "type": "array" }, "prefix": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Prefix" }, "suffix": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Suffix" }, "contains": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Contains" }, "exclude": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Exclude" } }, "required": [ "folders" ], "title": "Input", "type": "object" }, "NoFileType": { "additionalProperties": false, "properties": { "filetype": { "const": "None", "default": "None", "enum": [ "None" ], "title": "Filetype", "type": "string" }, "timezone": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Timezone" }, "locale": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Locale" }, "encoding": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Encoding" } }, "title": "NoFileType", "type": "object" }, "Parameters": { "additionalProperties": false, "properties": { "timestamp": { "anyOf": [ { "$ref": "#/$defs/Timestamp" }, { "$ref": "#/$defs/TimeDate" }, { "$ref": "#/$defs/UTS" } ], "default": { "timestamp": { "format": "%Y-%m-%d-%H-%M-%S", "index": 0 } }, "title": "Timestamp" } }, "title": "Parameters", "type": "object" }, "TimeDate": { "additionalProperties": false, "description": "Timestamp from a separate date and/or time column.", "properties": { "date": { "anyOf": [ { "$ref": "#/$defs/TimestampSpec" }, { "type": "null" } ], "default": null }, "time": { "anyOf": [ { "$ref": "#/$defs/TimestampSpec" }, { "type": "null" } ], "default": null } }, "title": "TimeDate", "type": "object" }, "Timestamp": { "additionalProperties": false, "description": "Timestamp from a column containing a single timestamp string.", "properties": { "timestamp": { "$ref": "#/$defs/TimestampSpec" } }, "required": [ "timestamp" ], "title": "Timestamp", "type": "object" }, "TimestampSpec": { "additionalProperties": false, "description": "Specification of the column index and string format of the timestamp.", "properties": { "index": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "title": "Index" }, "format": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Format" } }, "title": "TimestampSpec", "type": "object" }, "UTS": { "additionalProperties": false, "description": "Timestamp from a column containing a Unix timestamp.", "properties": { "uts": { "$ref": "#/$defs/TimestampSpec" } }, "required": [ "uts" ], "title": "UTS", "type": "object" }, "dgbowl_schemas__yadg__dataschema_5_0__externaldate__ExternalDateFile__Content": { "additionalProperties": false, "properties": { "path": { "title": "Path", "type": "string" }, "type": { "title": "Type", "type": "string" }, "match": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Match" } }, "required": [ "path", "type" ], "title": "Content", "type": "object" }, "dgbowl_schemas__yadg__dataschema_5_0__externaldate__ExternalDateFilename__Content": { "additionalProperties": false, "properties": { "format": { "title": "Format", "type": "string" }, "len": { "title": "Len", "type": "integer" } }, "required": [ "format", "len" ], "title": "Content", "type": "object" } }, "additionalProperties": false, "required": [ "parser", "input" ] }
- Config:
extra: str = forbid
- pydantic model Parameters
Bases:
BaseModelShow JSON schema
{ "title": "Parameters", "type": "object", "properties": { "timestamp": { "anyOf": [ { "$ref": "#/$defs/Timestamp" }, { "$ref": "#/$defs/TimeDate" }, { "$ref": "#/$defs/UTS" } ], "default": { "timestamp": { "format": "%Y-%m-%d-%H-%M-%S", "index": 0 } }, "title": "Timestamp" } }, "$defs": { "TimeDate": { "additionalProperties": false, "description": "Timestamp from a separate date and/or time column.", "properties": { "date": { "anyOf": [ { "$ref": "#/$defs/TimestampSpec" }, { "type": "null" } ], "default": null }, "time": { "anyOf": [ { "$ref": "#/$defs/TimestampSpec" }, { "type": "null" } ], "default": null } }, "title": "TimeDate", "type": "object" }, "Timestamp": { "additionalProperties": false, "description": "Timestamp from a column containing a single timestamp string.", "properties": { "timestamp": { "$ref": "#/$defs/TimestampSpec" } }, "required": [ "timestamp" ], "title": "Timestamp", "type": "object" }, "TimestampSpec": { "additionalProperties": false, "description": "Specification of the column index and string format of the timestamp.", "properties": { "index": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "title": "Index" }, "format": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Format" } }, "title": "TimestampSpec", "type": "object" }, "UTS": { "additionalProperties": false, "description": "Timestamp from a column containing a Unix timestamp.", "properties": { "uts": { "$ref": "#/$defs/TimestampSpec" } }, "required": [ "uts" ], "title": "UTS", "type": "object" } }, "additionalProperties": false }
- Config:
extra: str = forbid
- field parser: Literal['meascsv'] [Required]
- field parameters: Parameters [Optional]
- field extractor: NoFileType [Optional]
- pydantic model dgbowl_schemas.yadg.dataschema_5_0.step.FlowData
Bases:
ParserParser for flow controller/meter data.
Show JSON schema
{ "title": "FlowData", "description": "Parser for flow controller/meter data.", "type": "object", "properties": { "tag": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Tag" }, "parser": { "const": "flowdata", "enum": [ "flowdata" ], "title": "Parser", "type": "string" }, "input": { "$ref": "#/$defs/Input" }, "extractor": { "discriminator": { "mapping": { "drycal.csv": "#/$defs/Drycal_csv", "drycal.rtf": "#/$defs/Drycal_rtf", "drycal.txt": "#/$defs/Drycal_txt" }, "propertyName": "filetype" }, "oneOf": [ { "$ref": "#/$defs/Drycal_csv" }, { "$ref": "#/$defs/Drycal_rtf" }, { "$ref": "#/$defs/Drycal_txt" } ], "title": "Extractor" }, "parameters": { "anyOf": [ { "$ref": "#/$defs/Parameters" }, { "type": "null" } ], "default": null }, "externaldate": { "anyOf": [ { "$ref": "#/$defs/ExternalDate" }, { "type": "null" } ], "default": null } }, "$defs": { "Drycal_csv": { "additionalProperties": false, "properties": { "filetype": { "const": "drycal.csv", "enum": [ "drycal.csv" ], "title": "Filetype", "type": "string" }, "timezone": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Timezone" }, "locale": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Locale" }, "encoding": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Encoding" } }, "required": [ "filetype" ], "title": "Drycal_csv", "type": "object" }, "Drycal_rtf": { "additionalProperties": false, "properties": { "filetype": { "const": "drycal.rtf", "enum": [ "drycal.rtf" ], "title": "Filetype", "type": "string" }, "timezone": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Timezone" }, "locale": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Locale" }, "encoding": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Encoding" } }, "required": [ "filetype" ], "title": "Drycal_rtf", "type": "object" }, "Drycal_txt": { "additionalProperties": false, "properties": { "filetype": { "const": "drycal.txt", "enum": [ "drycal.txt" ], "title": "Filetype", "type": "string" }, "timezone": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Timezone" }, "locale": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Locale" }, "encoding": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Encoding" } }, "required": [ "filetype" ], "title": "Drycal_txt", "type": "object" }, "ExternalDate": { "additionalProperties": false, "description": "Supply timestamping information that are external to the processed file.", "properties": { "using": { "anyOf": [ { "$ref": "#/$defs/ExternalDateFile" }, { "$ref": "#/$defs/ExternalDateFilename" }, { "$ref": "#/$defs/ExternalDateISOString" }, { "$ref": "#/$defs/ExternalDateUTSOffset" } ], "title": "Using" }, "mode": { "default": "add", "enum": [ "add", "replace" ], "title": "Mode", "type": "string" } }, "required": [ "using" ], "title": "ExternalDate", "type": "object" }, "ExternalDateFile": { "additionalProperties": false, "description": "Read external date information from file.", "properties": { "file": { "$ref": "#/$defs/dgbowl_schemas__yadg__dataschema_5_0__externaldate__ExternalDateFile__Content" } }, "required": [ "file" ], "title": "ExternalDateFile", "type": "object" }, "ExternalDateFilename": { "additionalProperties": false, "description": "Read external date information from the file name.", "properties": { "filename": { "$ref": "#/$defs/dgbowl_schemas__yadg__dataschema_5_0__externaldate__ExternalDateFilename__Content" } }, "required": [ "filename" ], "title": "ExternalDateFilename", "type": "object" }, "ExternalDateISOString": { "additionalProperties": false, "description": "Read a constant external date using an ISO-formatted string.", "properties": { "isostring": { "title": "Isostring", "type": "string" } }, "required": [ "isostring" ], "title": "ExternalDateISOString", "type": "object" }, "ExternalDateUTSOffset": { "additionalProperties": false, "description": "Read a constant external date using a Unix timestamp offset.", "properties": { "utsoffset": { "title": "Utsoffset", "type": "number" } }, "required": [ "utsoffset" ], "title": "ExternalDateUTSOffset", "type": "object" }, "Input": { "additionalProperties": false, "description": "Specification of input files/folders to be processed by the :class:`Step`.", "properties": { "folders": { "items": { "type": "string" }, "title": "Folders", "type": "array" }, "prefix": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Prefix" }, "suffix": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Suffix" }, "contains": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Contains" }, "exclude": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Exclude" } }, "required": [ "folders" ], "title": "Input", "type": "object" }, "Parameters": { "additionalProperties": false, "description": "Empty parameters specification with no extras allowed.", "properties": {}, "title": "Parameters", "type": "object" }, "dgbowl_schemas__yadg__dataschema_5_0__externaldate__ExternalDateFile__Content": { "additionalProperties": false, "properties": { "path": { "title": "Path", "type": "string" }, "type": { "title": "Type", "type": "string" }, "match": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Match" } }, "required": [ "path", "type" ], "title": "Content", "type": "object" }, "dgbowl_schemas__yadg__dataschema_5_0__externaldate__ExternalDateFilename__Content": { "additionalProperties": false, "properties": { "format": { "title": "Format", "type": "string" }, "len": { "title": "Len", "type": "integer" } }, "required": [ "format", "len" ], "title": "Content", "type": "object" } }, "additionalProperties": false, "required": [ "parser", "input", "extractor" ] }
- Config:
extra: str = forbid
- field parser: Literal['flowdata'] [Required]
- field extractor: Drycal_csv | Drycal_rtf | Drycal_txt [Required]
- pydantic model dgbowl_schemas.yadg.dataschema_5_0.step.ElectroChem
Bases:
ParserParser for electrochemistry files.
Show JSON schema
{ "title": "ElectroChem", "description": "Parser for electrochemistry files.", "type": "object", "properties": { "tag": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Tag" }, "parser": { "const": "electrochem", "enum": [ "electrochem" ], "title": "Parser", "type": "string" }, "input": { "$ref": "#/$defs/Input" }, "extractor": { "discriminator": { "mapping": { "eclab.mpr": "#/$defs/EClab_mpr", "eclab.mpt": "#/$defs/EClab_mpt", "marda:biologic-mpr": "#/$defs/EClab_mpr", "marda:biologic-mpt": "#/$defs/EClab_mpt", "tomato.json": "#/$defs/Tomato_json" }, "propertyName": "filetype" }, "oneOf": [ { "$ref": "#/$defs/EClab_mpr" }, { "$ref": "#/$defs/EClab_mpt" }, { "$ref": "#/$defs/Tomato_json" } ], "title": "Extractor" }, "parameters": { "anyOf": [ { "$ref": "#/$defs/Parameters" }, { "type": "null" } ], "default": null }, "externaldate": { "anyOf": [ { "$ref": "#/$defs/ExternalDate" }, { "type": "null" } ], "default": null } }, "$defs": { "EClab_mpr": { "additionalProperties": false, "properties": { "filetype": { "enum": [ "eclab.mpr", "marda:biologic-mpr" ], "title": "Filetype", "type": "string" }, "timezone": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Timezone" }, "locale": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Locale" }, "encoding": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Encoding" } }, "required": [ "filetype" ], "title": "EClab_mpr", "type": "object" }, "EClab_mpt": { "additionalProperties": false, "properties": { "filetype": { "enum": [ "eclab.mpt", "marda:biologic-mpt" ], "title": "Filetype", "type": "string" }, "timezone": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Timezone" }, "locale": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Locale" }, "encoding": { "default": "windows-1252", "title": "Encoding", "type": "string" } }, "required": [ "filetype" ], "title": "EClab_mpt", "type": "object" }, "ExternalDate": { "additionalProperties": false, "description": "Supply timestamping information that are external to the processed file.", "properties": { "using": { "anyOf": [ { "$ref": "#/$defs/ExternalDateFile" }, { "$ref": "#/$defs/ExternalDateFilename" }, { "$ref": "#/$defs/ExternalDateISOString" }, { "$ref": "#/$defs/ExternalDateUTSOffset" } ], "title": "Using" }, "mode": { "default": "add", "enum": [ "add", "replace" ], "title": "Mode", "type": "string" } }, "required": [ "using" ], "title": "ExternalDate", "type": "object" }, "ExternalDateFile": { "additionalProperties": false, "description": "Read external date information from file.", "properties": { "file": { "$ref": "#/$defs/dgbowl_schemas__yadg__dataschema_5_0__externaldate__ExternalDateFile__Content" } }, "required": [ "file" ], "title": "ExternalDateFile", "type": "object" }, "ExternalDateFilename": { "additionalProperties": false, "description": "Read external date information from the file name.", "properties": { "filename": { "$ref": "#/$defs/dgbowl_schemas__yadg__dataschema_5_0__externaldate__ExternalDateFilename__Content" } }, "required": [ "filename" ], "title": "ExternalDateFilename", "type": "object" }, "ExternalDateISOString": { "additionalProperties": false, "description": "Read a constant external date using an ISO-formatted string.", "properties": { "isostring": { "title": "Isostring", "type": "string" } }, "required": [ "isostring" ], "title": "ExternalDateISOString", "type": "object" }, "ExternalDateUTSOffset": { "additionalProperties": false, "description": "Read a constant external date using a Unix timestamp offset.", "properties": { "utsoffset": { "title": "Utsoffset", "type": "number" } }, "required": [ "utsoffset" ], "title": "ExternalDateUTSOffset", "type": "object" }, "Input": { "additionalProperties": false, "description": "Specification of input files/folders to be processed by the :class:`Step`.", "properties": { "folders": { "items": { "type": "string" }, "title": "Folders", "type": "array" }, "prefix": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Prefix" }, "suffix": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Suffix" }, "contains": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Contains" }, "exclude": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Exclude" } }, "required": [ "folders" ], "title": "Input", "type": "object" }, "Parameters": { "additionalProperties": false, "description": "Empty parameters specification with no extras allowed.", "properties": {}, "title": "Parameters", "type": "object" }, "Tomato_json": { "additionalProperties": false, "properties": { "filetype": { "const": "tomato.json", "enum": [ "tomato.json" ], "title": "Filetype", "type": "string" }, "timezone": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Timezone" }, "locale": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Locale" }, "encoding": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Encoding" } }, "required": [ "filetype" ], "title": "Tomato_json", "type": "object" }, "dgbowl_schemas__yadg__dataschema_5_0__externaldate__ExternalDateFile__Content": { "additionalProperties": false, "properties": { "path": { "title": "Path", "type": "string" }, "type": { "title": "Type", "type": "string" }, "match": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Match" } }, "required": [ "path", "type" ], "title": "Content", "type": "object" }, "dgbowl_schemas__yadg__dataschema_5_0__externaldate__ExternalDateFilename__Content": { "additionalProperties": false, "properties": { "format": { "title": "Format", "type": "string" }, "len": { "title": "Len", "type": "integer" } }, "required": [ "format", "len" ], "title": "Content", "type": "object" } }, "additionalProperties": false, "required": [ "parser", "input", "extractor" ] }
- Config:
extra: str = forbid
- field parser: Literal['electrochem'] [Required]
- field extractor: EClab_mpr | EClab_mpt | Tomato_json [Required]
- pydantic model dgbowl_schemas.yadg.dataschema_5_0.step.ChromTrace
Bases:
ParserParser for raw chromatography traces.
Note
For parsing processed (integrated) chromatographic data, use the
ChromDataparser.Show JSON schema
{ "title": "ChromTrace", "description": "Parser for raw chromatography traces.\n\n.. note::\n\n For parsing processed (integrated) chromatographic data, use the\n :class:`ChromData` parser.", "type": "object", "properties": { "tag": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Tag" }, "parser": { "const": "chromtrace", "enum": [ "chromtrace" ], "title": "Parser", "type": "string" }, "input": { "$ref": "#/$defs/Input" }, "extractor": { "discriminator": { "mapping": { "agilent.ch": "#/$defs/Agilent_ch", "agilent.csv": "#/$defs/Agilent_csv", "agilent.dx": "#/$defs/Agilent_dx", "ezchrom.asc": "#/$defs/EZChrom_asc", "fusion.json": "#/$defs/Fusion_json", "fusion.zip": "#/$defs/Fusion_zip", "marda:agilent-ch": "#/$defs/Agilent_ch", "marda:agilent-dx": "#/$defs/Agilent_dx" }, "propertyName": "filetype" }, "oneOf": [ { "$ref": "#/$defs/EZChrom_asc" }, { "$ref": "#/$defs/Fusion_json" }, { "$ref": "#/$defs/Fusion_zip" }, { "$ref": "#/$defs/Agilent_ch" }, { "$ref": "#/$defs/Agilent_dx" }, { "$ref": "#/$defs/Agilent_csv" } ], "title": "Extractor" }, "parameters": { "anyOf": [ { "$ref": "#/$defs/Parameters" }, { "type": "null" } ], "default": null }, "externaldate": { "anyOf": [ { "$ref": "#/$defs/ExternalDate" }, { "type": "null" } ], "default": null } }, "$defs": { "Agilent_ch": { "additionalProperties": false, "properties": { "filetype": { "enum": [ "agilent.ch", "marda:agilent-ch" ], "title": "Filetype", "type": "string" }, "timezone": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Timezone" }, "locale": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Locale" }, "encoding": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Encoding" } }, "required": [ "filetype" ], "title": "Agilent_ch", "type": "object" }, "Agilent_csv": { "additionalProperties": false, "properties": { "filetype": { "const": "agilent.csv", "enum": [ "agilent.csv" ], "title": "Filetype", "type": "string" }, "timezone": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Timezone" }, "locale": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Locale" }, "encoding": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Encoding" } }, "required": [ "filetype" ], "title": "Agilent_csv", "type": "object" }, "Agilent_dx": { "additionalProperties": false, "properties": { "filetype": { "enum": [ "agilent.dx", "marda:agilent-dx" ], "title": "Filetype", "type": "string" }, "timezone": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Timezone" }, "locale": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Locale" }, "encoding": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Encoding" } }, "required": [ "filetype" ], "title": "Agilent_dx", "type": "object" }, "EZChrom_asc": { "additionalProperties": false, "properties": { "filetype": { "const": "ezchrom.asc", "enum": [ "ezchrom.asc" ], "title": "Filetype", "type": "string" }, "timezone": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Timezone" }, "locale": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Locale" }, "encoding": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Encoding" } }, "required": [ "filetype" ], "title": "EZChrom_asc", "type": "object" }, "ExternalDate": { "additionalProperties": false, "description": "Supply timestamping information that are external to the processed file.", "properties": { "using": { "anyOf": [ { "$ref": "#/$defs/ExternalDateFile" }, { "$ref": "#/$defs/ExternalDateFilename" }, { "$ref": "#/$defs/ExternalDateISOString" }, { "$ref": "#/$defs/ExternalDateUTSOffset" } ], "title": "Using" }, "mode": { "default": "add", "enum": [ "add", "replace" ], "title": "Mode", "type": "string" } }, "required": [ "using" ], "title": "ExternalDate", "type": "object" }, "ExternalDateFile": { "additionalProperties": false, "description": "Read external date information from file.", "properties": { "file": { "$ref": "#/$defs/dgbowl_schemas__yadg__dataschema_5_0__externaldate__ExternalDateFile__Content" } }, "required": [ "file" ], "title": "ExternalDateFile", "type": "object" }, "ExternalDateFilename": { "additionalProperties": false, "description": "Read external date information from the file name.", "properties": { "filename": { "$ref": "#/$defs/dgbowl_schemas__yadg__dataschema_5_0__externaldate__ExternalDateFilename__Content" } }, "required": [ "filename" ], "title": "ExternalDateFilename", "type": "object" }, "ExternalDateISOString": { "additionalProperties": false, "description": "Read a constant external date using an ISO-formatted string.", "properties": { "isostring": { "title": "Isostring", "type": "string" } }, "required": [ "isostring" ], "title": "ExternalDateISOString", "type": "object" }, "ExternalDateUTSOffset": { "additionalProperties": false, "description": "Read a constant external date using a Unix timestamp offset.", "properties": { "utsoffset": { "title": "Utsoffset", "type": "number" } }, "required": [ "utsoffset" ], "title": "ExternalDateUTSOffset", "type": "object" }, "Fusion_json": { "additionalProperties": false, "properties": { "filetype": { "const": "fusion.json", "enum": [ "fusion.json" ], "title": "Filetype", "type": "string" }, "timezone": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Timezone" }, "locale": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Locale" }, "encoding": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Encoding" } }, "required": [ "filetype" ], "title": "Fusion_json", "type": "object" }, "Fusion_zip": { "additionalProperties": false, "properties": { "filetype": { "const": "fusion.zip", "enum": [ "fusion.zip" ], "title": "Filetype", "type": "string" }, "timezone": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Timezone" }, "locale": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Locale" }, "encoding": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Encoding" } }, "required": [ "filetype" ], "title": "Fusion_zip", "type": "object" }, "Input": { "additionalProperties": false, "description": "Specification of input files/folders to be processed by the :class:`Step`.", "properties": { "folders": { "items": { "type": "string" }, "title": "Folders", "type": "array" }, "prefix": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Prefix" }, "suffix": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Suffix" }, "contains": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Contains" }, "exclude": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Exclude" } }, "required": [ "folders" ], "title": "Input", "type": "object" }, "Parameters": { "additionalProperties": false, "description": "Empty parameters specification with no extras allowed.", "properties": {}, "title": "Parameters", "type": "object" }, "dgbowl_schemas__yadg__dataschema_5_0__externaldate__ExternalDateFile__Content": { "additionalProperties": false, "properties": { "path": { "title": "Path", "type": "string" }, "type": { "title": "Type", "type": "string" }, "match": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Match" } }, "required": [ "path", "type" ], "title": "Content", "type": "object" }, "dgbowl_schemas__yadg__dataschema_5_0__externaldate__ExternalDateFilename__Content": { "additionalProperties": false, "properties": { "format": { "title": "Format", "type": "string" }, "len": { "title": "Len", "type": "integer" } }, "required": [ "format", "len" ], "title": "Content", "type": "object" } }, "additionalProperties": false, "required": [ "parser", "input", "extractor" ] }
- Config:
extra: str = forbid
- field parser: Literal['chromtrace'] [Required]
- field extractor: EZChrom_asc | Fusion_json | Fusion_zip | Agilent_ch | Agilent_dx | Agilent_csv [Required]
- pydantic model dgbowl_schemas.yadg.dataschema_5_0.step.ChromData
Bases:
ParserParser for processed chromatography data.
Show JSON schema
{ "title": "ChromData", "description": "Parser for processed chromatography data.", "type": "object", "properties": { "tag": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Tag" }, "parser": { "const": "chromdata", "enum": [ "chromdata" ], "title": "Parser", "type": "string" }, "input": { "$ref": "#/$defs/Input" }, "extractor": { "discriminator": { "mapping": { "empalc.csv": "#/$defs/EmpaLC_csv", "empalc.xlsx": "#/$defs/EmpaLC_xlsx", "fusion.csv": "#/$defs/Fusion_csv", "fusion.json": "#/$defs/Fusion_json", "fusion.zip": "#/$defs/Fusion_zip" }, "propertyName": "filetype" }, "oneOf": [ { "$ref": "#/$defs/Fusion_json" }, { "$ref": "#/$defs/Fusion_zip" }, { "$ref": "#/$defs/Fusion_csv" }, { "$ref": "#/$defs/EmpaLC_csv" }, { "$ref": "#/$defs/EmpaLC_xlsx" } ], "title": "Extractor" }, "parameters": { "anyOf": [ { "$ref": "#/$defs/Parameters" }, { "type": "null" } ], "default": null }, "externaldate": { "anyOf": [ { "$ref": "#/$defs/ExternalDate" }, { "type": "null" } ], "default": null } }, "$defs": { "EmpaLC_csv": { "additionalProperties": false, "properties": { "filetype": { "const": "empalc.csv", "enum": [ "empalc.csv" ], "title": "Filetype", "type": "string" }, "timezone": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Timezone" }, "locale": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Locale" }, "encoding": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Encoding" } }, "required": [ "filetype" ], "title": "EmpaLC_csv", "type": "object" }, "EmpaLC_xlsx": { "additionalProperties": false, "properties": { "filetype": { "const": "empalc.xlsx", "enum": [ "empalc.xlsx" ], "title": "Filetype", "type": "string" }, "timezone": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Timezone" }, "locale": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Locale" }, "encoding": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Encoding" } }, "required": [ "filetype" ], "title": "EmpaLC_xlsx", "type": "object" }, "ExternalDate": { "additionalProperties": false, "description": "Supply timestamping information that are external to the processed file.", "properties": { "using": { "anyOf": [ { "$ref": "#/$defs/ExternalDateFile" }, { "$ref": "#/$defs/ExternalDateFilename" }, { "$ref": "#/$defs/ExternalDateISOString" }, { "$ref": "#/$defs/ExternalDateUTSOffset" } ], "title": "Using" }, "mode": { "default": "add", "enum": [ "add", "replace" ], "title": "Mode", "type": "string" } }, "required": [ "using" ], "title": "ExternalDate", "type": "object" }, "ExternalDateFile": { "additionalProperties": false, "description": "Read external date information from file.", "properties": { "file": { "$ref": "#/$defs/dgbowl_schemas__yadg__dataschema_5_0__externaldate__ExternalDateFile__Content" } }, "required": [ "file" ], "title": "ExternalDateFile", "type": "object" }, "ExternalDateFilename": { "additionalProperties": false, "description": "Read external date information from the file name.", "properties": { "filename": { "$ref": "#/$defs/dgbowl_schemas__yadg__dataschema_5_0__externaldate__ExternalDateFilename__Content" } }, "required": [ "filename" ], "title": "ExternalDateFilename", "type": "object" }, "ExternalDateISOString": { "additionalProperties": false, "description": "Read a constant external date using an ISO-formatted string.", "properties": { "isostring": { "title": "Isostring", "type": "string" } }, "required": [ "isostring" ], "title": "ExternalDateISOString", "type": "object" }, "ExternalDateUTSOffset": { "additionalProperties": false, "description": "Read a constant external date using a Unix timestamp offset.", "properties": { "utsoffset": { "title": "Utsoffset", "type": "number" } }, "required": [ "utsoffset" ], "title": "ExternalDateUTSOffset", "type": "object" }, "Fusion_csv": { "additionalProperties": false, "properties": { "filetype": { "const": "fusion.csv", "enum": [ "fusion.csv" ], "title": "Filetype", "type": "string" }, "timezone": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Timezone" }, "locale": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Locale" }, "encoding": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Encoding" } }, "required": [ "filetype" ], "title": "Fusion_csv", "type": "object" }, "Fusion_json": { "additionalProperties": false, "properties": { "filetype": { "const": "fusion.json", "enum": [ "fusion.json" ], "title": "Filetype", "type": "string" }, "timezone": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Timezone" }, "locale": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Locale" }, "encoding": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Encoding" } }, "required": [ "filetype" ], "title": "Fusion_json", "type": "object" }, "Fusion_zip": { "additionalProperties": false, "properties": { "filetype": { "const": "fusion.zip", "enum": [ "fusion.zip" ], "title": "Filetype", "type": "string" }, "timezone": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Timezone" }, "locale": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Locale" }, "encoding": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Encoding" } }, "required": [ "filetype" ], "title": "Fusion_zip", "type": "object" }, "Input": { "additionalProperties": false, "description": "Specification of input files/folders to be processed by the :class:`Step`.", "properties": { "folders": { "items": { "type": "string" }, "title": "Folders", "type": "array" }, "prefix": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Prefix" }, "suffix": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Suffix" }, "contains": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Contains" }, "exclude": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Exclude" } }, "required": [ "folders" ], "title": "Input", "type": "object" }, "Parameters": { "additionalProperties": false, "description": "Empty parameters specification with no extras allowed.", "properties": {}, "title": "Parameters", "type": "object" }, "dgbowl_schemas__yadg__dataschema_5_0__externaldate__ExternalDateFile__Content": { "additionalProperties": false, "properties": { "path": { "title": "Path", "type": "string" }, "type": { "title": "Type", "type": "string" }, "match": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Match" } }, "required": [ "path", "type" ], "title": "Content", "type": "object" }, "dgbowl_schemas__yadg__dataschema_5_0__externaldate__ExternalDateFilename__Content": { "additionalProperties": false, "properties": { "format": { "title": "Format", "type": "string" }, "len": { "title": "Len", "type": "integer" } }, "required": [ "format", "len" ], "title": "Content", "type": "object" } }, "additionalProperties": false, "required": [ "parser", "input", "extractor" ] }
- Config:
extra: str = forbid
- field parser: Literal['chromdata'] [Required]
- field extractor: Fusion_json | Fusion_zip | Fusion_csv | EmpaLC_csv | EmpaLC_xlsx [Required]
- pydantic model dgbowl_schemas.yadg.dataschema_5_0.step.MassTrace
Bases:
ParserParser for mass spectroscopy traces.
Show JSON schema
{ "title": "MassTrace", "description": "Parser for mass spectroscopy traces.", "type": "object", "properties": { "tag": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Tag" }, "parser": { "const": "masstrace", "enum": [ "masstrace" ], "title": "Parser", "type": "string" }, "input": { "$ref": "#/$defs/Input" }, "extractor": { "$ref": "#/$defs/Quadstar_sac" }, "parameters": { "anyOf": [ { "$ref": "#/$defs/Parameters" }, { "type": "null" } ], "default": null }, "externaldate": { "anyOf": [ { "$ref": "#/$defs/ExternalDate" }, { "type": "null" } ], "default": null } }, "$defs": { "ExternalDate": { "additionalProperties": false, "description": "Supply timestamping information that are external to the processed file.", "properties": { "using": { "anyOf": [ { "$ref": "#/$defs/ExternalDateFile" }, { "$ref": "#/$defs/ExternalDateFilename" }, { "$ref": "#/$defs/ExternalDateISOString" }, { "$ref": "#/$defs/ExternalDateUTSOffset" } ], "title": "Using" }, "mode": { "default": "add", "enum": [ "add", "replace" ], "title": "Mode", "type": "string" } }, "required": [ "using" ], "title": "ExternalDate", "type": "object" }, "ExternalDateFile": { "additionalProperties": false, "description": "Read external date information from file.", "properties": { "file": { "$ref": "#/$defs/dgbowl_schemas__yadg__dataschema_5_0__externaldate__ExternalDateFile__Content" } }, "required": [ "file" ], "title": "ExternalDateFile", "type": "object" }, "ExternalDateFilename": { "additionalProperties": false, "description": "Read external date information from the file name.", "properties": { "filename": { "$ref": "#/$defs/dgbowl_schemas__yadg__dataschema_5_0__externaldate__ExternalDateFilename__Content" } }, "required": [ "filename" ], "title": "ExternalDateFilename", "type": "object" }, "ExternalDateISOString": { "additionalProperties": false, "description": "Read a constant external date using an ISO-formatted string.", "properties": { "isostring": { "title": "Isostring", "type": "string" } }, "required": [ "isostring" ], "title": "ExternalDateISOString", "type": "object" }, "ExternalDateUTSOffset": { "additionalProperties": false, "description": "Read a constant external date using a Unix timestamp offset.", "properties": { "utsoffset": { "title": "Utsoffset", "type": "number" } }, "required": [ "utsoffset" ], "title": "ExternalDateUTSOffset", "type": "object" }, "Input": { "additionalProperties": false, "description": "Specification of input files/folders to be processed by the :class:`Step`.", "properties": { "folders": { "items": { "type": "string" }, "title": "Folders", "type": "array" }, "prefix": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Prefix" }, "suffix": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Suffix" }, "contains": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Contains" }, "exclude": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Exclude" } }, "required": [ "folders" ], "title": "Input", "type": "object" }, "Parameters": { "additionalProperties": false, "description": "Empty parameters specification with no extras allowed.", "properties": {}, "title": "Parameters", "type": "object" }, "Quadstar_sac": { "additionalProperties": false, "properties": { "filetype": { "const": "quadstar.sac", "enum": [ "quadstar.sac" ], "title": "Filetype", "type": "string" }, "timezone": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Timezone" }, "locale": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Locale" }, "encoding": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Encoding" } }, "required": [ "filetype" ], "title": "Quadstar_sac", "type": "object" }, "dgbowl_schemas__yadg__dataschema_5_0__externaldate__ExternalDateFile__Content": { "additionalProperties": false, "properties": { "path": { "title": "Path", "type": "string" }, "type": { "title": "Type", "type": "string" }, "match": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Match" } }, "required": [ "path", "type" ], "title": "Content", "type": "object" }, "dgbowl_schemas__yadg__dataschema_5_0__externaldate__ExternalDateFilename__Content": { "additionalProperties": false, "properties": { "format": { "title": "Format", "type": "string" }, "len": { "title": "Len", "type": "integer" } }, "required": [ "format", "len" ], "title": "Content", "type": "object" } }, "additionalProperties": false, "required": [ "parser", "input", "extractor" ] }
- Config:
extra: str = forbid
- field parser: Literal['masstrace'] [Required]
- field extractor: Quadstar_sac [Required]
- pydantic model dgbowl_schemas.yadg.dataschema_5_0.step.QFTrace
Bases:
ParserParser for network analyzer traces.
Show JSON schema
{ "title": "QFTrace", "description": "Parser for network analyzer traces.", "type": "object", "properties": { "tag": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Tag" }, "parser": { "const": "qftrace", "enum": [ "qftrace" ], "title": "Parser", "type": "string" }, "input": { "$ref": "#/$defs/Input" }, "extractor": { "$ref": "#/$defs/LabView_csv" }, "parameters": { "anyOf": [ { "$ref": "#/$defs/Parameters" }, { "type": "null" } ], "default": null }, "externaldate": { "anyOf": [ { "$ref": "#/$defs/ExternalDate" }, { "type": "null" } ], "default": null } }, "$defs": { "ExternalDate": { "additionalProperties": false, "description": "Supply timestamping information that are external to the processed file.", "properties": { "using": { "anyOf": [ { "$ref": "#/$defs/ExternalDateFile" }, { "$ref": "#/$defs/ExternalDateFilename" }, { "$ref": "#/$defs/ExternalDateISOString" }, { "$ref": "#/$defs/ExternalDateUTSOffset" } ], "title": "Using" }, "mode": { "default": "add", "enum": [ "add", "replace" ], "title": "Mode", "type": "string" } }, "required": [ "using" ], "title": "ExternalDate", "type": "object" }, "ExternalDateFile": { "additionalProperties": false, "description": "Read external date information from file.", "properties": { "file": { "$ref": "#/$defs/dgbowl_schemas__yadg__dataschema_5_0__externaldate__ExternalDateFile__Content" } }, "required": [ "file" ], "title": "ExternalDateFile", "type": "object" }, "ExternalDateFilename": { "additionalProperties": false, "description": "Read external date information from the file name.", "properties": { "filename": { "$ref": "#/$defs/dgbowl_schemas__yadg__dataschema_5_0__externaldate__ExternalDateFilename__Content" } }, "required": [ "filename" ], "title": "ExternalDateFilename", "type": "object" }, "ExternalDateISOString": { "additionalProperties": false, "description": "Read a constant external date using an ISO-formatted string.", "properties": { "isostring": { "title": "Isostring", "type": "string" } }, "required": [ "isostring" ], "title": "ExternalDateISOString", "type": "object" }, "ExternalDateUTSOffset": { "additionalProperties": false, "description": "Read a constant external date using a Unix timestamp offset.", "properties": { "utsoffset": { "title": "Utsoffset", "type": "number" } }, "required": [ "utsoffset" ], "title": "ExternalDateUTSOffset", "type": "object" }, "Input": { "additionalProperties": false, "description": "Specification of input files/folders to be processed by the :class:`Step`.", "properties": { "folders": { "items": { "type": "string" }, "title": "Folders", "type": "array" }, "prefix": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Prefix" }, "suffix": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Suffix" }, "contains": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Contains" }, "exclude": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Exclude" } }, "required": [ "folders" ], "title": "Input", "type": "object" }, "LabView_csv": { "additionalProperties": false, "properties": { "filetype": { "const": "labview.csv", "enum": [ "labview.csv" ], "title": "Filetype", "type": "string" }, "timezone": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Timezone" }, "locale": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Locale" }, "encoding": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Encoding" } }, "required": [ "filetype" ], "title": "LabView_csv", "type": "object" }, "Parameters": { "additionalProperties": false, "description": "Empty parameters specification with no extras allowed.", "properties": {}, "title": "Parameters", "type": "object" }, "dgbowl_schemas__yadg__dataschema_5_0__externaldate__ExternalDateFile__Content": { "additionalProperties": false, "properties": { "path": { "title": "Path", "type": "string" }, "type": { "title": "Type", "type": "string" }, "match": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Match" } }, "required": [ "path", "type" ], "title": "Content", "type": "object" }, "dgbowl_schemas__yadg__dataschema_5_0__externaldate__ExternalDateFilename__Content": { "additionalProperties": false, "properties": { "format": { "title": "Format", "type": "string" }, "len": { "title": "Len", "type": "integer" } }, "required": [ "format", "len" ], "title": "Content", "type": "object" } }, "additionalProperties": false, "required": [ "parser", "input", "extractor" ] }
- Config:
extra: str = forbid
- field parser: Literal['qftrace'] [Required]
- field extractor: LabView_csv [Required]
- pydantic model dgbowl_schemas.yadg.dataschema_5_0.step.XPSTrace
Bases:
ParserParser for XPS traces.
Show JSON schema
{ "title": "XPSTrace", "description": "Parser for XPS traces.", "type": "object", "properties": { "tag": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Tag" }, "parser": { "const": "xpstrace", "enum": [ "xpstrace" ], "title": "Parser", "type": "string" }, "input": { "$ref": "#/$defs/Input" }, "extractor": { "$ref": "#/$defs/Phi_spe" }, "parameters": { "anyOf": [ { "$ref": "#/$defs/Parameters" }, { "type": "null" } ], "default": null }, "externaldate": { "anyOf": [ { "$ref": "#/$defs/ExternalDate" }, { "type": "null" } ], "default": null } }, "$defs": { "ExternalDate": { "additionalProperties": false, "description": "Supply timestamping information that are external to the processed file.", "properties": { "using": { "anyOf": [ { "$ref": "#/$defs/ExternalDateFile" }, { "$ref": "#/$defs/ExternalDateFilename" }, { "$ref": "#/$defs/ExternalDateISOString" }, { "$ref": "#/$defs/ExternalDateUTSOffset" } ], "title": "Using" }, "mode": { "default": "add", "enum": [ "add", "replace" ], "title": "Mode", "type": "string" } }, "required": [ "using" ], "title": "ExternalDate", "type": "object" }, "ExternalDateFile": { "additionalProperties": false, "description": "Read external date information from file.", "properties": { "file": { "$ref": "#/$defs/dgbowl_schemas__yadg__dataschema_5_0__externaldate__ExternalDateFile__Content" } }, "required": [ "file" ], "title": "ExternalDateFile", "type": "object" }, "ExternalDateFilename": { "additionalProperties": false, "description": "Read external date information from the file name.", "properties": { "filename": { "$ref": "#/$defs/dgbowl_schemas__yadg__dataschema_5_0__externaldate__ExternalDateFilename__Content" } }, "required": [ "filename" ], "title": "ExternalDateFilename", "type": "object" }, "ExternalDateISOString": { "additionalProperties": false, "description": "Read a constant external date using an ISO-formatted string.", "properties": { "isostring": { "title": "Isostring", "type": "string" } }, "required": [ "isostring" ], "title": "ExternalDateISOString", "type": "object" }, "ExternalDateUTSOffset": { "additionalProperties": false, "description": "Read a constant external date using a Unix timestamp offset.", "properties": { "utsoffset": { "title": "Utsoffset", "type": "number" } }, "required": [ "utsoffset" ], "title": "ExternalDateUTSOffset", "type": "object" }, "Input": { "additionalProperties": false, "description": "Specification of input files/folders to be processed by the :class:`Step`.", "properties": { "folders": { "items": { "type": "string" }, "title": "Folders", "type": "array" }, "prefix": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Prefix" }, "suffix": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Suffix" }, "contains": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Contains" }, "exclude": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Exclude" } }, "required": [ "folders" ], "title": "Input", "type": "object" }, "Parameters": { "additionalProperties": false, "description": "Empty parameters specification with no extras allowed.", "properties": {}, "title": "Parameters", "type": "object" }, "Phi_spe": { "additionalProperties": false, "properties": { "filetype": { "enum": [ "phi.spe", "marda:phi-spe" ], "title": "Filetype", "type": "string" }, "timezone": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Timezone" }, "locale": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Locale" }, "encoding": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Encoding" } }, "required": [ "filetype" ], "title": "Phi_spe", "type": "object" }, "dgbowl_schemas__yadg__dataschema_5_0__externaldate__ExternalDateFile__Content": { "additionalProperties": false, "properties": { "path": { "title": "Path", "type": "string" }, "type": { "title": "Type", "type": "string" }, "match": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Match" } }, "required": [ "path", "type" ], "title": "Content", "type": "object" }, "dgbowl_schemas__yadg__dataschema_5_0__externaldate__ExternalDateFilename__Content": { "additionalProperties": false, "properties": { "format": { "title": "Format", "type": "string" }, "len": { "title": "Len", "type": "integer" } }, "required": [ "format", "len" ], "title": "Content", "type": "object" } }, "additionalProperties": false, "required": [ "parser", "input", "extractor" ] }
- Config:
extra: str = forbid
- field parser: Literal['xpstrace'] [Required]
- pydantic model dgbowl_schemas.yadg.dataschema_5_0.step.XRDTrace
Bases:
ParserParser for XRD traces.
Show JSON schema
{ "title": "XRDTrace", "description": "Parser for XRD traces.", "type": "object", "properties": { "tag": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Tag" }, "parser": { "const": "xrdtrace", "enum": [ "xrdtrace" ], "title": "Parser", "type": "string" }, "input": { "$ref": "#/$defs/Input" }, "extractor": { "anyOf": [ { "$ref": "#/$defs/Panalytical_xrdml" }, { "$ref": "#/$defs/Panalytical_xy" }, { "$ref": "#/$defs/Panalytical_csv" } ], "title": "Extractor" }, "parameters": { "anyOf": [ { "$ref": "#/$defs/Parameters" }, { "type": "null" } ], "default": null }, "externaldate": { "anyOf": [ { "$ref": "#/$defs/ExternalDate" }, { "type": "null" } ], "default": null } }, "$defs": { "ExternalDate": { "additionalProperties": false, "description": "Supply timestamping information that are external to the processed file.", "properties": { "using": { "anyOf": [ { "$ref": "#/$defs/ExternalDateFile" }, { "$ref": "#/$defs/ExternalDateFilename" }, { "$ref": "#/$defs/ExternalDateISOString" }, { "$ref": "#/$defs/ExternalDateUTSOffset" } ], "title": "Using" }, "mode": { "default": "add", "enum": [ "add", "replace" ], "title": "Mode", "type": "string" } }, "required": [ "using" ], "title": "ExternalDate", "type": "object" }, "ExternalDateFile": { "additionalProperties": false, "description": "Read external date information from file.", "properties": { "file": { "$ref": "#/$defs/dgbowl_schemas__yadg__dataschema_5_0__externaldate__ExternalDateFile__Content" } }, "required": [ "file" ], "title": "ExternalDateFile", "type": "object" }, "ExternalDateFilename": { "additionalProperties": false, "description": "Read external date information from the file name.", "properties": { "filename": { "$ref": "#/$defs/dgbowl_schemas__yadg__dataschema_5_0__externaldate__ExternalDateFilename__Content" } }, "required": [ "filename" ], "title": "ExternalDateFilename", "type": "object" }, "ExternalDateISOString": { "additionalProperties": false, "description": "Read a constant external date using an ISO-formatted string.", "properties": { "isostring": { "title": "Isostring", "type": "string" } }, "required": [ "isostring" ], "title": "ExternalDateISOString", "type": "object" }, "ExternalDateUTSOffset": { "additionalProperties": false, "description": "Read a constant external date using a Unix timestamp offset.", "properties": { "utsoffset": { "title": "Utsoffset", "type": "number" } }, "required": [ "utsoffset" ], "title": "ExternalDateUTSOffset", "type": "object" }, "Input": { "additionalProperties": false, "description": "Specification of input files/folders to be processed by the :class:`Step`.", "properties": { "folders": { "items": { "type": "string" }, "title": "Folders", "type": "array" }, "prefix": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Prefix" }, "suffix": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Suffix" }, "contains": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Contains" }, "exclude": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Exclude" } }, "required": [ "folders" ], "title": "Input", "type": "object" }, "Panalytical_csv": { "additionalProperties": false, "properties": { "filetype": { "const": "panalytical.csv", "enum": [ "panalytical.csv" ], "title": "Filetype", "type": "string" }, "timezone": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Timezone" }, "locale": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Locale" }, "encoding": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Encoding" } }, "required": [ "filetype" ], "title": "Panalytical_csv", "type": "object" }, "Panalytical_xrdml": { "additionalProperties": false, "properties": { "filetype": { "enum": [ "panalytical.xrdml", "marda:panalytical-xrdml" ], "title": "Filetype", "type": "string" }, "timezone": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Timezone" }, "locale": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Locale" }, "encoding": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Encoding" } }, "required": [ "filetype" ], "title": "Panalytical_xrdml", "type": "object" }, "Panalytical_xy": { "additionalProperties": false, "properties": { "filetype": { "const": "panalytical.xy", "enum": [ "panalytical.xy" ], "title": "Filetype", "type": "string" }, "timezone": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Timezone" }, "locale": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Locale" }, "encoding": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Encoding" } }, "required": [ "filetype" ], "title": "Panalytical_xy", "type": "object" }, "Parameters": { "additionalProperties": false, "description": "Empty parameters specification with no extras allowed.", "properties": {}, "title": "Parameters", "type": "object" }, "dgbowl_schemas__yadg__dataschema_5_0__externaldate__ExternalDateFile__Content": { "additionalProperties": false, "properties": { "path": { "title": "Path", "type": "string" }, "type": { "title": "Type", "type": "string" }, "match": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Match" } }, "required": [ "path", "type" ], "title": "Content", "type": "object" }, "dgbowl_schemas__yadg__dataschema_5_0__externaldate__ExternalDateFilename__Content": { "additionalProperties": false, "properties": { "format": { "title": "Format", "type": "string" }, "len": { "title": "Len", "type": "integer" } }, "required": [ "format", "len" ], "title": "Content", "type": "object" } }, "additionalProperties": false, "required": [ "parser", "input", "extractor" ] }
- Config:
extra: str = forbid
- field parser: Literal['xrdtrace'] [Required]
- field extractor: Panalytical_xrdml | Panalytical_xy | Panalytical_csv [Required]
dgbowl_schemas.yadg.dataschema_5_0.stepdefaults module
- pydantic model dgbowl_schemas.yadg.dataschema_5_0.stepdefaults.StepDefaults
Bases:
BaseModelConfiguration of defaults applicable for all steps.
Show JSON schema
{ "title": "StepDefaults", "description": "Configuration of defaults applicable for all steps.", "type": "object", "properties": { "timezone": { "default": "localtime", "title": "Timezone", "type": "string" }, "locale": { "anyOf": [ { "maxItems": 2, "minItems": 2, "prefixItems": [ { "type": "string" }, { "type": "string" } ], "type": "array" }, { "type": "string" }, { "type": "null" } ], "default": null, "title": "Locale" }, "encoding": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Encoding" } }, "additionalProperties": false }
- Config:
extra: str = forbid
- Validators:
- field timezone: str = 'localtime'
Global timezone specification.
Note
This should be set to the timezone where the measurements have been performed, as opposed to the timezone where
yadgis being executed. Otherwise timezone offsets may not be accounted for correctly.- Validated by:
- field locale: Tuple[str, str] | str | None = None
Global locale specification. Will default to current locale.
- Validated by:
- field encoding: str | None = None
Global filetype encoding. Will default to
None.
dgbowl_schemas.yadg.dataschema_5_0.timestamp module
- pydantic model dgbowl_schemas.yadg.dataschema_5_0.timestamp.TimestampSpec
Bases:
BaseModelSpecification of the column index and string format of the timestamp.
Show JSON schema
{ "title": "TimestampSpec", "description": "Specification of the column index and string format of the timestamp.", "type": "object", "properties": { "index": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "title": "Index" }, "format": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Format" } }, "additionalProperties": false }
- Config:
extra: str = forbid
- field index: int | None = None
- field format: str | None = None
- pydantic model dgbowl_schemas.yadg.dataschema_5_0.timestamp.Timestamp
Bases:
BaseModelTimestamp from a column containing a single timestamp string.
Show JSON schema
{ "title": "Timestamp", "description": "Timestamp from a column containing a single timestamp string.", "type": "object", "properties": { "timestamp": { "$ref": "#/$defs/TimestampSpec" } }, "$defs": { "TimestampSpec": { "additionalProperties": false, "description": "Specification of the column index and string format of the timestamp.", "properties": { "index": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "title": "Index" }, "format": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Format" } }, "title": "TimestampSpec", "type": "object" } }, "additionalProperties": false, "required": [ "timestamp" ] }
- Config:
extra: str = forbid
- field timestamp: TimestampSpec [Required]
- pydantic model dgbowl_schemas.yadg.dataschema_5_0.timestamp.UTS
Bases:
BaseModelTimestamp from a column containing a Unix timestamp.
Show JSON schema
{ "title": "UTS", "description": "Timestamp from a column containing a Unix timestamp.", "type": "object", "properties": { "uts": { "$ref": "#/$defs/TimestampSpec" } }, "$defs": { "TimestampSpec": { "additionalProperties": false, "description": "Specification of the column index and string format of the timestamp.", "properties": { "index": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "title": "Index" }, "format": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Format" } }, "title": "TimestampSpec", "type": "object" } }, "additionalProperties": false, "required": [ "uts" ] }
- Config:
extra: str = forbid
- field uts: TimestampSpec [Required]
- pydantic model dgbowl_schemas.yadg.dataschema_5_0.timestamp.TimeDate
Bases:
BaseModelTimestamp from a separate date and/or time column.
Show JSON schema
{ "title": "TimeDate", "description": "Timestamp from a separate date and/or time column.", "type": "object", "properties": { "date": { "anyOf": [ { "$ref": "#/$defs/TimestampSpec" }, { "type": "null" } ], "default": null }, "time": { "anyOf": [ { "$ref": "#/$defs/TimestampSpec" }, { "type": "null" } ], "default": null } }, "$defs": { "TimestampSpec": { "additionalProperties": false, "description": "Specification of the column index and string format of the timestamp.", "properties": { "index": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "title": "Index" }, "format": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Format" } }, "title": "TimestampSpec", "type": "object" } }, "additionalProperties": false }
- Config:
extra: str = forbid
- field date: TimestampSpec | None = None
- field time: TimestampSpec | None = None