Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
The table of contents is too big for display.
Diff view
Diff view
  •  
  •  
  •  
4 changes: 2 additions & 2 deletions sample_projects/Office_HVAC/Office_HVAC.json
Original file line number Diff line number Diff line change
Expand Up @@ -655,8 +655,8 @@
"display_name": "OpenStudio Results",
"measure_type": "ReportingMeasure",
"measure_definition_class_name": "OpenStudioResults",
"measure_definition_directory": "./measures/f8e23017-894d-4bdf-977f-37e3961e6f42",
"measure_definition_directory_local": "/Users/lbrackne/BCL/a25386cd-60e4-46bc-8b11-c755f379d916/f8e23017-894d-4bdf-977f-37e3961e6f42",
"measure_definition_directory": "./measures/5b4d387a-f537-4693-a9eb-6192957b6c1b",
"measure_definition_directory_local": "/Users/lbrackne/BCL/a25386cd-60e4-46bc-8b11-c755f379d916/5b4d387a-f537-4693-a9eb-6192957b6c1b",
"measure_definition_display_name": "OpenStudio Results",
"measure_definition_name": "openstudio_results",
"measure_definition_name_xml": null,
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
OpenStudio(R), Copyright (c) 2008, 2023 Alliance for Sustainable Energy, LLC.

Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:

1. Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.

2. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.

3. Redistribution of this software, without modification, must refer to the software by the same designation. Redistribution of a modified version of this software (i) may not refer to the modified version by the same designation, or by any confusingly similar designation, and (ii) must refer to the underlying software originally provided by Alliance as “OpenStudio®”. Except to comply with the foregoing, the term “OpenStudio®”, or any confusingly similar designation may not be used to refer to any modified version of this software or any modified version of the underlying software originally provided by Alliance without the prior written consent of Alliance.

4. The name of the copyright holder(s), any contributors, the United States Government, the United States Department of Energy, or any of their employees may not be used to endorse or promote products derived from this software without specific prior written permission from the respective party.

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDER(S) AND ANY CONTRIBUTORS "AS IS" AND 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 THE COPYRIGHT HOLDER(S), ANY CONTRIBUTORS, THE UNITED STATES GOVERNMENT, OR THE UNITED STATES DEPARTMENT OF ENERGY, NOR ANY OF THEIR EMPLOYEES, 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, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
Original file line number Diff line number Diff line change
@@ -0,0 +1,258 @@


###### (Automatically generated documentation)

# OpenStudio Results

## Description
This measure creates high level tables and charts pulling both from model inputs and EnergyPlus results. It has building level information as well as detail on space types, thermal zones, HVAC systems, envelope characteristics, and economics. Click the heading above a chart to view a table of the chart data.

## Modeler Description
For the most part consumption data comes from the tabular EnergyPlus results, however there are a few requests added for time series results. Space type and loop details come from the OpenStudio model. The code for this is modular, making it easy to use as a template for your own custom reports. The structure of the report uses bootstrap, and the graphs use dimple js. The new measure warning section will show warnings generated by upstream measures. It will not show forward translation warnings, EnergyPlus warnings, or warnings that might be reported by this measure.

## Measure Type
ReportingMeasure

## Taxonomy


## Arguments


### Which Unit System do you want to use?

**Name:** units,
**Type:** Choice,
**Units:** ,
**Required:** true,
**Model Dependent:** false

### Model Summary

**Name:** building_summary_section,
**Type:** Boolean,
**Units:** ,
**Required:** true,
**Model Dependent:** false

### Annual Overview

**Name:** annual_overview_section,
**Type:** Boolean,
**Units:** ,
**Required:** true,
**Model Dependent:** false

### Monthly Overview

**Name:** monthly_overview_section,
**Type:** Boolean,
**Units:** ,
**Required:** true,
**Model Dependent:** false

### Utility Bills/Rates

**Name:** utility_bills_rates_section,
**Type:** Boolean,
**Units:** ,
**Required:** true,
**Model Dependent:** false

### Envelope Summary

**Name:** envelope_section_section,
**Type:** Boolean,
**Units:** ,
**Required:** true,
**Model Dependent:** false

### Space Type Breakdown

**Name:** space_type_breakdown_section,
**Type:** Boolean,
**Units:** ,
**Required:** true,
**Model Dependent:** false

### Space Type Summary

**Name:** space_type_details_section,
**Type:** Boolean,
**Units:** ,
**Required:** true,
**Model Dependent:** false

### Interior Lighting Summary

