polaris.yaml.PolarisYaml.read

classmethod PolarisYaml.read(filename, package=None, replacements=None, model=None, streams_section='streams')

Add config options from a yaml file

Parameters:

• filename (str) – A template yaml config file

• package (str, optional) – The name of a package the filename is found in

• replacements (dict, optional) – A dictionary of replacements, which, if provided, is used to replace Jinja variables and the yaml file is assumed do be a Jinja template

• model (str, optional) – The name of the model to parse if the yaml file might have multiple models

• streams_section (str, optional) – The name of the streams section

Returns:

yaml (polaris.yaml.PolarisYaml) – A yaml object read in from the given file (and optionally package)