GUI.pdsim_plugins module

class GUI.pdsim_plugins.PDSimPlugin[source]

Bases: object

This is the base class that represents plugins for the GUI

activate(event)[source]

Function to activate the plugin

collect_output_terms()[source]
get_script_chunks()[source]

Get the chunks for the script from the plugin

Return a dictionary of strings for the script, the keys that are allowed are:

  • pre_import (goes before all the standard imports)
  • post_import (goes after all the standard imports)
  • pre_build (goes at the very beginning of the build function)
  • pre_build_instantiation (goes right before instantiation of the PDSimCore subclass)
  • post_build_instantiation (goes right before instantiation of the PDSimCore subclass)
  • post_build (goes at the very end of the build function)
  • pre_run (goes at the beginning of the run function)
  • post_run (goes at the end of the run function)
  • plugin_injected_chunks (a dictionary of chunks that is passed to the InputToolBook.get_script_chunks() function
is_activated()[source]
post_process(simulation)[source]

Do any post-processing required of the data after the model has been run to completion

set_GUI(Main)[source]
should_enable()[source]

Pre-enabling code that determines whether the plugin should be enabled.

Can be overloaded in the derived class