Extensibility

DesignBuilder may be extended via scripts or plugins. Each system is targeted at a different use-case and different levels of complexity. Both systems may be used at the same time, and multiple active plugins and scripts are supported.

• Scripts are intended to hook into certain stages of a DesignBuilder simulation in order to modify or report on the process.
• Plugins are a superset of Scripts, providing extra functionality such as the ability to create a custom sub-menu in DesignBuilder’s main-menu, which may allow for ad-hoc processing of DesignBuilder data.

Scripts can be written in the C# or Python programming languages. Plugins are written in the C# programming language.

In general scripts are used where a quick solution is required and it is acceptable for the program to control the calling at key hook points. Plugins on the other hand are more appropriate for larger customisation projects where the code is pre-compiled and can be executed under user control if necessary.

The Extensibility Tools User Guide is the main source of help for scripts, plugin development and the API.

Scripting

DesignBuilder provides 3 different sets of scripting tools to help more expert users customise their simulations and generate special reports.

• Energy Management System (EMS) - powerful set of EnergyPlus runtime scripting tools to help you write portable code to customise EnergyPlus' simulation behaviour.
• CS-Script - where standard C# code can be executed, typically before and after simulations, to modify the default IDF generated by DesignBuilder, access the DesignBuilder model input and output data to produce custom reports.
• Python - set of tools which allow Python code to be executed at key hook points, typically before and after simulations like CS-Script, to modify the default IDF generated by DesignBuilder through the eppy scripting tool, or for post-processing of results for custom reporting etc.

The Scripting tools can be accessed from the Scripts toolbar icon and also from the Tools > Scripts menu option which opens the Script Manager dialog. More details on how to use the scripting tools can be found in the help topics on each type of script.

Note: The 3 types of script can also be used to develop Custom EMS, Custom IDF and Custom Script design variables.

Plugins

Plugins are capable of all of the capabilities of CS-Script scripts but they also allow custom sub-menus to be added to the main DesignBuilder menu allowing general processing of DesignBuilder models and results. They generally are a more appropriate approach for developing larger projects where source code can be compiled into a dll. For example if developing a new code compliance module that required an in-depth processing of the DesignBuilder model and results then this should normally be implemented as a plugin.