openstudio-common-measures 0.2.0 → 0.4.0

data/lib/measures/SetLightingLoadsByLPD/LICENSE.md

@@ -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/SetLightingLoadsByLPD/measure.rb

@@ -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/SetLightingLoadsByLPD/measure.xml

@@ -1,9 +1,10 @@
+<?xml version="1.0"?>
 <measure>
   <schema_version>3.0</schema_version>
   <name>set_lighting_loads_by_lpd</name>
   <uid>901c076e-02af-4bf4-a780-57391e7b1e2a</uid>
-  <version_id>70647009-9dbc-4799-aafa-f89177a278e9</version_id>
-  <version_modified>20200229T024316Z</version_modified>
+  <version_id>968cfcb1-6ca0-4d6e-9509-8fbaccf15602</version_id>
+  <version_modified>20210406T220259Z</version_modified>
   <xml_checksum>293730A7</xml_checksum>
   <class_name>SetLightingLoadsByLPD</class_name>
   <display_name>Set Lighting Loads by LPD</display_name>
@@ -16,10 +17,10 @@
       <type>Choice</type>
       <required>true</required>
       <model_dependent>false</model_dependent>
-      <default_value>*Entire Building*</default_value>
+      <default_value>{35e12799-db3f-4254-a039-50ac8aeb9ace}</default_value>
       <choices>
         <choice>
-          <value>{e4b1b526-ab17-4ee7-ad86-01d9218c6261}</value>
+          <value>{35e12799-db3f-4254-a039-50ac8aeb9ace}</value>
           <display_name>*Entire Building*</display_name>
         </choice>
       </choices>
@@ -117,8 +118,8 @@
       <default_value>1</default_value>
     </argument>
   </arguments>
-  <outputs/>
-  <provenances/>
+  <outputs />
+  <provenances />
   <tags>
     <tag>Electric Lighting.Lighting Equipment</tag>
   </tags>
@@ -179,13 +180,13 @@
       <filename>LICENSE.md</filename>
       <filetype>md</filetype>
       <usage_type>license</usage_type>
-      <checksum>E0468DD6</checksum>
+      <checksum>A21A3ED2</checksum>
     </file>
     <file>
       <filename>ReplaceLightsWithLPD_01_Test.rb</filename>
       <filetype>rb</filetype>
       <usage_type>test</usage_type>
-      <checksum>BC3B260C</checksum>
+      <checksum>6098F992</checksum>
     </file>
     <file>
       <version>
@@ -196,7 +197,7 @@
       <filename>measure.rb</filename>
       <filetype>rb</filetype>
       <usage_type>script</usage_type>
-      <checksum>E1681A6A</checksum>
+      <checksum>F560BA16</checksum>
     </file>
   </files>
 </measure>

data/lib/measures/SetSpaceInfiltrationByExteriorSurfaceArea/LICENSE.md

@@ -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/SetSpaceInfiltrationByExteriorSurfaceArea/measure.rb

@@ -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/SetSpaceInfiltrationByExteriorSurfaceArea/measure.xml

@@ -1,25 +1,26 @@
+<?xml version="1.0"?>
 <measure>
   <schema_version>3.0</schema_version>
   <name>set_space_infiltration_by_exterior_surface_area</name>
   <uid>9d7b0789-3974-4869-a2a8-055391857e3c</uid>
-  <version_id>009df721-461a-45d4-8751-ae9c999c3ff7</version_id>
-  <version_modified>20200229T024316Z</version_modified>
+  <version_id>b2ff01cf-db13-46a9-8569-99e7a73ee6a9</version_id>
+  <version_modified>20210406T220259Z</version_modified>
   <xml_checksum>E88CCCA7</xml_checksum>
   <class_name>SetSpaceInfiltrationByExteriorSurfaceArea</class_name>
   <display_name>Set Space Infiltration by Exterior Surface Area</display_name>
