components.pipeline

Module Contents

Classes

Pipeline

This object represents a pipeline

class components.pipeline.Pipeline(name)

Bases: Storage

This object represents a pipeline

This name of pipeline should contain the following information:

<measured/derived>/<capa>/<raw/scaled>

Parameters

name (str) – the name of the pipeline

Examples

pipeline1 = Pipeline(‘measured/capa1/raw’)

pipeline1.attrs[‘variable’] = ‘voltage’

pipeline1.attrs[‘units’] = ‘volts’

pipeline1.attrs[‘origin’] = ‘this’

pipeline.add([dataset1, dataset2])

pipeline.add([instrument1, insturment2])

add(self, list_obj)

add (multi) dataset(s) and instrument(s) into model

Parameters

list_obj (List[Instrument | Dataset]) – a list of Instrument or Dataset object(s)

Raises
  • TypeError – raised when the element of list_obj is not the type of Instrument or Dataset

  • AssertionError – raised when list_obj is not a list or it is empty