Guide for Interface Developers — EnergyPlus 24.1

<< Prev | Table of Contents | Next >>

Interface Expectations[LINK]

The input-output interfaces may be combined into a single program or may be available separately. The following attributes are expected from these interfaces.

Input Interface Attributes[LINK]

The input interface agents will be expected to fulfill two main requirements:

  • Ability to produce the input file for the simulation.

  • Perform the consistency and value checks necessary to assure that the input file conforms to EnergyPlus requirements.

Additionally, the input interface agent might:

  • Ability to warn users about potential output file size. It is expected that the data files generated by the EnergyPlus program will be significantly larger than the output files from its parent programs. As a result, users may be unaware that selecting too many reports could lead to enormous output files. It is recommended that some sort of checking be done to alert users when the term of the simulation and the number of reports selected eclipse some reasonable file size limit.

  • Ability to perform parametric runs.

The method used by the input interface agent to accomplish these goals is left to the discretion of the interface developer.

Post-processing Interface Attributes[LINK]

The post-processing agents will be expected to fulfill the main requirement:

  • Ability to read all or selected output formats.

Additionally, a post-processing agent might:

  • Ability to combine and summarize data (average, peak, total, etc.) and produce the various text and graphical reports requested by the user.

  • Ability to handle multiple output files.

The method used by the post-processing agent to accomplish these goals is left to the discretion of the interface developer.