dgbowl_schemas.yadg.dataschema_4_1 package

Bases: BaseModel

metadata: Metadata

steps: Sequence[Dummy | BasicCSV | MeasCSV | FlowData | ElectroChem | ChromTrace | MassTrace | QFTrace | XPSTrace | XRDTrace]

update()

Submodules

dgbowl_schemas.yadg.dataschema_4_1.externaldate module

class dgbowl_schemas.yadg.dataschema_4_1.externaldate.ExternalDateFile(*, file: Content)

Bases: BaseModel

class Content(*, path: str, type: str, match: str | None = None)

Bases: BaseModel

path: str

type: str

match: str | None

file: Content

class dgbowl_schemas.yadg.dataschema_4_1.externaldate.ExternalDateFilename(*, filename: Content)

Bases: BaseModel

class Content(*, format: str, len: int)

Bases: BaseModel

format: str

len: int

filename: Content

class dgbowl_schemas.yadg.dataschema_4_1.externaldate.ExternalDateISOString(*, isostring: str)

Bases: BaseModel

isostring: str

class dgbowl_schemas.yadg.dataschema_4_1.externaldate.ExternalDateUTSOffset(*, utsoffset: float)

Bases: BaseModel

utsoffset: float

class dgbowl_schemas.yadg.dataschema_4_1.externaldate.ExternalDate(*, using: ExternalDateFile | ExternalDateFilename | ExternalDateISOString | ExternalDateUTSOffset, mode: Literal['add', 'replace'] = 'add')

Bases: BaseModel

using: ExternalDateFile | ExternalDateFilename | ExternalDateISOString | ExternalDateUTSOffset

mode: Literal['add', 'replace']

dgbowl_schemas.yadg.dataschema_4_1.input module

class dgbowl_schemas.yadg.dataschema_4_1.input.Input(*, folders: Sequence[str], prefix: str | None = None, suffix: str | None = None, contains: str | None = None, exclude: str | None = None, encoding: str = 'UTF-8')

Bases: BaseModel

files: Sequence[str]

prefix: str | None

suffix: str | None

contains: str | None

exclude: str | None

encoding: str

paths() → List[str]

dgbowl_schemas.yadg.dataschema_4_1.metadata module

class dgbowl_schemas.yadg.dataschema_4_1.metadata.Metadata(*, provenance: Provenance, version: Literal['4.1', '4.1.0', '4.1.1', '4.1.2', '4.1.3'], timezone: str = 'localtime')

Bases: BaseModel

class Provenance(*, type: str, metadata: Mapping[str, Any] | None = None)

Bases: BaseModel

type: str

metadata: Mapping[str, Any] | None

provenance: Provenance

version: Literal['4.1', '4.1.0', '4.1.1', '4.1.2', '4.1.3']

timezone: str

dgbowl_schemas.yadg.dataschema_4_1.parameters module

class dgbowl_schemas.yadg.dataschema_4_1.parameters.Tol(*, atol: float | None = None, rtol: float | None = None)

Bases: BaseModel

atol: float | None

rtol: float | None

dgbowl_schemas.yadg.dataschema_4_1.step module

class dgbowl_schemas.yadg.dataschema_4_1.step.Dummy(*, parser: Literal['dummy'], input: Input, parameters: Params | None = None, tag: str | None = None, externaldate: ExternalDate | None = None)

Bases: BaseModel

class Params(**extra_data: Any): Bases: BaseModel

parser: Literal['dummy']

input: Input

parameters: Params | None

tag: str | None

externaldate: ExternalDate | None

class dgbowl_schemas.yadg.dataschema_4_1.step.BasicCSV(*, parser: Literal['basiccsv'], input: Input, parameters: Params = None, tag: str | None = None, externaldate: ExternalDate | None = None)

Bases: BaseModel

Bases: BaseModel

sep: str

sigma: Mapping[str, Tol] | None

calfile: str | None

timestamp: Timestamp | TimeDate | UTS | None

convert: Any | None

units: Mapping[str, str] | None

parser: Literal['basiccsv']

input: Input

parameters: Params

tag: str | None

externaldate: ExternalDate | None

class dgbowl_schemas.yadg.dataschema_4_1.step.MeasCSV(*, parser: Literal['meascsv'], input: Input, parameters: Params = None, tag: str | None = None, externaldate: ExternalDate | None = None)

Bases: BaseModel

class Params(*, timestamp: Timestamp | TimeDate | UTS = Timestamp(timestamp=TimestampSpec(index=0, format='%Y-%m-%d-%H-%M-%S')), calfile: str | None = None, convert: Any | None = None)

Bases: BaseModel

timestamp: Timestamp | TimeDate | UTS

calfile: str | None

convert: Any | None

parser: Literal['meascsv']

input: Input

parameters: Params

tag: str | None

externaldate: ExternalDate | None

class dgbowl_schemas.yadg.dataschema_4_1.step.FlowData(*, parser: Literal['flowdata'], input: Input, parameters: Params = None, tag: str | None = None, externaldate: ExternalDate | None = None)

Bases: BaseModel

class Params(*, filetype: Literal['drycal.csv', 'drycal.rtf', 'drycal.txt'] = 'drycal.csv', convert: Any | None = None, calfile: str | None = None)

Bases: BaseModel

