fre.yamltools.abstract_classes module

Abstract base classes to provide scaffolding of yaml combining process for classes that inherit them.

class fre.yamltools.abstract_classes.MergeCompileYamls

Bases: ABC

Scaffolding for merging compile yamls; inherited by compile_info_parser

abstractmethod combine_compile()

Function that will combine compile yaml information with output yaml str from combine_model

abstractmethod combine_model()

Function that will combine model yaml information with passed click options name, platform, and target

abstractmethod combine_platforms()

Function that will combine platform yaml information with output yaml str from combine_compile

class fre.yamltools.abstract_classes.MergePPANYamls

Bases: ABC

Scaffolding for merging pp and analysis yamls; inherited by pp_info_parser and analysis_info_parser

abstractmethod combine_model()

Function that will combine model yaml information with passed click options name, platform, and target

abstractmethod combine_settings(yaml_content_str)

Function that will combine settings yaml information with output yaml str from combine_model

abstractmethod combine_yamls()

Function that will combine output yaml str (from merging the model and settings yaml) with pp/experiment yaml information

abstractmethod merge_multiple_yamls()

Function that will merge multiple yaml dictionaries to produce final combined yaml of information