RubyGems - openstudio-common-measures - Versions diffs - 0.2.0 → 0.4.0 - Mend

openstudio-common-measures 0.2.0 → 0.4.0

Files changed (524) hide show

data/lib/measures/hvac_psychrometric_chart/resources/report.html.erb CHANGED Viewed

@@ -1,6 +1,6 @@
 <%
   # *******************************************************************************
-  # OpenStudio(R), Copyright (c) 2008-2020, Alliance for Sustainable Energy, LLC.
+  # OpenStudio(R), Copyright (c) 2008-2021, Alliance for Sustainable Energy, LLC.
   # All rights reserved.
   # Redistribution and use in source and binary forms, with or without
   # modification, are permitted provided that the following conditions are met:
@@ -38,6 +38,10 @@
 <!DOCTYPE html>
 <html>
 <head>

data/lib/measures/inject_idf_objects/LICENSE.md CHANGED Viewed

@@ -1,4 +1,4 @@
-OpenStudio(R), Copyright (c) 2008-2020, Alliance for Sustainable Energy, LLC. All rights reserved.
+OpenStudio(R), Copyright (c) 2008-2021, Alliance for Sustainable Energy, LLC. All rights reserved.
 Redistribution and use in source and binary forms, with or without modification, are permitted
 provided that the following conditions are met:

data/lib/measures/inject_idf_objects/measure.rb CHANGED Viewed

@@ -1,5 +1,5 @@
 # *******************************************************************************
-# OpenStudio(R), Copyright (c) 2008-2020, Alliance for Sustainable Energy, LLC.
+# OpenStudio(R), Copyright (c) 2008-2021, Alliance for Sustainable Energy, LLC.
 # All rights reserved.
 # Redistribution and use in source and binary forms, with or without
 # modification, are permitted provided that the following conditions are met:

data/lib/measures/inject_idf_objects/measure.xml CHANGED Viewed

@@ -1,15 +1,16 @@
+<?xml version="1.0"?>
 <measure>
   <schema_version>3.0</schema_version>
   <name>inject_idf_objects</name>
   <uid>f567dfbc-d280-4d68-b061-019ab2630cd0</uid>
-  <version_id>844f4910-d87b-40fb-921f-3e295c6cbf9f</version_id>
-  <version_modified>20200229T024317Z</version_modified>
+  <version_id>27bc8e62-185b-4670-b5ce-548ee42ec4e7</version_id>
+  <version_modified>20210406T220305Z</version_modified>
   <xml_checksum>A8BAB05F</xml_checksum>
   <class_name>InjectIDFObjects</class_name>
   <display_name> Inject IDF Objects</display_name>
   <description>This measure allows you to inject IDF objects into an OSM generated IDF prior to passing the IDF off to EnergyPlus.</description>
-  <modeler_description>This provides a stepping stone between exporting an IDF from OpenStudio and hand editing the IDF and writing fully functional OpenStudio EnergyPlus measures.&#xd;
-&#xd;
+  <modeler_description>This provides a stepping stone between exporting an IDF from OpenStudio and hand editing the IDF and writing fully functional OpenStudio EnergyPlus measures.
 This measure works for when you just need to add new IDF objects. If you need to interact with or alter IDF objects made by the OpenStudio forward translator, you will want to write an EnergyPlus measure wtih more use-case specific logic.</modeler_description>
   <arguments>
     <argument>
@@ -21,8 +22,8 @@ This measure works for when you just need to add new IDF objects. If you need to
       <model_dependent>false</model_dependent>
     </argument>
   </arguments>
-  <outputs/>
-  <provenances/>
+  <outputs />
+  <provenances />
   <tags>
     <tag>Whole Building.Space Types</tag>
   </tags>
@@ -72,16 +73,28 @@ This measure works for when you just need to add new IDF objects. If you need to
       <checksum>F90DD242</checksum>
     </file>
     <file>
-      <filename>test.osw</filename>
+      <filename>model_test.osw</filename>
       <filetype>osw</filetype>
       <usage_type>test</usage_type>
       <checksum>F5FABCCF</checksum>
     </file>
     <file>
