Question-and-Answer Resource for the Building Energy Modeling Community
Get started with the Help page
Ask Your Question
3

BeOpt calculations through API

asked 2024-12-20 18:08:06 -0600

simple's avatar

Hello!

Is there a way to use the BeOpt interface through an API call? For example, input is simplified to json key:value pairs and some input geometry? This could be either through a URL call or even through the local copy?

Thanks!

edit retag flag offensive close merge delete

1 Answer

Sort by ยป oldest newest most voted
2

answered 2024-12-23 10:22:07 -0600

There is no way to automate the BEopt user interface. But BEopt sits on top of OpenStudio-HPXML for the energy simulation and it is intended to be automated. There are many ways to automate the creation of HPXML files, but one of them is to use OpenStudio-HPXML's BuildResidentialHPXML measure, which has simplified geometry inputs (number of stories, floor area, aspect ratio, garage, etc.). OpenStudio-HPXML can be run using an OpenStudio Workflow (OSW) file, which is a JSON file.

Here's an example OSW file that:

  1. Creates an HPXML file from key:value pairs
  2. Adds stochastic occupancy schedules (optional)
  3. Translates the HPXML to OpenStudio and runs it
  4. Reports summary simulation outputs
  5. Reports utility bills (optional)
edit flag offensive delete link more

Comments

This is perfect, thank you so much!

Is the Tools > Generate HPXML function in BeOpt the same HPXML that you are referring to above? That is, I could export a given HPXML from BeOpt and tweak it as needed and then run it through OpenStudio?

simple's avatar simple  ( 2024-12-23 15:07:05 -0600 )edit

That is correct! But you need to be careful about versions. If you generate an HPXML file via BEopt, you may want to use the version of OpenStudio-HPXML that is bundled with it; see C:\Program Files (x86)\NREL\BEopt_3.0.1\Include\OpenStudio-HPXML. If you wanted to use the latest OpenStudio-HPXML, it would require several changes to the HPXML file. (Hopefully in the near future we will have a new BEopt release that updates to use the latest OpenStudio-HPXML.)

shorowit's avatar shorowit  ( 2024-12-23 15:14:05 -0600 )edit

This is good to know. I will dig more into the docs you sent to better understand the version differences. It seems like I should just be able to take a "new" HPXML file and paste in desired fields from the BeOpt generated HPXML.

Appreciate your help :)

simple's avatar simple  ( 2024-12-23 15:17:27 -0600 )edit

Your Answer

Please start posting anonymously - your entry will be published after you log in or create a new account.

Add Answer

Training Workshops

Careers

Question Tools

2 followers

Stats

Asked: 2024-12-20 18:08:06 -0600

Seen: 97 times

Last updated: Dec 23 '24