-  <description>Replace all Space Infiltration objects with a new one that has a prescribed flow rate per exterior surface area.  There are many strategies that can be used to reduce infiltration.&#xd;&#xd;&#xd;&#xd;&#xd;&#xd;
-&#xd;&#xd;&#xd;&#xd;&#xd;&#xd;
-Seal Windows ? Seal all windows and doors with weather strip and fill any air gaps with insulation and caulking to prevent air infiltration.&#xd;&#xd;&#xd;&#xd;&#xd;&#xd;
-&#xd;&#xd;&#xd;&#xd;&#xd;&#xd;
-Install Revolving Doors on the Inner Door Entrance - Replace the high traffic entrance doors with revolving doors.  This will reduce the air infiltration associated with the doors.  Notice that loading dock doors and handicapped accessible entrances cannot be replaced with revolving doors.&#xd;&#xd;&#xd;&#xd;&#xd;&#xd;
-&#xd;&#xd;&#xd;&#xd;&#xd;&#xd;
-Install an Air Curtain for the Loading Dock Door - An air curtain should be installed in the entryway of loading dock doors.  This will greatly reduce outside air from infiltrating during periods of time when loading dock doors are open.&#xd;&#xd;&#xd;&#xd;&#xd;&#xd;
-&#xd;&#xd;&#xd;&#xd;&#xd;&#xd;
-Identify and seal other sources of infiltration ? Look for other uncontrolled infiltration sources and work to air seal.  These could be former electrical chases, abandoned HVAC ducting, general envelope deterioration, or many other sources.&#xd;&#xd;&#xd;&#xd;&#xd;&#xd;
+  <description>Replace all Space Infiltration objects with a new one that has a prescribed flow rate per exterior surface area.  There are many strategies that can be used to reduce infiltration.
+
+Seal Windows ? Seal all windows and doors with weather strip and fill any air gaps with insulation and caulking to prevent air infiltration.
+
+Install Revolving Doors on the Inner Door Entrance - Replace the high traffic entrance doors with revolving doors.  This will reduce the air infiltration associated with the doors.  Notice that loading dock doors and handicapped accessible entrances cannot be replaced with revolving doors.
+
+Install an Air Curtain for the Loading Dock Door - An air curtain should be installed in the entryway of loading dock doors.  This will greatly reduce outside air from infiltrating during periods of time when loading dock doors are open.
+
+Identify and seal other sources of infiltration ? Look for other uncontrolled infiltration sources and work to air seal.  These could be former electrical chases, abandoned HVAC ducting, general envelope deterioration, or many other sources.
   </description>
-  <modeler_description>Remove all infiltration objects used in the model and add in a new object to each space type, and then to spaces without space types. Schedules come from the schedule sets. Warn user if there is no schedule set associated with a space type.&#xd;&#xd;&#xd;&#xd;&#xd;&#xd;
-&#xd;&#xd;&#xd;&#xd;&#xd;&#xd;
-A one time material &amp; installation cost can be added to the building object to reflect improvements made throughout the envelope. "Years Until Costs Start? is typically "0?, but you can use a larger number if you want to delay the improvements.  O&amp;M cost and frequency can be whatever is appropriate for the component. This measure hard sizes the costs based on current infiltration levels.  As a result any change to the models made by measures run after this that have an impact on infiltration will not affect the cost. An example of a problematic measure would be deleting a space from the model or making each floor taller; in both cases adjusting the total exterior envelope area.&#xd;&#xd;&#xd;&#xd;&#xd;&#xd;
+  <modeler_description>Remove all infiltration objects used in the model and add in a new object to each space type, and then to spaces without space types. Schedules come from the schedule sets. Warn user if there is no schedule set associated with a space type.
+
+A one time material &amp; installation cost can be added to the building object to reflect improvements made throughout the envelope. "Years Until Costs Start? is typically "0?, but you can use a larger number if you want to delay the improvements.  O&amp;M cost and frequency can be whatever is appropriate for the component. This measure hard sizes the costs based on current infiltration levels.  As a result any change to the models made by measures run after this that have an impact on infiltration will not affect the cost. An example of a problematic measure would be deleting a space from the model or making each floor taller; in both cases adjusting the total exterior envelope area.
   </modeler_description>
   <arguments>
     <argument>
@@ -55,8 +56,8 @@ A one time material &amp; installation cost can be added to the building object
       <default_value>1</default_value>
     </argument>
   </arguments>
-  <outputs/>
-  <provenances/>
+  <outputs />
+  <provenances />
   <tags>
     <tag>Envelope.Infiltration</tag>
   </tags>
@@ -116,19 +117,19 @@ A one time material &amp; installation cost can be added to the building object
       <filename>measure.rb</filename>
       <filetype>rb</filetype>
       <usage_type>script</usage_type>
-      <checksum>2A4F5C31</checksum>
+      <checksum>FF3AFB40</checksum>
     </file>
     <file>
       <filename>SetSpaceInfiltrationByExteriorSurfaceArea_Test.rb</filename>
       <filetype>rb</filetype>
       <usage_type>test</usage_type>
-      <checksum>352CBB25</checksum>
+      <checksum>7F668E36</checksum>
     </file>
     <file>
       <filename>LICENSE.md</filename>
       <filetype>md</filetype>
       <usage_type>license</usage_type>
-      <checksum>E0468DD6</checksum>
+      <checksum>A21A3ED2</checksum>
     </file>
   </files>
 </measure>

data/lib/measures/SetThermostatSchedules/LICENSE.md

@@ -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/SetThermostatSchedules/measure.rb

@@ -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/SetThermostatSchedules/measure.xml