-      <filename>measure_Test.rb</filename>
-      <filetype>rb</filetype>
-      <usage_type>test</usage_type>
-      <checksum>617BF7D2</checksum>
+      <filename>README.md.erb</filename>
+      <filetype>erb</filetype>
+      <usage_type>readmeerb</usage_type>
+      <checksum>703C9964</checksum>
+    </file>
+    <file>
+      <filename>README.md</filename>
+      <filetype>md</filetype>
+      <usage_type>readme</usage_type>
+      <checksum>3D0882F2</checksum>
+    </file>
+    <file>
+      <filename>LICENSE.md</filename>
+      <filetype>md</filetype>
+      <usage_type>license</usage_type>
+      <checksum>A21A3ED2</checksum>
     </file>
     <file>
       <version>
@@ -92,25 +105,13 @@ This measure works for when you just need to add new IDF objects. If you need to
       <filename>measure.rb</filename>
       <filetype>rb</filetype>
       <usage_type>script</usage_type>
-      <checksum>7F05D1DE</checksum>
+      <checksum>FFC40353</checksum>
     </file>
     <file>
-      <filename>LICENSE.md</filename>
-      <filetype>md</filetype>
-      <usage_type>license</usage_type>
-      <checksum>E0468DD6</checksum>
-    </file>
-    <file>
-      <filename>README.md.erb</filename>
-      <filetype>erb</filetype>
-      <usage_type>readmeerb</usage_type>
-      <checksum>703C9964</checksum>
-    </file>
-    <file>
-      <filename>README.md</filename>
-      <filetype>md</filetype>
-      <usage_type>readme</usage_type>
-      <checksum>3D0882F2</checksum>
+      <filename>measure_Test.rb</filename>
+      <filetype>rb</filetype>
+      <usage_type>test</usage_type>
+      <checksum>BCA08D25</checksum>
     </file>
   </files>
 </measure>

data/lib/measures/openstudio_results/LICENSE.md CHANGED Viewed

@@ -1,4 +1,4 @@
-OpenStudio(R), Copyright (c) 2008-2020, Alliance for Sustainable Energy, LLC. All rights reserved.
+OpenStudio(R), Copyright (c) 2008-2021, Alliance for Sustainable Energy, LLC. All rights reserved.
 Redistribution and use in source and binary forms, with or without modification, are permitted
 provided that the following conditions are met:

data/lib/measures/openstudio_results/README.md CHANGED Viewed

@@ -2,16 +2,16 @@
 ###### (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
-ModelMeasure
+ReportingMeasure
 ## Taxonomy
@@ -19,9 +19,199 @@ ModelMeasure
 ## 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
-This measure does not have any user arguments
@@ -56,7 +246,11 @@ This measure does not have any user arguments
-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
+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

data/lib/measures/openstudio_results/measure.rb CHANGED Viewed

@@ -1,5 +1,5 @@
 # *******************************************************************************
-# OpenStudio(R), Copyright (c) 2008-2020, Alliance for Sustainable Energy, LLC.
+# OpenStudio(R), Copyright (c) 2008-2021, Alliance for Sustainable Energy, LLC.
 # All rights reserved.
 # Redistribution and use in source and binary forms, with or without
 # modification, are permitted provided that the following conditions are met:
@@ -36,11 +36,13 @@
 require 'erb'
 require 'json'
+# load OpenStudio measure libraries from openstudio-extension gem
+require 'openstudio-extension'
+require 'openstudio/extension/core/os_lib_schedules'
+require 'openstudio/extension/core/os_lib_helper_methods'
 # load local resources
 require "#{File.dirname(__FILE__)}/resources/os_lib_reporting"
-require "#{File.dirname(__FILE__)}/resources/os_lib_schedules"
-require "#{File.dirname(__FILE__)}/resources/os_lib_helper_methods"
 require_relative 'resources/Siz.Model'
 # start the measure
