postprocessor.core.processor.PostProcessorParameters

class PostProcessorParameters(targets={}, param_sets={}, outpaths={})

Bases: ParametersABC

Anthology of parameters used for postprocessing :merger: :picker: parameters for picker :processes: list processes:[objectives], ‘processes’ are defined in ./processes/

while objectives are relative or absolute paths to datasets. If relative paths the post-processed addresses are used. The order of processes matters.

Methods

from_yaml(source)	Returns instance from a yaml filename or stdin
to_dict([iterable])	Recursive function to return a nested dictionary of the attributes of the class instance.
to_yaml([path])	Returns a yaml stream of the attributes of the class instance.
update(name, new_value)	Update values recursively if name is a dictionary, replace data where existing found or add if not.

default
from_dict

Defines parameters as attributes

Methods

from_yaml(source)	Returns instance from a yaml filename or stdin
to_dict([iterable])	Recursive function to return a nested dictionary of the attributes of the class instance.
to_yaml([path])	Returns a yaml stream of the attributes of the class instance.
update(name, new_value)	Update values recursively if name is a dictionary, replace data where existing found or add if not.

default
from_dict

__init__(targets={}, param_sets={}, outpaths={})

Defines parameters as attributes

Methods

__init__([targets, param_sets, outpaths])	Defines parameters as attributes
default([kind])
from_dict(d)
from_yaml(source)	Returns instance from a yaml filename or stdin
to_dict([iterable])	Recursive function to return a nested dictionary of the attributes of the class instance.
to_yaml([path])	Returns a yaml stream of the attributes of the class instance.
update(name, new_value)	Update values recursively if name is a dictionary, replace data where existing found or add if not.

classmethod from_yaml(source)

Returns instance from a yaml filename or stdin

to_dict(iterable='null')

Recursive function to return a nested dictionary of the attributes of the class instance.

Return type

Dict

to_yaml(path=None)

Returns a yaml stream of the attributes of the class instance. If path is provided, the yaml stream is saved there.

Parameters

pathUnion[PosixPath, str]

Output path.

update(name, new_value)

Update values recursively if name is a dictionary, replace data where existing found or add if not. It warns against type changes.

If the existing structure under name is a dictionary, it looks for the first occurrence and modifies it accordingly.

If a leaf node that is to be changed is a collection, it adds the new elements.