@@ -1,9 +1,10 @@
+<?xml version="1.0"?>
 <measure>
   <schema_version>3.0</schema_version>
   <name>set_thermostat_schedules</name>
   <uid>2978cde0-53d5-4096-bdab-11f9f6e074f1</uid>
-  <version_id>c08c1cff-1e5e-474c-915e-c1a3abe0c0b8</version_id>
-  <version_modified>20200229T024315Z</version_modified>
+  <version_id>6ab8322c-a3ad-4ce2-8035-ed5407a28383</version_id>
+  <version_modified>20210406T220259Z</version_modified>
   <xml_checksum>F4CEA58B</xml_checksum>
   <class_name>SetThermostatSchedules</class_name>
   <display_name>Set Thermostat Schedules</display_name>
@@ -16,10 +17,10 @@
       <type>Choice</type>
       <required>true</required>
       <model_dependent>false</model_dependent>
-      <default_value>*All Thermal Zones*</default_value>
+      <default_value>{16ed4270-57a1-4ebe-9724-abc6ba413a3a}</default_value>
       <choices>
         <choice>
-          <value>{6a241220-4789-4fcb-b416-3432f86d7b2d}</value>
+          <value>{16ed4270-57a1-4ebe-9724-abc6ba413a3a}</value>
           <display_name>*All Thermal Zones*</display_name>
         </choice>
       </choices>
@@ -30,7 +31,7 @@
       <type>Choice</type>
       <required>true</required>
       <model_dependent>false</model_dependent>
-      <default_value>*No Change*</default_value>
+      <default_value>{00000000-0000-0000-0000-000000000000}</default_value>
       <choices>
         <choice>
           <value>{00000000-0000-0000-0000-000000000000}</value>
@@ -44,7 +45,7 @@
       <type>Choice</type>
       <required>true</required>
       <model_dependent>false</model_dependent>
-      <default_value>*No Change*</default_value>
+      <default_value>{00000000-0000-0000-0000-000000000000}</default_value>
       <choices>
         <choice>
           <value>{00000000-0000-0000-0000-000000000000}</value>
@@ -61,8 +62,8 @@
       <default_value>0</default_value>
     </argument>
   </arguments>
-  <outputs/>
-  <provenances/>
+  <outputs />
+  <provenances />
   <tags>
     <tag>HVAC.HVAC Controls</tag>
   </tags>
@@ -110,19 +111,19 @@
       <filename>measure.rb</filename>
       <filetype>rb</filetype>
       <usage_type>script</usage_type>
-      <checksum>C53B40AB</checksum>
+      <checksum>F19C744A</checksum>
     </file>
     <file>
       <filename>LICENSE.md</filename>
       <filetype>md</filetype>
       <usage_type>license</usage_type>
-      <checksum>E0468DD6</checksum>
+      <checksum>A21A3ED2</checksum>
     </file>
     <file>
       <filename>SetThermostatSchedules_Test.rb</filename>
       <filetype>rb</filetype>
       <usage_type>test</usage_type>
-      <checksum>101470AA</checksum>
+      <checksum>1D5AFE7F</checksum>
     </file>
   </files>
 </measure>

data/lib/measures/ShiftScheduleProfileTime/LICENSE.md

@@ -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/ShiftScheduleProfileTime/measure.rb

@@ -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/ShiftScheduleProfileTime/measure.xml

@@ -1,9 +1,10 @@
+<?xml version="1.0"?>
 <measure>
   <schema_version>3.0</schema_version>
   <name>shift_schedule_profile_time</name>
   <uid>1c642348-f074-4ad1-98ee-2208ddc89ac7</uid>
-  <version_id>5404621c-fd40-40c5-9151-84cc29061110</version_id>
-  <version_modified>20200229T024319Z</version_modified>
+  <version_id>7482b65c-0478-49b3-9b54-eb3a627bc2ab</version_id>
+  <version_modified>20210406T220259Z</version_modified>
   <xml_checksum>B6CD1F98</xml_checksum>
   <class_name>ShiftScheduleProfileTime</class_name>
   <display_name>ShiftScheduleProfileTime</display_name>
@@ -16,10 +17,10 @@
       <type>Choice</type>
       <required>true</required>
       <model_dependent>false</model_dependent>
-      <default_value>*All Ruleset Schedules*</default_value>
+      <default_value>{15966d58-132a-443f-9dcd-2a3886efe059}</default_value>
       <choices>
         <choice>
-          <value>{f218f307-4c6f-4fcb-bd01-f0044042f9f0}</value>
+          <value>{15966d58-132a-443f-9dcd-2a3886efe059}</value>
           <display_name>*All Ruleset Schedules*</display_name>
         </choice>
       </choices>
@@ -33,8 +34,8 @@
       <default_value>1</default_value>
     </argument>
   </arguments>
-  <outputs/>
-  <provenances/>
+  <outputs />
+  <provenances />
   <tags>
     <tag>Whole Building.Whole Building Schedules</tag>
   </tags>