@@ -58,7 +60,7 @@ class OpenStudioResults < OpenStudio::Measure::ReportingMeasure
   # human readable description of modeling approach
   def 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.'
+    '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.'
   end
   def possible_sections
@@ -112,7 +114,7 @@ class OpenStudioResults < OpenStudio::Measure::ReportingMeasure
     result << 'schedules_overview_section'
     # TODO: - clean up code to gather schedule profiles so I don't have to grab every 15 minutes
-    # TODO: - add in section to report warnings for this and other measures
+    # add in section to report warnings for this and other measures
     result << 'measure_warning_section'
     # see the method below in os_lib_reporting.rb to see a simple example of code to make a section of tables
@@ -125,7 +127,7 @@ class OpenStudioResults < OpenStudio::Measure::ReportingMeasure
   end
   # define the arguments that the user will input
-  def arguments
+  def arguments(model = nil)
     args = OpenStudio::Measure::OSArgumentVector.new
     chs = OpenStudio::StringVector.new
@@ -182,10 +184,12 @@ class OpenStudioResults < OpenStudio::Measure::ReportingMeasure
       category_str = OpenStudio::EndUseCategoryType.new(category_type).valueDescription
       category_strs << category_str
     end
-    additional_fuel_types = ['FuelOil#1', 'FuelOil#2', 'PropaneGas', 'Coal', 'Diesel', 'Gasoline', 'OtherFuel1', 'OtherFuel2']
+    additional_fuel_types = ['FuelOilNo1', 'FuelOilNo2', 'PropaneGas', 'Coal', 'Diesel', 'Gasoline', 'OtherFuel1', 'OtherFuel2']
+    # additional_fuel_types = OsLib_Reporting.fuel_type_names # getting all fuels instead of additional until fixed in OS
     additional_fuel_types.each do |additional_fuel_type|
       monthly_array = ['Output:Table:Monthly']
-      monthly_array << 'Building Energy Performance - FuelOil#1'
+      monthly_array << "Building Energy Performance - #{additional_fuel_type}"
       monthly_array << '2'
       category_strs.each do |category_string|
         monthly_array << "#{category_string}:#{additional_fuel_type}"
@@ -217,7 +221,9 @@ class OpenStudioResults < OpenStudio::Measure::ReportingMeasure
     result << OpenStudio::Measure::OSOutput.makeDoubleOutput('annual_utility_cost') # $
     result << OpenStudio::Measure::OSOutput.makeDoubleOutput('total_lifecycle_cost') # $
-    # TODO: - add warning counts, but only if they will always be made.
+    # add warning counts
+    result << OpenStudio::Measure::OSOutput.makeDoubleOutput('number_of_measures_with_warnings')
+    result << OpenStudio::Measure::OSOutput.makeDoubleOutput('number_warnings')
     return result
   end
@@ -306,16 +312,16 @@ class OpenStudioResults < OpenStudio::Measure::ReportingMeasure
       rescue StandardError => e
         display_name = eval("OsLib_Reporting.#{method_name}(nil,nil,nil,true)[:title]")
         if display_name.nil? then display_name == method_name end
-        runner.registerWarning("#{display_name} section failed and was skipped because: #{e}. Detail on error follows.")
-        runner.registerWarning(e.backtrace.join("\n").to_s)
+        runner.registerWarning("#{display_name} section failed and was skipped because: #{e}. Detail on error follows: #{e.backtrace.join("\n")}")
         # add in section heading with message if section fails
         section = {}
         section[:title] = display_name.to_s
         section[:tables] = []
         section[:messages] = []
-        section[:messages] << "#{display_name} section failed and was skipped because: #{e}. Detail on error follows."
-        section[:messages] << [e.backtrace.join("\n").to_s]
+        section[:messages] << "#{display_name} section failed and was skipped because: #{e}. Detail on error is in Measure Warnings section, if enabled at the bottom of this report."
+        # backtrace is now in Measure Warning section and doesn't need to be in line with the report section.
+        # section[:messages] << [e.backtrace.join("\n").to_s]
         @sections << section
       end