filetype: Literal['drycal.csv', 'drycal.rtf', 'drycal.txt']

convert: Any | None

calfile: str | None

parser: Literal['flowdata']

input: Input

parameters: Params

tag: str | None

externaldate: ExternalDate | None

class dgbowl_schemas.yadg.dataschema_4_1.step.ElectroChem(*, parser: Literal['electrochem'], input: Input, parameters: Params = None, tag: str | None = None, externaldate: ExternalDate | None = None)

Bases: BaseModel

class Params(*, filetype: Literal['eclab.mpt', 'eclab.mpr', 'tomato.json'] = 'eclab.mpr')

Bases: BaseModel

filetype: Literal['eclab.mpt', 'eclab.mpr', 'tomato.json']

class Input(*, folders: Sequence[str], prefix: str | None = None, suffix: str | None = None, contains: str | None = None, exclude: str | None = None, encoding: str = 'windows-1252')

Bases: Input

encoding: str

parser: Literal['electrochem']

input: Input

parameters: Params

tag: str | None

externaldate: ExternalDate | None

class dgbowl_schemas.yadg.dataschema_4_1.step.ChromTrace(*, parser: Literal['chromtrace'], input: Input, parameters: Params = None, tag: str | None = None, externaldate: ExternalDate | None = None)

Bases: BaseModel

class Params(*, filetype: Literal['ezchrom.asc', 'fusion.json', 'fusion.zip', 'agilent.ch', 'agilent.dx', 'agilent.csv'] = 'ezchrom.asc', calfile: str | None = None, species: Any | None = None, detectors: Any | None = None)

Bases: BaseModel

filetype: Literal['ezchrom.asc', 'fusion.json', 'fusion.zip', 'agilent.ch', 'agilent.dx', 'agilent.csv']

calfile: str | None

species: Any | None

detectors: Any | None

parser: Literal['chromtrace']

input: Input

parameters: Params

tag: str | None

externaldate: ExternalDate | None

class dgbowl_schemas.yadg.dataschema_4_1.step.MassTrace(*, parser: Literal['masstrace'], input: Input, parameters: Params = None, tag: str | None = None, externaldate: ExternalDate | None = None)

Bases: BaseModel

class Params(*, filetype: Literal['quadstar.sac'] = 'quadstar.sac')

Bases: BaseModel

filetype: Literal['quadstar.sac']

parser: Literal['masstrace']

input: Input

parameters: Params

tag: str | None

externaldate: ExternalDate | None

class dgbowl_schemas.yadg.dataschema_4_1.step.QFTrace(*, parser: Literal['qftrace'], input: Input, parameters: Params = None, tag: str | None = None, externaldate: ExternalDate | None = None)

Bases: BaseModel

class Params(*, filetype: Literal['labview.csv'] = 'labview.csv', method: Literal['naive', 'lorentz', 'kajfez'] = 'kajfez', height: float = 1.0, distance: float = 5000.0, cutoff: float = 0.4, threshold: float = 1e-06)

Bases: BaseModel

filetype: Literal['labview.csv']

method: Literal['naive', 'lorentz', 'kajfez']

height: float

distance: float

cutoff: float

threshold: float

parser: Literal['qftrace']

input: Input

parameters: Params

tag: str | None

externaldate: ExternalDate | None

class dgbowl_schemas.yadg.dataschema_4_1.step.XPSTrace(*, parser: Literal['xpstrace'], input: Input, parameters: Params = None, tag: str | None = None, externaldate: ExternalDate | None = None)

Bases: BaseModel

class Params(*, filetype: Literal['phi.spe'] = 'phi.spe')

Bases: BaseModel

filetype: Literal['phi.spe']

parser: Literal['xpstrace']

input: Input

parameters: Params

tag: str | None

externaldate: ExternalDate | None

class dgbowl_schemas.yadg.dataschema_4_1.step.XRDTrace(*, parser: Literal['xrdtrace'], input: Input, parameters: Params = None, tag: str | None = None, externaldate: ExternalDate | None = None)

Bases: BaseModel

class Params(*, filetype: Literal['panalytical.xy', 'panalytical.csv', 'panalytical.xrdml'] = 'panalytical.csv')

Bases: BaseModel

filetype: Literal['panalytical.xy', 'panalytical.csv', 'panalytical.xrdml']

parser: Literal['xrdtrace']

input: Input

parameters: Params

tag: str | None

externaldate: ExternalDate | None

dgbowl_schemas.yadg.dataschema_4_1.timestamp module

class dgbowl_schemas.yadg.dataschema_4_1.timestamp.TimestampSpec(*, index: int | None = None, format: str | None = None)

Bases: BaseModel

index: int | None

format: str | None

class dgbowl_schemas.yadg.dataschema_4_1.timestamp.Timestamp(*, timestamp: TimestampSpec)

Bases: BaseModel

timestamp: TimestampSpec

class dgbowl_schemas.yadg.dataschema_4_1.timestamp.UTS(*, uts: TimestampSpec)

Bases: BaseModel

uts: TimestampSpec

class dgbowl_schemas.yadg.dataschema_4_1.timestamp.TimeDate(*, date: TimestampSpec | None = None, time: TimestampSpec | None = None)

Bases: BaseModel

date: TimestampSpec | None

time: TimestampSpec | None