fre.yamltools.combine_yamls module

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

fre.yamltools.combine_yamls.combined_compile_existcheck(combined, yml, platform, target)

Checks for if combined compile yaml exists already. If not, combine model, compile, and platform yamls.

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.get_combined_compileyaml(comb)

Combine the model, compile, and platform yamls Arguments:

• comb : combined yaml object

fre.yamltools.combine_yamls.get_combined_ppyaml(comb)

Combine the model, experiment, and analysis yamls Arguments:

• comb : combined yaml object

fre.yamltools.combine_yamls.get_compile_paths(mainyaml_dir, comb)

Extract compile and platform paths from model yaml

class fre.yamltools.combine_yamls.init_compile_yaml(yamlfile, platform, target)

Bases: object

clean_yaml()

Clean the yaml; remove unnecessary sections in final combined yaml.

combine_compile()

Combine compile yaml with the defined combined.yaml

combine_model()

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

combine_platforms()

Combine platforms yaml with the defined combined.yaml

class fre.yamltools.combine_yamls.init_pp_yaml(yamlfile, experiment, platform, target)

Bases: object

clean_yaml()

Clean the yaml; remove unnecessary sections in final combined yaml.

combine_analysis()

Combine analysis yamls with the defined combined.yaml

combine_experiment()

Combine experiment yamls with the defined combined.yaml

combine_model()

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

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

Allows FRE properties defined in main yaml to be concatenated.

fre.yamltools.combine_yamls.yaml_load(yamlfile)

Load the yamlfile