@@ -88,19 +89,19 @@
       <filename>measure.rb</filename>
       <filetype>rb</filetype>
       <usage_type>script</usage_type>
-      <checksum>003AA7A4</checksum>
+      <checksum>C1D066F5</checksum>
     </file>
     <file>
       <filename>ShiftScheduleProfileTime_Test.rb</filename>
       <filetype>rb</filetype>
       <usage_type>test</usage_type>
-      <checksum>51BB433C</checksum>
+      <checksum>92F095AD</checksum>
     </file>
     <file>
       <filename>LICENSE.md</filename>
       <filetype>md</filetype>
       <usage_type>license</usage_type>
-      <checksum>E0468DD6</checksum>
+      <checksum>A21A3ED2</checksum>
     </file>
   </files>
 </measure>

data/lib/measures/SwapLightsDefinition/LICENSE.md

@@ -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/SwapLightsDefinition/measure.rb

@@ -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/SwapLightsDefinition/measure.xml

@@ -1,15 +1,16 @@
+<?xml version="1.0"?>
 <measure>
   <schema_version>3.0</schema_version>
   <name>swap_lights_definition</name>
   <uid>63845525-5b86-448f-9a34-6be8481496ea</uid>
-  <version_id>acab2d64-3b5f-49c9-95d4-9531153f3a4c</version_id>
-  <version_modified>20200229T024320Z</version_modified>
+  <version_id>5afb4e53-9cd5-4bf7-ba9b-3481c2fa92ee</version_id>
+  <version_modified>20210406T220259Z</version_modified>
   <xml_checksum>293730A7</xml_checksum>
   <class_name>SwapLightsDefinition</class_name>
   <display_name>SwapLightsDefinition</display_name>
   <description>This measure will swap out one lights definition for another. All objects that had referred to the original definition will now refer to the new one.</description>
-  <modeler_description>This measure will not delete or change either definition, rather it just swaps out the references of one for the other. It is possible that the new definition is already used in the model elsewhere.&#xd;&#xd;&#xd;&#xd;&#xd;&#xd;
-    Each of these objects can be independently costed, however the measure can address demolition costs of the object being removed.&#xd;&#xd;&#xd;&#xd;&#xd;&#xd;
+  <modeler_description>This measure will not delete or change either definition, rather it just swaps out the references of one for the other. It is possible that the new definition is already used in the model elsewhere.
+    Each of these objects can be independently costed, however the measure can address demolition costs of the object being removed.
   </modeler_description>
   <arguments>
     <argument>
@@ -45,8 +46,8 @@
       </choices>
     </argument>
   </arguments>
-  <outputs/>
-  <provenances/>
+  <outputs />
+  <provenances />
   <tags>
     <tag>Electric Lighting.Lighting Equipment</tag>
   </tags>
@@ -106,19 +107,19 @@
       <filename>measure.rb</filename>
       <filetype>rb</filetype>
       <usage_type>script</usage_type>
-      <checksum>68478B15</checksum>
+      <checksum>389C4DF8</checksum>
     </file>
     <file>
       <filename>SwapLightsDefinition_Test.rb</filename>
       <filetype>rb</filetype>
       <usage_type>test</usage_type>
-      <checksum>D1BDE11B</checksum>
+      <checksum>81CDF84D</checksum>
     </file>
     <file>
       <filename>LICENSE.md</filename>
       <filetype>md</filetype>
       <usage_type>license</usage_type>
-      <checksum>E0468DD6</checksum>
+      <checksum>A21A3ED2</checksum>
     </file>
   </files>
 </measure>

data/lib/measures/UnmetLoadHoursTroubleshooting/LICENSE.md

@@ -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/UnmetLoadHoursTroubleshooting/README.md

@@ -2,7 +2,7 @@
 
 ###### (Automatically generated documentation)
 
-# 
+# Unmet Load Hours Troubleshooting
 
 ## Description
 
@@ -11,7 +11,7 @@
 
 
 ## Measure Type
-ModelMeasure
+ReportingMeasure
 
 ## Taxonomy
 
@@ -19,8 +19,14 @@ ModelMeasure
 ## Arguments
 
 
+### Pick a Zone (or all Zones)
+
+**Name:** measure_zone,
+**Type:** Choice,
+**Units:** ,
+**Required:** true,
+**Model Dependent:** false
 
 
-This measure does not have any user arguments
 
 

data/lib/measures/UnmetLoadHoursTroubleshooting/measure.rb

@@ -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:
@@ -58,7 +58,7 @@ class UnmetLoadHoursTroubleshooting < OpenStudio::Measure::ReportingMeasure
     return requested_args
   end
 
-  def arguments
+  def arguments(model = nil)
     args = OpenStudio::Measure::OSArgumentVector.new
 
     # Future functionality