compass.Step.add_streams_file

Step.add_streams_file(package, streams, template_replacements=None, out_name=None, mode='forward')[source]

Add a streams file to the step to be parsed when generating a complete streams file if and when the step gets set up.

Parameters:

  • package (Package) – The package name or module object that contains the streams file

  • streams (str) – The name of the streams file to read from

  • template_replacements (dict, optional) – A dictionary of replacements, in which case streams must be a Jinja2 template to be rendered with these replacements

  • out_name (str, optional) – The name of the streams file to write out, streams.<core> by default

  • mode ({'init', 'forward'}, optional) – The mode that the model will run in