watts.Plugin#

class watts.Plugin(extra_inputs=None, show_stdout=False, show_stderr=False, unit_system='si')[source]#

Class defining the Plugin interface

Parameters:

  • extra_inputs (Optional[List[Union[str, bytes, PathLike]]]) – Extra (non-templated) input files

  • show_stdout (bool) – Whether to display output from stdout when \(run\) is called

  • show_stderr (bool) – Whether to display output from stderr when run() is called

  • unit_system ({'si', 'cgs'}) – Unit system to convert to when rendering input files

plugin_name#

Name of the plugin

Type:

str

unit_system#

Desired system of units for rendering templates

Type:

{‘si’, ‘cgs’}

Methods

postrun(params, exec_info)

rtype:

Results

prerun(params)

run()