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

Revision history [back]

To create a new measure:

  1. Set your My Measures directory
  • Preferences > Change My Measures Directory
  1. Create a new measure from the Measure tab
  • Measures > Library
  1. Name the measure

  2. Describe the measure (optional)

  3. Choose the appropriate measure type and taxonomy

  4. Create measure and open for editing

The measure folder contains the measure.rb file, which contains the measure code, and the measure.xml, which contains the measure meta data that is updated automatically when the RB file is changed.

Open the measure.rb file and start editing it to write your measure or if you've already created a measure outside of OS/PAT, paste in the code and save.

If the measure is an OpenStudio measure, it can be tested in OS using the Apply Measure Now feature. If it's an EnergyPlus measure or Reporting measure, it can be tested by attaching it to the model as an Always Run Measure. Alternatively, OpenStudio's API can be used to test measure snippets from a command line/terminal (see the Optional - Install Ruby instructions).

To create a new measure:

  1. Set your My Measures directory

  • Preferences > Change My Measures Directory
  1. Create a new measure from the Measure tab

  • Measures > Library
  1. Name the measure

  2. Describe the measure (optional)

  3. Choose the appropriate measure type and taxonomy

  4. Create measure and open for editing

The measure folder contains the measure.rb file, which contains the measure code, and the measure.xml, which contains the measure meta data that is updated automatically when the RB file is changed.

Open the measure.rb file and start editing it to write your measure or if you've already created a measure outside of OS/PAT, paste in the code and save.

If the measure is an OpenStudio measure, it can be tested in OS using the Apply Measure Now feature. If it's an EnergyPlus measure or Reporting measure, it can be tested by attaching it to the model as an Always Run Measure. Alternatively, OpenStudio's API can be used to test measure snippets from a command line/terminal (see the Optional - Install Ruby instructions).