Extensibility Resources
Extensibility Tools and API User Guide
This guide explains how users and developers can customise and extend DesignBuilder’s functionality through scripts and plugins. It covers the use of the DesignBuilder API to access and manipulate building models, simulation processes, and data tables. The guide details how to write and enable scripts in C# or Python, implement hook points during simulations, and develop more advanced plugins that can add dynamic menus and integrate external libraries. Additionally, it provides information on working with model attributes, database tables, and geometry extraction, offering a complete framework for creating tailored workflows and automating tasks within DesignBuilder.
API Reference and GitHub Repository
Extensibility uses the DesignBuilder API. The API reference provides a complete catalogue of classes, methods, properties, and enumerations that developers can use to interact with DesignBuilder’s core functionality. It explains how to access model objects, manipulate attributes, subscribe to events, and leverage simulation hook points. By using this reference, you can confidently extend DesignBuilder to integrate external tools, perform bespoke calculations, and tailor the software to meet specific project requirements.
Our GitHub repository provides a comprehensive collection of practical examples for DesignBuilder extensibility. It includes Python scripts, C# plugin templates, and utility functions that demonstrate how to interact with the DesignBuilder API. These examples cover common tasks such as automating parametric studies, generating custom reports, and extending HVAC system controls.
API Reference Library DesignBuilder GitHub
DesignBuilder XML (dsbXML) Format Guide
The guide explains how to export and import models in XML, details the schema structure, object hierarchy and geometry definitions, and provides best practices for interoperability with third-party tools. You’ll learn how to include library data for self-contained packages, validate against the official schema, and even generate models programmatically for integration with other applications. In addition, the guide covers advanced topics such as HVAC networks, loops, and components, equipping you to create, edit, and manage XML files effectively.