File Exchange

image thumbnail

EnergyPlus co-simulation toolbox

version 1.0.3 (5.67 MB) by Jiri Dostal
Simulate EnergyPlus models together with Matlab/Simulink.

9 Downloads

Updated 11 Oct 2018

View License on GitHub

Description
---------------
The toolbox facilitates simultaneous simulation of EnergyPlus and Matlab (co-simulation). The main component is the mlep class containing all the necessary tools to configure and run EnergyPlus co-simulation within the Matlab environment.

System Requirements
-----------------------------
* Windows. The toolbox has only been tested for Windows, but considerable preparations for other OS has already been done.
* EnergyPlus installed. You can obtain the software here https://energyplus.net/. If you install the EnergyPlus to the default location ('C:\EnergyPlusVx-x-x') then it might be detected automatically by the toolbox. Please note, that you should always simulate IDF files by the same version of the EnergyPlus with which they were created or you can alternatively upgrade the IDF file by the IDFVersionUpdater (located under 'C:\EnergyPlusVx-x-x\PreProcess\IDFVersionUpdater').

Install
--------
* Download and install the toolbox binary from https://github.com/dostaji4/EnergyPlus-co-simulation-toolbox/releases.
* If you are installing the toolbox manually, make sure to add the toolbox directory (with subdirectories) to your Matlab search path.

Features
-----------
The toolbox contains:

* Parsing of the IDF file to determine co-simulation inputs/outputs.
* Automatic socket communication configuration (on localhost).
* Background start of the EnergyPlus process with output to the Matlab command line.
* System Object implementation usable in Matlab & Simulink.
* Bus input/output integration for easy Simulink model setup.
* A 'mlep Bus Creator' block to facilitate Simulink co-simulation input setup.

Examples
-------------
See the GettingStarted.mlx guide delivered with the Matlab toolbox or the documentation residing under Help -> Supplemental Software -> EnergyPlus co-simulation toolbox

For detailed Matlab example see

>> open mlepMatlab_example

Usage of the System Object functionality in Matlab is demonstrated in

>> open mlepMatlab_so_example

Simulink example is provided in

>> open mlepSimulink_example.slx

Copyright (C) 2018, Jiri Dostal (jiri.dostal@cvut.cz)
All rights reserved.

This software builds on the free software by Truong Nghiem(truong@seas.upenn.edu), Willy Bernal (Willy.BernalHeredia@nrel.gov) and several other third-party open-source tools.

Cite As

Jiri Dostal (2018). EnergyPlus co-simulation toolbox (https://www.github.com/dostaji4/EnergyPlus-co-simulation-toolbox), GitHub. Retrieved .

Comments and Ratings (0)

Updates

1.0.3

Adding the binary to the repository code. Hopefully, the Matlab Add-on Explorer will detect it now.

1.0.2

Adding further info. Mainly for manual toolbox installation (The binary is obtainable at GitHub)

MATLAB Release Compatibility
Created with R2018a
Compatible with R2017a to any release
Platform Compatibility
Windows macOS Linux

Discover Live Editor

Create scripts with code, output, and formatted text in a single executable document.


Learn About Live Editor