polaris.streams.read

polaris.streams.read(package, streams_filename, tree=None, replacements=None)[source]

Parse the given streams file

Parameters:

package (Package) – The package name or module object that contains the streams file
streams_filename (str) – The name of the streams file to read from
tree (lxml.etree, optional) – An existing set of streams to add to or modify
replacements (dict, optional) – A dictionary of replacements, in which case streams_filename is assumed to be a Jinja2 template to be rendered with these replacements

Returns:

tree (lxml.etree) – A tree of XML data describing MPAS i/o streams with the content from the given streams file