polaris.yaml.PolarisYaml

class polaris.yaml.PolarisYaml[source]

A class for reading writing and combining config files in yaml format (e.g. as used in OMEGA).

Variables:

  • configs (dict) – Nested dictionaries containing config options

  • streams (dict) – Nested dictionaries containing data about streams

  • model (str) – The name of the E3SM component

__init__()[source]

Create a yaml config object

Methods

__init__()

Create a yaml config object

read(filename[, package, replacements])

Add config options from a yaml file

update(configs[, quiet])

Add config options from a dictionary

write(filename)

Write config options to a yaml file