**Name:** interior_lighting_section,
**Type:** Boolean,
**Units:** ,
**Required:** true,
**Model Dependent:** false

### Plug Loads Summary

**Name:** plug_loads_section,
**Type:** Boolean,
**Units:** ,
**Required:** true,
**Model Dependent:** false

### Exterior Lighting

**Name:** exterior_light_section,
**Type:** Boolean,
**Units:** ,
**Required:** true,
**Model Dependent:** false

### Water Use Equipment

**Name:** water_use_section,
**Type:** Boolean,
**Units:** ,
**Required:** true,
**Model Dependent:** false

### HVAC Load Profiles

**Name:** hvac_load_profile,
**Type:** Boolean,
**Units:** ,
**Required:** true,
**Model Dependent:** false

### Zone Conditions

**Name:** zone_condition_section,
**Type:** Boolean,
**Units:** ,
**Required:** true,
**Model Dependent:** false

### Zone Overview

**Name:** zone_summary_section,
**Type:** Boolean,
**Units:** ,
**Required:** true,
**Model Dependent:** false

### Zone Equipment Detail

**Name:** zone_equipment_detail_section,
**Type:** Boolean,
**Units:** ,
**Required:** true,
**Model Dependent:** false

### Air Loops Detail

**Name:** air_loops_detail_section,
**Type:** Boolean,
**Units:** ,
**Required:** true,
**Model Dependent:** false

### Plant Loops Detail

**Name:** plant_loops_detail_section,
**Type:** Boolean,
**Units:** ,
**Required:** true,
**Model Dependent:** false

### Outdoor Air

**Name:** outdoor_air_section,
**Type:** Boolean,
**Units:** ,
**Required:** true,
**Model Dependent:** false

### Cash Flow

**Name:** cost_summary_section,
**Type:** Boolean,
**Units:** ,
**Required:** true,
**Model Dependent:** false

### Site and Source Summary

**Name:** source_energy_section,
**Type:** Boolean,
**Units:** ,
**Required:** true,
**Model Dependent:** false

### Schedule Overview

**Name:** schedules_overview_section,
**Type:** Boolean,
**Units:** ,
**Required:** true,
**Model Dependent:** false

### Measure Warnings

**Name:** measure_warning_section,
**Type:** Boolean,
**Units:** ,
**Required:** true,
**Model Dependent:** false

### Report monthly fuel and enduse breakdown to registerValue
This argument does not effect HTML file, instead it makes data from individal cells of monthly tables avaiable for machine readable values in the resulting OpenStudio Workflow file.
**Name:** reg_monthly_details,
**Type:** Boolean,
**Units:** ,
**Required:** true,
**Model Dependent:** false





## Outputs


































electricity_ip, natural_gas_ip, additional_fuel_ip, district_heating_ip, district_cooling_ip, total_site_eui, eui, net_site_energy, annual_peak_electric_demand, unmet_hours_during_occupied_cooling, unmet_hours_during_occupied_heating, first_year_capital_cost, annual_utility_cost, total_lifecycle_cost, number_of_measures_with_warnings, number_warnings


## Contributors
- Primary development by the commercial buildings team at NREL
- Support for SI units reporting developed by Julien Marrec with EffiBEM and Julien Thirifays with IGRETEC
Original file line number Diff line number Diff line change
@@ -0,0 +1,46 @@
<%#= README.md.erb is used to auto-generate README.md. %>
<%#= To manually maintain README.md throw away README.md.erb and manually edit README.md %>
###### (Automatically generated documentation)

# <%= name %>

## Description
<%= description %>

## Modeler Description
<%= modelerDescription %>

## Measure Type
<%= measureType %>

## Taxonomy
<%= taxonomy %>

## Arguments

<% arguments.each do |argument| %>
### <%= argument[:display_name] %>
<%= argument[:description] %>
**Name:** <%= argument[:name] %>,
**Type:** <%= argument[:type] %>,
**Units:** <%= argument[:units] %>,
**Required:** <%= argument[:required] %>,
**Model Dependent:** <%= argument[:model_dependent] %>
<% end %>

<% if arguments.size == 0 %>
<%= "This measure does not have any user arguments" %>
<% end %>

<% if outputs.size > 0 %>
## Outputs
<% output_names = [] %>
<% outputs.each do |output| %>
<% output_names << output[:display_name] %>
<% end %>
<%= output_names.join(", ") %>
<% end %>

## Contributors
- Primary development by the commercial buildings team at NREL
- Support for SI units reporting developed by Julien Marrec with EffiBEM and Julien Thirifays with IGRETEC
Loading
Loading