src.poem.PoemTemplate
=====================

.. py:module:: src.poem.PoemTemplate

.. autoapi-nested-parse::

   Created on April 1, 2024
   @author: wangc

   This module inherits from base Template class for Input Templates, which use an established input
   template as an accelerated way to write new RAVEN workflows.



Attributes
----------

.. autoapisummary::

   src.poem.PoemTemplate.logger


Classes
-------

.. autoapisummary::

   src.poem.PoemTemplate.PoemTemplate


Module Contents
---------------

.. py:data:: logger

.. py:class:: PoemTemplate

   Bases: :py:obj:`ravenframework.InputTemplates.TemplateBaseClass.Template`


   POEM: Template Class


   .. py:attribute:: _validEntities
      :value: ['RunInfo', 'Files', 'Models', 'Distributions', 'Samplers', 'Optimizers', 'DataObjects',...



   .. py:method:: loadTemplate(filename)

      Loads template file statefully.
      @ In, filename, str, name of file to load (xml)
      @ Out, None



   .. py:method:: createWorkflow(inputs, miscDict)

      creates a new RAVEN workflow based on the information in dicitonary "inputs".
      @ In, inputs, dict, dictionary that contains xml node info that need to append, i.e. {RavenXMLNodeTag: ListOfNodes}
      @ In, miscDict, dict, dictionary that contains xml node text info that need to update, i.e. {RavenXMLNodeTag: value}
      @ Out, xml.etree.ElementTree.Element, modified copy of template ready to run



   .. py:method:: writeWorkflow(template, destination, run=False)

      Writes a template to file.
      @ In, template, xml.etree.ElementTree.Element, file to write
      @ In, destination, str, path and filename to write to
      @ In, run, bool, optional, if True then run the workflow after writing? good idea?
      @ Out, errors, int, 0 if successfully wrote [and run] and nonzero if there was a problem



   .. py:method:: runWorkflow(destination)

      Runs the workflow at the destination.
      @ In, destination, str, path and filename of RAVEN input file
      @ Out, res, int, system results of running the code