dgbowl_schemas.yadg.dataschema_4_2 package
- pydantic model dgbowl_schemas.yadg.dataschema_4_2.DataSchema
Bases:
BaseModelShow JSON schema
{ "title": "DataSchema", "type": "object", "properties": { "metadata": { "$ref": "#/$defs/Metadata" }, "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": { "BasicCSV": { "additionalProperties": false, "description": "Customisable tabulated file parser.", "properties": { "parser": { "const": "basiccsv", "title": "Parser", "type": "string" }, "input": { "$ref": "#/$defs/dgbowl_schemas__yadg__dataschema_4_2__input__Input" }, "parameters": { "$ref": "#/$defs/dgbowl_schemas__yadg__dataschema_4_2__step__BasicCSV__Params" }, "tag": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Tag" }, "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": { "parser": { "const": "chromdata", "title": "Parser", "type": "string" }, "input": { "$ref": "#/$defs/dgbowl_schemas__yadg__dataschema_4_2__input__Input" }, "parameters": { "$ref": "#/$defs/dgbowl_schemas__yadg__dataschema_4_2__step__ChromData__Params" }, "tag": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Tag" }, "externaldate": { "anyOf": [ { "$ref": "#/$defs/ExternalDate" }, { "type": "null" } ], "default": null } }, "required": [ "parser", "input" ], "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": { "parser": { "const": "chromtrace", "title": "Parser", "type": "string" }, "input": { "$ref": "#/$defs/dgbowl_schemas__yadg__dataschema_4_2__input__Input" }, "parameters": { "$ref": "#/$defs/dgbowl_schemas__yadg__dataschema_4_2__step__ChromTrace__Params" }, "tag": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Tag" }, "externaldate": { "anyOf": [ { "$ref": "#/$defs/ExternalDate" }, { "type": "null" } ], "default": null } }, "required": [ "parser", "input" ], "title": "ChromTrace", "type": "object" }, "Dummy": { "additionalProperties": false, "description": "Dummy parser type, useful for testing.", "properties": { "parser": { "const": "dummy", "title": "Parser", "type": "string" }, "input": { "$ref": "#/$defs/dgbowl_schemas__yadg__dataschema_4_2__input__Input" }, "parameters": { "anyOf": [ { "$ref": "#/$defs/dgbowl_schemas__yadg__dataschema_4_2__step__Dummy__Params" }, { "type": "null" } ], "default": null }, "tag": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Tag" }, "externaldate": { "anyOf": [ { "$ref": "#/$defs/ExternalDate" }, { "type": "null" } ], "default": null } }, "required": [ "parser", "input" ], "title": "Dummy", "type": "object" }, "ElectroChem": { "additionalProperties": false, "description": "Parser for electrochemistry files.", "properties": { "parser": { "const": "electrochem", "title": "Parser", "type": "string" }, "input": { "$ref": "#/$defs/dgbowl_schemas__yadg__dataschema_4_2__step__ElectroChem__Input" }, "parameters": { "$ref": "#/$defs/dgbowl_schemas__yadg__dataschema_4_2__step__ElectroChem__Params" }, "tag": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Tag" }, "externaldate": { "anyOf": [ { "$ref": "#/$defs/ExternalDate" }, { "type": "null" } ], "default": null } }, "required": [ "parser", "input" ], "title": "ElectroChem", "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_4_2__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_4_2__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": { "parser": { "const": "flowdata", "title": "Parser", "type": "string" }, "input": { "$ref": "#/$defs/dgbowl_schemas__yadg__dataschema_4_2__input__Input" }, "parameters": { "$ref": "#/$defs/dgbowl_schemas__yadg__dataschema_4_2__step__FlowData__Params" }, "tag": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Tag" }, "externaldate": { "anyOf": [ { "$ref": "#/$defs/ExternalDate" }, { "type": "null" } ], "default": null } }, "required": [ "parser", "input" ], "title": "FlowData", "type": "object" }, "MassTrace": { "additionalProperties": false, "description": "Parser for mass spectroscopy traces.", "properties": { "parser": { "const": "masstrace", "title": "Parser", "type": "string" }, "input": { "$ref": "#/$defs/dgbowl_schemas__yadg__dataschema_4_2__input__Input" }, "parameters": { "$ref": "#/$defs/dgbowl_schemas__yadg__dataschema_4_2__step__MassTrace__Params" }, "tag": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Tag" }, "externaldate": { "anyOf": [ { "$ref": "#/$defs/ExternalDate" }, { "type": "null" } ], "default": null } }, "required": [ "parser", "input" ], "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": { "parser": { "const": "meascsv", "title": "Parser", "type": "string" }, "input": { "$ref": "#/$defs/dgbowl_schemas__yadg__dataschema_4_2__input__Input" }, "parameters": { "$ref": "#/$defs/dgbowl_schemas__yadg__dataschema_4_2__step__MeasCSV__Params" }, "tag": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Tag" }, "externaldate": { "anyOf": [ { "$ref": "#/$defs/ExternalDate" }, { "type": "null" } ], "default": null } }, "required": [ "parser", "input" ], "title": "MeasCSV", "type": "object" }, "Metadata": { "additionalProperties": false, "description": "Metadata, including version and provenance of the :class:`DataSchema`.", "properties": { "version": { "const": "4.2", "title": "Version", "type": "string" }, "provenance": { "$ref": "#/$defs/Provenance" }, "timezone": { "default": "localtime", "title": "Timezone", "type": "string" } }, "required": [ "version", "provenance" ], "title": "Metadata", "type": "object" }, "Provenance": { "additionalProperties": false, "properties": { "type": { "title": "Type", "type": "string" }, "metadata": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "default": null, "title": "Metadata" } }, "required": [ "type" ], "title": "Provenance", "type": "object" }, "QFTrace": { "additionalProperties": false, "description": "Parser for network analyzer traces.", "properties": { "parser": { "const": "qftrace", "title": "Parser", "type": "string" }, "input": { "$ref": "#/$defs/dgbowl_schemas__yadg__dataschema_4_2__input__Input" }, "parameters": { "$ref": "#/$defs/dgbowl_schemas__yadg__dataschema_4_2__step__QFTrace__Params" }, "tag": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Tag" }, "externaldate": { "anyOf": [ { "$ref": "#/$defs/ExternalDate" }, { "type": "null" } ], "default": null } }, "required": [ "parser", "input" ], "title": "QFTrace", "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" }, "Tol": { "additionalProperties": false, "description": "Specification of absolute and relative tolerance/error.", "properties": { "atol": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "default": null, "title": "Atol" }, "rtol": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "default": null, "title": "Rtol" } }, "title": "Tol", "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": { "parser": { "const": "xpstrace", "title": "Parser", "type": "string" }, "input": { "$ref": "#/$defs/dgbowl_schemas__yadg__dataschema_4_2__input__Input" }, "parameters": { "$ref": "#/$defs/dgbowl_schemas__yadg__dataschema_4_2__step__XPSTrace__Params" }, "tag": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Tag" }, "externaldate": { "anyOf": [ { "$ref": "#/$defs/ExternalDate" }, { "type": "null" } ], "default": null } }, "required": [ "parser", "input" ], "title": "XPSTrace", "type": "object" }, "XRDTrace": { "additionalProperties": false, "description": "Parser for XRD traces.", "properties": { "parser": { "const": "xrdtrace", "title": "Parser", "type": "string" }, "input": { "$ref": "#/$defs/dgbowl_schemas__yadg__dataschema_4_2__input__Input" }, "parameters": { "$ref": "#/$defs/dgbowl_schemas__yadg__dataschema_4_2__step__XRDTrace__Params" }, "tag": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Tag" }, "externaldate": { "anyOf": [ { "$ref": "#/$defs/ExternalDate" }, { "type": "null" } ], "default": null } }, "required": [ "parser", "input" ], "title": "XRDTrace", "type": "object" }, "dgbowl_schemas__yadg__dataschema_4_2__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_4_2__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_4_2__input__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" }, "encoding": { "default": "UTF-8", "title": "Encoding", "type": "string" } }, "required": [ "folders" ], "title": "Input", "type": "object" }, "dgbowl_schemas__yadg__dataschema_4_2__step__BasicCSV__Params": { "additionalProperties": false, "properties": { "sep": { "default": ",", "title": "Sep", "type": "string" }, "strip": { "default": null, "title": "Strip", "type": "string" }, "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" }, "sigma": { "anyOf": [ { "additionalProperties": { "$ref": "#/$defs/Tol" }, "type": "object" }, { "type": "null" } ], "default": null, "deprecated": true, "title": "Sigma" }, "calfile": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "deprecated": true, "title": "Calfile" }, "convert": { "anyOf": [ {}, { "type": "null" } ], "default": null, "deprecated": true, "title": "Convert" } }, "title": "Params", "type": "object" }, "dgbowl_schemas__yadg__dataschema_4_2__step__ChromData__Params": { "additionalProperties": false, "properties": { "filetype": { "default": "fusion.json", "enum": [ "fusion.json", "fusion.zip", "fusion.csv", "empalc.csv", "empalc.xlsx" ], "title": "Filetype", "type": "string" } }, "title": "Params", "type": "object" }, "dgbowl_schemas__yadg__dataschema_4_2__step__ChromTrace__Params": { "additionalProperties": false, "properties": { "filetype": { "default": "ezchrom.asc", "enum": [ "ezchrom.asc", "fusion.json", "fusion.zip", "agilent.ch", "agilent.dx", "agilent.csv" ], "title": "Filetype", "type": "string" }, "calfile": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "deprecated": true, "title": "Calfile" }, "species": { "anyOf": [ {}, { "type": "null" } ], "default": null, "deprecated": true, "title": "Species" }, "detectors": { "anyOf": [ {}, { "type": "null" } ], "default": null, "deprecated": true, "title": "Detectors" } }, "title": "Params", "type": "object" }, "dgbowl_schemas__yadg__dataschema_4_2__step__Dummy__Params": { "additionalProperties": true, "properties": {}, "title": "Params", "type": "object" }, "dgbowl_schemas__yadg__dataschema_4_2__step__ElectroChem__Input": { "additionalProperties": false, "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" }, "encoding": { "default": "windows-1252", "title": "Encoding", "type": "string" } }, "required": [ "folders" ], "title": "Input", "type": "object" }, "dgbowl_schemas__yadg__dataschema_4_2__step__ElectroChem__Params": { "additionalProperties": false, "properties": { "filetype": { "default": "eclab.mpr", "enum": [ "eclab.mpt", "eclab.mpr", "tomato.json" ], "title": "Filetype", "type": "string" }, "transpose": { "default": true, "title": "Transpose", "type": "boolean" } }, "title": "Params", "type": "object" }, "dgbowl_schemas__yadg__dataschema_4_2__step__FlowData__Params": { "additionalProperties": false, "properties": { "filetype": { "default": "drycal.csv", "enum": [ "drycal.csv", "drycal.rtf", "drycal.txt" ], "title": "Filetype", "type": "string" }, "calfile": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "deprecated": true, "title": "Calfile" }, "convert": { "anyOf": [ {}, { "type": "null" } ], "default": null, "deprecated": true, "title": "Convert" } }, "title": "Params", "type": "object" }, "dgbowl_schemas__yadg__dataschema_4_2__step__MassTrace__Params": { "additionalProperties": false, "properties": { "filetype": { "const": "quadstar.sac", "default": "quadstar.sac", "title": "Filetype", "type": "string" } }, "title": "Params", "type": "object" }, "dgbowl_schemas__yadg__dataschema_4_2__step__MeasCSV__Params": { "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" }, "calfile": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "deprecated": true, "title": "Calfile" }, "convert": { "anyOf": [ {}, { "type": "null" } ], "default": null, "deprecated": true, "title": "Convert" } }, "title": "Params", "type": "object" }, "dgbowl_schemas__yadg__dataschema_4_2__step__QFTrace__Params": { "additionalProperties": false, "properties": { "filetype": { "const": "labview.csv", "default": "labview.csv", "title": "Filetype", "type": "string" }, "method": { "default": "kajfez", "enum": [ "naive", "lorentz", "kajfez" ], "title": "Method", "type": "string" }, "height": { "default": 1.0, "title": "Height", "type": "number" }, "distance": { "default": 5000.0, "title": "Distance", "type": "number" }, "cutoff": { "default": 0.4, "title": "Cutoff", "type": "number" }, "threshold": { "default": 1e-06, "title": "Threshold", "type": "number" } }, "title": "Params", "type": "object" }, "dgbowl_schemas__yadg__dataschema_4_2__step__XPSTrace__Params": { "additionalProperties": false, "properties": { "filetype": { "const": "phi.spe", "default": "phi.spe", "title": "Filetype", "type": "string" } }, "title": "Params", "type": "object" }, "dgbowl_schemas__yadg__dataschema_4_2__step__XRDTrace__Params": { "additionalProperties": false, "properties": { "filetype": { "default": "panalytical.csv", "enum": [ "panalytical.xy", "panalytical.csv", "panalytical.xrdml" ], "title": "Filetype", "type": "string" } }, "title": "Params", "type": "object" } }, "additionalProperties": false, "required": [ "metadata", "steps" ] }
- Config:
extra: str = forbid
- field steps: Sequence[Dummy | BasicCSV | MeasCSV | FlowData | ElectroChem | ChromTrace | ChromData | MassTrace | QFTrace | XPSTrace | XRDTrace] [Required]
A sequence of parser steps.
- update()
Submodules
dgbowl_schemas.yadg.dataschema_4_2.externaldate module
- pydantic model dgbowl_schemas.yadg.dataschema_4_2.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_4_2.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_4_2.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_4_2.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_4_2.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_4_2__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_4_2__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_4_2__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_4_2__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_4_2.input module
- pydantic model dgbowl_schemas.yadg.dataschema_4_2.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" }, "encoding": { "default": "UTF-8", "title": "Encoding", "type": "string" } }, "additionalProperties": false, "required": [ "folders" ] }
- Config:
extra: str = forbid
populate_by_name: bool = True
validate_by_alias: bool = True
validate_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.
- field encoding: str = 'UTF-8'
File encoding.
- paths() List[str]
Returns a list of files to be processed by the
Step.
dgbowl_schemas.yadg.dataschema_4_2.metadata module
- pydantic model dgbowl_schemas.yadg.dataschema_4_2.metadata.Metadata
Bases:
BaseModelMetadata, including version and provenance of the
DataSchema.Show JSON schema
{ "title": "Metadata", "description": "Metadata, including version and provenance of the :class:`DataSchema`.", "type": "object", "properties": { "version": { "const": "4.2", "title": "Version", "type": "string" }, "provenance": { "$ref": "#/$defs/Provenance" }, "timezone": { "default": "localtime", "title": "Timezone", "type": "string" } }, "$defs": { "Provenance": { "additionalProperties": false, "properties": { "type": { "title": "Type", "type": "string" }, "metadata": { "anyOf": [ { "additionalProperties": true, "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": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "default": null, "title": "Metadata" } }, "additionalProperties": false, "required": [ "type" ] }
- Config:
extra: str = forbid
- field type: str [Required]
- field metadata: Mapping[str, Any] | None = None
- field version: Literal['4.2'] [Required]
- field provenance: Provenance [Required]
Provenance information.
- field timezone: str = 'localtime'
Timezone specification.
Note
This should be set to the timezone where the measurements have been performed, as opposed to the timezone where yadg is being executed, otherwise timezone offsets may not be accounted for correctly.
dgbowl_schemas.yadg.dataschema_4_2.parameters module
- pydantic model dgbowl_schemas.yadg.dataschema_4_2.parameters.Tol
Bases:
BaseModelSpecification of absolute and relative tolerance/error.
Show JSON schema
{ "title": "Tol", "description": "Specification of absolute and relative tolerance/error.", "type": "object", "properties": { "atol": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "default": null, "title": "Atol" }, "rtol": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "default": null, "title": "Rtol" } }, "additionalProperties": false }
- Config:
extra: str = forbid
- field atol: float | None = None
- field rtol: float | None = None
dgbowl_schemas.yadg.dataschema_4_2.step module
- pydantic model dgbowl_schemas.yadg.dataschema_4_2.step.Dummy
Bases:
BaseModelDummy parser type, useful for testing.
Show JSON schema
{ "title": "Dummy", "description": "Dummy parser type, useful for testing.", "type": "object", "properties": { "parser": { "const": "dummy", "title": "Parser", "type": "string" }, "input": { "$ref": "#/$defs/Input" }, "parameters": { "anyOf": [ { "$ref": "#/$defs/Params" }, { "type": "null" } ], "default": null }, "tag": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Tag" }, "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_4_2__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_4_2__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" }, "encoding": { "default": "UTF-8", "title": "Encoding", "type": "string" } }, "required": [ "folders" ], "title": "Input", "type": "object" }, "Params": { "additionalProperties": true, "properties": {}, "title": "Params", "type": "object" }, "dgbowl_schemas__yadg__dataschema_4_2__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_4_2__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 Params
Bases:
BaseModelShow JSON schema
{ "title": "Params", "type": "object", "properties": {}, "additionalProperties": true }
- Config:
extra: str = allow
- field parser: Literal['dummy'] [Required]
- field tag: str | None = None
- field externaldate: ExternalDate | None = None
- pydantic model dgbowl_schemas.yadg.dataschema_4_2.step.BasicCSV
Bases:
BaseModelCustomisable tabulated file parser.
Show JSON schema
{ "title": "BasicCSV", "description": "Customisable tabulated file parser.", "type": "object", "properties": { "parser": { "const": "basiccsv", "title": "Parser", "type": "string" }, "input": { "$ref": "#/$defs/Input" }, "parameters": { "$ref": "#/$defs/Params" }, "tag": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Tag" }, "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_4_2__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_4_2__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" }, "encoding": { "default": "UTF-8", "title": "Encoding", "type": "string" } }, "required": [ "folders" ], "title": "Input", "type": "object" }, "Params": { "additionalProperties": false, "properties": { "sep": { "default": ",", "title": "Sep", "type": "string" }, "strip": { "default": null, "title": "Strip", "type": "string" }, "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" }, "sigma": { "anyOf": [ { "additionalProperties": { "$ref": "#/$defs/Tol" }, "type": "object" }, { "type": "null" } ], "default": null, "deprecated": true, "title": "Sigma" }, "calfile": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "deprecated": true, "title": "Calfile" }, "convert": { "anyOf": [ {}, { "type": "null" } ], "default": null, "deprecated": true, "title": "Convert" } }, "title": "Params", "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" }, "Tol": { "additionalProperties": false, "description": "Specification of absolute and relative tolerance/error.", "properties": { "atol": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "default": null, "title": "Atol" }, "rtol": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "default": null, "title": "Rtol" } }, "title": "Tol", "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_4_2__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_4_2__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 Params
Bases:
BaseModelShow JSON schema
{ "title": "Params", "type": "object", "properties": { "sep": { "default": ",", "title": "Sep", "type": "string" }, "strip": { "default": null, "title": "Strip", "type": "string" }, "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" }, "sigma": { "anyOf": [ { "additionalProperties": { "$ref": "#/$defs/Tol" }, "type": "object" }, { "type": "null" } ], "default": null, "deprecated": true, "title": "Sigma" }, "calfile": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "deprecated": true, "title": "Calfile" }, "convert": { "anyOf": [ {}, { "type": "null" } ], "default": null, "deprecated": true, "title": "Convert" } }, "$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" }, "Tol": { "additionalProperties": false, "description": "Specification of absolute and relative tolerance/error.", "properties": { "atol": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "default": null, "title": "Atol" }, "rtol": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "default": null, "title": "Rtol" } }, "title": "Tol", "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
A
strof characters to strip from headers & data.
- field units: Mapping[str, str] | None = None
A
dictcontainingcolumn: unitkeypairs.
- field timestamp: Timestamp | TimeDate | UTS | None = None
Timestamp specification allowing calculation of Unix timestamp for each table row.
- field sigma: Mapping[str, Tol] | None = None
External uncertainty specification.
DEPRECATED in
DataSchema-4.2This feature is deprecated as of
yadg-4.2and will stop working inyadg-5.0.
- field calfile: str | None = None
Column calibration specification.
DEPRECATED in
DataSchema-4.2This feature is deprecated as of
yadg-4.2and will stop working inyadg-5.0.
- field convert: Any | None = None
Column renaming specification.
DEPRECATED in
DataSchema-4.2This feature is deprecated as of
yadg-4.2and will stop working inyadg-5.0.
- field parser: Literal['basiccsv'] [Required]
- field tag: str | None = None
- field externaldate: ExternalDate | None = None
- pydantic model dgbowl_schemas.yadg.dataschema_4_2.step.MeasCSV
Bases:
BaseModelLegacy 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": { "parser": { "const": "meascsv", "title": "Parser", "type": "string" }, "input": { "$ref": "#/$defs/Input" }, "parameters": { "$ref": "#/$defs/Params" }, "tag": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Tag" }, "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_4_2__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_4_2__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" }, "encoding": { "default": "UTF-8", "title": "Encoding", "type": "string" } }, "required": [ "folders" ], "title": "Input", "type": "object" }, "Params": { "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" }, "calfile": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "deprecated": true, "title": "Calfile" }, "convert": { "anyOf": [ {}, { "type": "null" } ], "default": null, "deprecated": true, "title": "Convert" } }, "title": "Params", "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_4_2__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_4_2__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 Params
Bases:
BaseModelShow JSON schema
{ "title": "Params", "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" }, "calfile": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "deprecated": true, "title": "Calfile" }, "convert": { "anyOf": [ {}, { "type": "null" } ], "default": null, "deprecated": true, "title": "Convert" } }, "$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 timestamp: Timestamp | TimeDate | UTS = Timestamp(timestamp=TimestampSpec(index=0, format='%Y-%m-%d-%H-%M-%S'))
- field calfile: str | None = None
Column calibration specification.
DEPRECATED in
DataSchema-4.2This feature is deprecated as of
yadg-4.2and will stop working inyadg-5.0.
- field convert: Any | None = None
Column renaming specification.
DEPRECATED in
DataSchema-4.2This feature is deprecated as of
yadg-4.2and will stop working inyadg-5.0.
- field parser: Literal['meascsv'] [Required]
- field tag: str | None = None
- field externaldate: ExternalDate | None = None
- pydantic model dgbowl_schemas.yadg.dataschema_4_2.step.FlowData
Bases:
BaseModelParser for flow controller/meter data.
Show JSON schema
{ "title": "FlowData", "description": "Parser for flow controller/meter data.", "type": "object", "properties": { "parser": { "const": "flowdata", "title": "Parser", "type": "string" }, "input": { "$ref": "#/$defs/Input" }, "parameters": { "$ref": "#/$defs/Params" }, "tag": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Tag" }, "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_4_2__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_4_2__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" }, "encoding": { "default": "UTF-8", "title": "Encoding", "type": "string" } }, "required": [ "folders" ], "title": "Input", "type": "object" }, "Params": { "additionalProperties": false, "properties": { "filetype": { "default": "drycal.csv", "enum": [ "drycal.csv", "drycal.rtf", "drycal.txt" ], "title": "Filetype", "type": "string" }, "calfile": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "deprecated": true, "title": "Calfile" }, "convert": { "anyOf": [ {}, { "type": "null" } ], "default": null, "deprecated": true, "title": "Convert" } }, "title": "Params", "type": "object" }, "dgbowl_schemas__yadg__dataschema_4_2__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_4_2__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 Params
Bases:
BaseModelShow JSON schema
{ "title": "Params", "type": "object", "properties": { "filetype": { "default": "drycal.csv", "enum": [ "drycal.csv", "drycal.rtf", "drycal.txt" ], "title": "Filetype", "type": "string" }, "calfile": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "deprecated": true, "title": "Calfile" }, "convert": { "anyOf": [ {}, { "type": "null" } ], "default": null, "deprecated": true, "title": "Convert" } }, "additionalProperties": false }
- Config:
extra: str = forbid
- field filetype: Literal['drycal.csv', 'drycal.rtf', 'drycal.txt'] = 'drycal.csv'
- field calfile: str | None = None
Column calibration specification.
DEPRECATED in
DataSchema-4.2This feature is deprecated as of
yadg-4.2and will stop working inyadg-5.0.
- field convert: Any | None = None
Column renaming specification.
DEPRECATED in
DataSchema-4.2This feature is deprecated as of
yadg-4.2and will stop working inyadg-5.0.
- field parser: Literal['flowdata'] [Required]
- field tag: str | None = None
- field externaldate: ExternalDate | None = None
- pydantic model dgbowl_schemas.yadg.dataschema_4_2.step.ElectroChem
Bases:
BaseModelParser for electrochemistry files.
Show JSON schema
{ "title": "ElectroChem", "description": "Parser for electrochemistry files.", "type": "object", "properties": { "parser": { "const": "electrochem", "title": "Parser", "type": "string" }, "input": { "$ref": "#/$defs/Input" }, "parameters": { "$ref": "#/$defs/Params" }, "tag": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Tag" }, "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_4_2__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_4_2__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, "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" }, "encoding": { "default": "windows-1252", "title": "Encoding", "type": "string" } }, "required": [ "folders" ], "title": "Input", "type": "object" }, "Params": { "additionalProperties": false, "properties": { "filetype": { "default": "eclab.mpr", "enum": [ "eclab.mpt", "eclab.mpr", "tomato.json" ], "title": "Filetype", "type": "string" }, "transpose": { "default": true, "title": "Transpose", "type": "boolean" } }, "title": "Params", "type": "object" }, "dgbowl_schemas__yadg__dataschema_4_2__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_4_2__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 Params
Bases:
BaseModelShow JSON schema
{ "title": "Params", "type": "object", "properties": { "filetype": { "default": "eclab.mpr", "enum": [ "eclab.mpt", "eclab.mpr", "tomato.json" ], "title": "Filetype", "type": "string" }, "transpose": { "default": true, "title": "Transpose", "type": "boolean" } }, "additionalProperties": false }
- Config:
extra: str = forbid
- field filetype: Literal['eclab.mpt', 'eclab.mpr', 'tomato.json'] = 'eclab.mpr'
- field transpose: bool = True
Transpose impedance data into traces (default) or keep as timesteps.
- pydantic model Input
Bases:
InputShow JSON schema
{ "title": "Input", "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" }, "encoding": { "default": "windows-1252", "title": "Encoding", "type": "string" } }, "additionalProperties": false, "required": [ "folders" ] }
- Config:
extra: str = forbid
populate_by_name: bool = True
validate_by_alias: bool = True
validate_by_name: bool = True
- field encoding: str = 'windows-1252'
File encoding.
- field parser: Literal['electrochem'] [Required]
- field tag: str | None = None
- field externaldate: ExternalDate | None = None
- pydantic model dgbowl_schemas.yadg.dataschema_4_2.step.ChromTrace
Bases:
BaseModelParser 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": { "parser": { "const": "chromtrace", "title": "Parser", "type": "string" }, "input": { "$ref": "#/$defs/Input" }, "parameters": { "$ref": "#/$defs/Params" }, "tag": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Tag" }, "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_4_2__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_4_2__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" }, "encoding": { "default": "UTF-8", "title": "Encoding", "type": "string" } }, "required": [ "folders" ], "title": "Input", "type": "object" }, "Params": { "additionalProperties": false, "properties": { "filetype": { "default": "ezchrom.asc", "enum": [ "ezchrom.asc", "fusion.json", "fusion.zip", "agilent.ch", "agilent.dx", "agilent.csv" ], "title": "Filetype", "type": "string" }, "calfile": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "deprecated": true, "title": "Calfile" }, "species": { "anyOf": [ {}, { "type": "null" } ], "default": null, "deprecated": true, "title": "Species" }, "detectors": { "anyOf": [ {}, { "type": "null" } ], "default": null, "deprecated": true, "title": "Detectors" } }, "title": "Params", "type": "object" }, "dgbowl_schemas__yadg__dataschema_4_2__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_4_2__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 Params
Bases:
BaseModelShow JSON schema
{ "title": "Params", "type": "object", "properties": { "filetype": { "default": "ezchrom.asc", "enum": [ "ezchrom.asc", "fusion.json", "fusion.zip", "agilent.ch", "agilent.dx", "agilent.csv" ], "title": "Filetype", "type": "string" }, "calfile": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "deprecated": true, "title": "Calfile" }, "species": { "anyOf": [ {}, { "type": "null" } ], "default": null, "deprecated": true, "title": "Species" }, "detectors": { "anyOf": [ {}, { "type": "null" } ], "default": null, "deprecated": true, "title": "Detectors" } }, "additionalProperties": false }
- Config:
extra: str = forbid
- field filetype: Literal['ezchrom.asc', 'fusion.json', 'fusion.zip', 'agilent.ch', 'agilent.dx', 'agilent.csv'] = 'ezchrom.asc'
- field calfile: str | None = None
Species calibration specification.
DEPRECATED in
DataSchema-4.2This feature is deprecated as of
yadg-4.2and will stop working inyadg-5.0.
- field species: Any | None = None
Species information as a
dict.DEPRECATED in
DataSchema-4.2This feature is deprecated as of
yadg-4.2and will stop working inyadg-5.0.
- field detectors: Any | None = None
Detector integration parameters as a
dict.DEPRECATED in
DataSchema-4.2This feature is deprecated as of
yadg-4.2and will stop working inyadg-5.0.
- field parser: Literal['chromtrace'] [Required]
- field tag: str | None = None
- field externaldate: ExternalDate | None = None
- pydantic model dgbowl_schemas.yadg.dataschema_4_2.step.ChromData
Bases:
BaseModelParser for processed chromatography data.
Show JSON schema
{ "title": "ChromData", "description": "Parser for processed chromatography data.", "type": "object", "properties": { "parser": { "const": "chromdata", "title": "Parser", "type": "string" }, "input": { "$ref": "#/$defs/Input" }, "parameters": { "$ref": "#/$defs/Params" }, "tag": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Tag" }, "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_4_2__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_4_2__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" }, "encoding": { "default": "UTF-8", "title": "Encoding", "type": "string" } }, "required": [ "folders" ], "title": "Input", "type": "object" }, "Params": { "additionalProperties": false, "properties": { "filetype": { "default": "fusion.json", "enum": [ "fusion.json", "fusion.zip", "fusion.csv", "empalc.csv", "empalc.xlsx" ], "title": "Filetype", "type": "string" } }, "title": "Params", "type": "object" }, "dgbowl_schemas__yadg__dataschema_4_2__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_4_2__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 Params
Bases:
BaseModelShow JSON schema
{ "title": "Params", "type": "object", "properties": { "filetype": { "default": "fusion.json", "enum": [ "fusion.json", "fusion.zip", "fusion.csv", "empalc.csv", "empalc.xlsx" ], "title": "Filetype", "type": "string" } }, "additionalProperties": false }
- Config:
extra: str = forbid
- field filetype: Literal['fusion.json', 'fusion.zip', 'fusion.csv', 'empalc.csv', 'empalc.xlsx'] = 'fusion.json'
- field parser: Literal['chromdata'] [Required]
- field tag: str | None = None
- field externaldate: ExternalDate | None = None
- pydantic model dgbowl_schemas.yadg.dataschema_4_2.step.MassTrace
Bases:
BaseModelParser for mass spectroscopy traces.
Show JSON schema
{ "title": "MassTrace", "description": "Parser for mass spectroscopy traces.", "type": "object", "properties": { "parser": { "const": "masstrace", "title": "Parser", "type": "string" }, "input": { "$ref": "#/$defs/Input" }, "parameters": { "$ref": "#/$defs/Params" }, "tag": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Tag" }, "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_4_2__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_4_2__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" }, "encoding": { "default": "UTF-8", "title": "Encoding", "type": "string" } }, "required": [ "folders" ], "title": "Input", "type": "object" }, "Params": { "additionalProperties": false, "properties": { "filetype": { "const": "quadstar.sac", "default": "quadstar.sac", "title": "Filetype", "type": "string" } }, "title": "Params", "type": "object" }, "dgbowl_schemas__yadg__dataschema_4_2__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_4_2__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 Params
Bases:
BaseModelShow JSON schema
{ "title": "Params", "type": "object", "properties": { "filetype": { "const": "quadstar.sac", "default": "quadstar.sac", "title": "Filetype", "type": "string" } }, "additionalProperties": false }
- Config:
extra: str = forbid
- field filetype: Literal['quadstar.sac'] = 'quadstar.sac'
- field parser: Literal['masstrace'] [Required]
- field tag: str | None = None
- field externaldate: ExternalDate | None = None
- pydantic model dgbowl_schemas.yadg.dataschema_4_2.step.QFTrace
Bases:
BaseModelParser for network analyzer traces.
Show JSON schema
{ "title": "QFTrace", "description": "Parser for network analyzer traces.", "type": "object", "properties": { "parser": { "const": "qftrace", "title": "Parser", "type": "string" }, "input": { "$ref": "#/$defs/Input" }, "parameters": { "$ref": "#/$defs/Params" }, "tag": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Tag" }, "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_4_2__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_4_2__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" }, "encoding": { "default": "UTF-8", "title": "Encoding", "type": "string" } }, "required": [ "folders" ], "title": "Input", "type": "object" }, "Params": { "additionalProperties": false, "properties": { "filetype": { "const": "labview.csv", "default": "labview.csv", "title": "Filetype", "type": "string" }, "method": { "default": "kajfez", "enum": [ "naive", "lorentz", "kajfez" ], "title": "Method", "type": "string" }, "height": { "default": 1.0, "title": "Height", "type": "number" }, "distance": { "default": 5000.0, "title": "Distance", "type": "number" }, "cutoff": { "default": 0.4, "title": "Cutoff", "type": "number" }, "threshold": { "default": 1e-06, "title": "Threshold", "type": "number" } }, "title": "Params", "type": "object" }, "dgbowl_schemas__yadg__dataschema_4_2__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_4_2__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
populate_by_name: bool = True
validate_by_alias: bool = True
validate_by_name: bool = True
- pydantic model Params
Bases:
BaseModelShow JSON schema
{ "title": "Params", "type": "object", "properties": { "filetype": { "const": "labview.csv", "default": "labview.csv", "title": "Filetype", "type": "string" }, "method": { "default": "kajfez", "enum": [ "naive", "lorentz", "kajfez" ], "title": "Method", "type": "string" }, "height": { "default": 1.0, "title": "Height", "type": "number" }, "distance": { "default": 5000.0, "title": "Distance", "type": "number" }, "cutoff": { "default": 0.4, "title": "Cutoff", "type": "number" }, "threshold": { "default": 1e-06, "title": "Threshold", "type": "number" } }, "additionalProperties": false }
- Config:
extra: str = forbid
- field filetype: Literal['labview.csv'] = 'labview.csv'
- field method: Literal['naive', 'lorentz', 'kajfez'] = 'kajfez'
- field height: float = 1.0
- field distance: float = 5000.0
- field cutoff: float = 0.4
- field threshold: float = 1e-06
- field parser: Literal['qftrace'] [Required]
- field tag: str | None = None
- field externaldate: ExternalDate | None = None
- pydantic model dgbowl_schemas.yadg.dataschema_4_2.step.XPSTrace
Bases:
BaseModelParser for XPS traces.
Show JSON schema
{ "title": "XPSTrace", "description": "Parser for XPS traces.", "type": "object", "properties": { "parser": { "const": "xpstrace", "title": "Parser", "type": "string" }, "input": { "$ref": "#/$defs/Input" }, "parameters": { "$ref": "#/$defs/Params" }, "tag": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Tag" }, "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_4_2__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_4_2__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" }, "encoding": { "default": "UTF-8", "title": "Encoding", "type": "string" } }, "required": [ "folders" ], "title": "Input", "type": "object" }, "Params": { "additionalProperties": false, "properties": { "filetype": { "const": "phi.spe", "default": "phi.spe", "title": "Filetype", "type": "string" } }, "title": "Params", "type": "object" }, "dgbowl_schemas__yadg__dataschema_4_2__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_4_2__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 Params
Bases:
BaseModelShow JSON schema
{ "title": "Params", "type": "object", "properties": { "filetype": { "const": "phi.spe", "default": "phi.spe", "title": "Filetype", "type": "string" } }, "additionalProperties": false }
- Config:
extra: str = forbid
- field filetype: Literal['phi.spe'] = 'phi.spe'
- field parser: Literal['xpstrace'] [Required]
- field tag: str | None = None
- field externaldate: ExternalDate | None = None
- pydantic model dgbowl_schemas.yadg.dataschema_4_2.step.XRDTrace
Bases:
BaseModelParser for XRD traces.
Show JSON schema
{ "title": "XRDTrace", "description": "Parser for XRD traces.", "type": "object", "properties": { "parser": { "const": "xrdtrace", "title": "Parser", "type": "string" }, "input": { "$ref": "#/$defs/Input" }, "parameters": { "$ref": "#/$defs/Params" }, "tag": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Tag" }, "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_4_2__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_4_2__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" }, "encoding": { "default": "UTF-8", "title": "Encoding", "type": "string" } }, "required": [ "folders" ], "title": "Input", "type": "object" }, "Params": { "additionalProperties": false, "properties": { "filetype": { "default": "panalytical.csv", "enum": [ "panalytical.xy", "panalytical.csv", "panalytical.xrdml" ], "title": "Filetype", "type": "string" } }, "title": "Params", "type": "object" }, "dgbowl_schemas__yadg__dataschema_4_2__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_4_2__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 Params
Bases:
BaseModelShow JSON schema
{ "title": "Params", "type": "object", "properties": { "filetype": { "default": "panalytical.csv", "enum": [ "panalytical.xy", "panalytical.csv", "panalytical.xrdml" ], "title": "Filetype", "type": "string" } }, "additionalProperties": false }
- Config:
extra: str = forbid
- field filetype: Literal['panalytical.xy', 'panalytical.csv', 'panalytical.xrdml'] = 'panalytical.csv'
- field parser: Literal['xrdtrace'] [Required]
- field tag: str | None = None
- field externaldate: ExternalDate | None = None
dgbowl_schemas.yadg.dataschema_4_2.timestamp module
- pydantic model dgbowl_schemas.yadg.dataschema_4_2.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_4_2.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_4_2.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_4_2.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