JEPlus – A Java shell of EnergyPlus for parametric runs
Announcement: New version (ver. 0.5b) of jEPlus is now available! - Multi-thread bug fixed: jEPlus stops after 2 jobs if the number of threads is 3 or higher (10/12/2009, thanks to Tobias who spotted it)
Introduction
Parametric analysis is often needed for exploring design options, especially when a global optimization method is not available, or the optimization result is in doubt. Parametric analysis can also be applied to all design variables simultaneously, which forms an exhaustive search that, providing that the search grid is fine enough, will guarantee a global optimum solution. In order to perform complex parametric analyses on multiple parameters with more than a handful of alternative values each, a tool to generate commands for the simulation model to run, and to collect results afterwards will be needed. jEPlus has been developed as such a parametric tool for EnergyPlus. The main features include:
- Complete GUI provide utilities for setting up parametric runs with EnergyPlus
- Unique parameter tree for defining dependency between parameter
- Flexible syntax of specifying alternative values
- Supports multi-processor/multi-core systems by threading
- Supports Windows/Mac/Linux versions of E+
- In-built IDF editor supports basic syntax highlighting and search
- Support for EP-Macro and HVACTemplate objects (since version 0.5)
- Simulation results are collected in CSV format (using ReadVarsESO) with index files
- Generate SQL script for importing indices and E+ execution information in to databases (since version 0.5)
Disclaimer
This software is provided by Dr Yi Zhang free of charge for non-commercial use. It is proved on the basis of “as is”. Any express or implied warranties, including, but not limited to, the implied warranties of merchantability and fitness for a particular purpose are disclaimed. In no event shall Dr Yi Zhang, his employer, or the hosting service provider of this webpage be liable for any direct, indirect, incidental, special, exemplary, or consequential damages, (including, but not limited to, procurement of substitute goods or services; loss of use, data, or profits; or business interruption) however caused and on any theory of liability, whether in contract, strict liability, or tort (including negligence or otherwise) arising in any way out of the use of this software.
The use of the software downloaded from this webpage is done at your own discretion and risk and with agreement of the foregoing disclaimer.
How to get it:
The latest release of jEPlus (Java shell of EnergyPlus, version 0.5 release notes) is available to download. You are warmly welcome to try it, and leave me some feedback. To get started, you will need:
- A computer supports EnergyPlus and Java J2SE6.0
- The latest Java Runtime Environment (JRE, download it from java.sun.com)
- EnergyPlus, preferably installed with the default settings
Instructions on how to use jEPlus is boundled in the distribution pack. The users manual is also available online.
References:
Zhang, Y. (2009) “‘Parallel’ EnergyPlus and the development of a parametric analysis tool”, IBPSA BS2009, 27–30 July 2009, Glasgow, UK pdf
See also:
- jCFX5 - the Java shell for Ansys CFX (version 5 and above)
- Psychrometric Calculator - A pocket psychrometric calculator (run on your mobile phone) for HVAC engineers
- PMV/PPD Calculator - this mobile phone utility calculate ISO7730 PMV/PPD for the given conditions
Discussion
Dear Dr Yi Zhang,
I'm having difficulty with processing the results of jEPlus. Even if I use one of the example .obj files I still only get the following files; IndexIDF.csv, IndexJobs.csv, IndexPAR1.csv, IndexPAR2.csv, and IndexWthr.csv. When I look at IndexJobs.csv it says that results are false. Also, when I click 'Start Simulation' in jEPlus, it starts the batch, completes the jobs, but then says Starting result collection … and stays that way indefinitely. Am I doing something wrong?
Thanks, Alex Chapin
Dear Alex,
Thanks for trying the tool. I had to admit that it has not been thoroughly tested; so there are quite a few glitches in the GUI. “Starting result collection …” never ends is one of them. And the results column in IndexJobs.csv is a feature yet to be implemented
Except these, you should have got some results after “start simulation”. Could you check the directory in which you are running jEPlus? There should be a file called “ScreenOut.txt” that contains reports from EnergyPlus. You can check whether there are any error messages. You shall also see a few new directories named “G_?-T_?-W_?-…”, which contains all EnergyPlus inputs/outputs related to the particular job. The result from each job is stored in a CSV file with similar name patterns, e.g. “G_0-T_0-W_0-PAR1_0.csv”. If you cannot find this file, EnergyPlus has probably failed to run the model, in which case you shall find some error messages in either “ScreenOut.txt” or in the .err files in the job directory.
If this doesn't help, I'll need to know more of your settings.
Cheers,
Yi
Thank you Dr Zhang, I study EnergyPlus in Côte d'Ivoire and I wish JEPlus could help me.
Dear Dr. Yi,
I had some similar problem than Alex had. After I copied the extracted jEplus folder to C:\jeplus (what is default in the Prog) it somehow worked.
May be that helps…
Thanks for the nice Tool
Best from Istanbul, Tobias