-
Notifications
You must be signed in to change notification settings - Fork 11
Installation
This guide provides installation instructions for the Campus Energy Modeling library.
The Campus Energy Modeling library requires only MATLAB and Simulink 8.1 (R2013a) or newer.
However, to take advantage of the library's interfaces to other modeling tools, you must also have those tools installed:
- SimPowerSystems for modeling electrical power systems
- EnergyPlus and MLE+ for modeling buildings and thermal equipment
- SAM Simulation Core (SSC) for modeling photovoltaic arrays
Each block in the library which requires one of these additional modeling tools clearly identifies its dependencies in the block help.
With the exception of MLE+, all external modeling tools must be installed and configured separately according to their installation instructions. (The project currently includes a customized version of MLE+ that may be installed automatically; see Installation.) If you intend to use the library for HIL simulation or with DataBus, see also Advanced Configuration.
The current library release is compatible with the following software versions:
| Software | Version | Comments |
|---|---|---|
| EnergyPlus | 8.0 | Update to 8.1 expected soon |
| MATLAB | 8.1 (R2013a) | |
| MLE+ | - | Use the MLE+ build supplied with the library |
| SimPowerSystems | 5.8 (R2013a) | |
| Simulink | 8.1 (R2013a) | |
| SSC | 2013-9-20 |
Other software versions may also work, but have not been thoroughly tested.
Be aware that MLE+ and SSC each have their own dependencies.
For MLE+, a compatible version of Java must be installed. MLE+ for Campus Enering Modeling has been tested successfully with the following Java versions:
- Java 6 Update 45
- Java 7 Update 21
- Java 7 Update 45
Of these, we recommend using Java 6 because Java 7 causes MLE+ to report an obscure but annoying warning regarding non-serializable socket ports. Note that the MLE+ Java version may be different than the default Java version running on the machine because MLE+ specifies an absolute path to the Java runtime environment. Java 6 is still available from the Java Archive.
In order for the SSC library to load, a MEX-compatible compiler must be installed. Mathworks maintains a list of supported compilers. After installing the compiler of your choice, run mex -setup from the MATLAB command line to configure it for MEX.
- Download the latest release or clone the GitHub repository (see Using Git).
- Extract all project files to the directory of your choice, for instance,
C:\CampusEnergyModeling\. - Open MATLAB and change the working directory to the project root. The root directory contains the
READMEandinstall.mfiles. - If installing MLE+, edit
install.mto specify the Java and EnergyPlus directories per the instructions in the script. - Run
install.min MATLAB.
The install.m installation script will automatically add the Campus Energy Modeling library directories to the MATLAB path. After installing the library, we suggest reading Getting Started.
This section is intended for users who require HIL simulation or interaction with DataBus.
The Campus Energy Modeling project includes utility functions for accessing NREL's DataBus database. By default, the these functions are configured for internal NREL access.
There is no access to NREL's internal DataBus database from outside NREL. However, the same utility functions may be used to access other DataBus installations in one of two ways:
- The user may pass a different DataBus URL and credentials to the DataBus utility functions via the function calls. See the documentation for the
importDataBus()utility function for details. - The user may manually edit
importDataBus.mlines 135-137 to specify a different default DataBus URL and credentials.
Note: the DataBus database is no longer actively developed within NREL and may not be supported in the future. Therefore, these functions are now deprecated.
For information regarding the use of the Campus Energy Modeling library with HIL simulation, please see Hardware in Loop.