fre.yamltools.combine_yamls module

Script combines the model yaml with the compile, platform, and experiment yamls.

fre.yamltools.combine_yamls.combine_analysis(comb_mcpe, analysisyaml)

Combine analysis yamls with the defined combined.yaml Arguments:

comb_mcpe : combined model, compile, platforms, and experiment yaml file analysisyaml : analysis yaml file

fre.yamltools.combine_yamls.combine_compile(comb_m, compileyaml)

Combine compile yaml with the defined combined.yaml Arguments:

comb_m : combined model yaml file compileyaml : compile yaml file

fre.yamltools.combine_yamls.combine_experiments(comb_mcp, expyaml)

Combine experiment yamls with the defined combined.yaml Arguments:

comb_mcp : combined model, compile, and platforms yaml file expyaml : experiment yaml files

fre.yamltools.combine_yamls.combine_model(modelyaml, combined, experiment, platform, target)

Create the combined.yaml and merge it with the model yaml Arguments:

modelyaml : model yaml file combined : final combined file name experiment : experiment name platform : platform used target : targets used

fre.yamltools.combine_yamls.combine_platforms(comb_mc, platformsyaml)

Combine platforms yaml with the defined combined.yaml Arguments:

comb_mc : combined model and compile yaml file platformsyaml : platforms yaml file

fre.yamltools.combine_yamls.experiment_check(mainyaml_dir, comb, experiment)

Check that the experiment given is an experiment listed in the model yaml. Extract experiment specific information and file paths. Arguments:

mainyaml_dir : model yaml file comb : combined yaml file name experiment : experiment name

fre.yamltools.combine_yamls.join_constructor(loader, node)

Allows FRE properties defined in main yaml to be concatenated.

fre.yamltools.combine_yamls.validate_yaml(file)

Using the schema.json file, the yaml format is validated. Arguments:

file : combined yaml file

fre.yamltools.combine_yamls.yaml_load(yamlfile)

Load the yamlfile