openstudio-model-articulation 0.2.0 → 0.2.1

data/lib/measures/create_typical_doe_building_from_model/resources/Model.hvac.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # *******************************************************************************
 # OpenStudio(R), Copyright (c) 2008-2020, Alliance for Sustainable Energy, LLC.
 # All rights reserved.
@@ -60,7 +62,7 @@ class OpenStudio::Model::Model
       standard.model_add_hvac_system(self, 'Baseboards', ht = 'NaturalGas', znht = nil, cl = nil, heated_zones)
 
     when 'Baseboard central air source heat pump'
-      standard.model_add_hvac_system(self, 'Baseboards', ht = 'AirSourceHeatPump', znht = nil, cl = nil, heated_only_zones)
+      standard.model_add_hvac_system(self, 'Baseboards', ht = 'AirSourceHeatPump', znht = nil, cl = nil, heated_zones)
 
     when 'Baseboard district hot water'
       standard.model_add_hvac_system(self, 'Baseboards', ht = 'DistrictHeating', znht = nil, cl = nil, heated_zones)

data/lib/measures/deer_space_type_and_construction_set_wizard/measure.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # *******************************************************************************
 # OpenStudio(R), Copyright (c) 2008-2020, Alliance for Sustainable Energy, LLC.
 # All rights reserved.

data/lib/measures/find_and_replace_in_all_thermal_zone_names/measure.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # *******************************************************************************
 # OpenStudio(R), Copyright (c) 2008-2020, Alliance for Sustainable Energy, LLC.
 # All rights reserved.

data/lib/measures/make_shading_surfaces_based_on_zone_multipliers/measure.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # *******************************************************************************
 # OpenStudio(R), Copyright (c) 2008-2020, Alliance for Sustainable Energy, LLC.
 # All rights reserved.

data/lib/measures/merge_floorspace_js_with_model/measure.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # *******************************************************************************
 # OpenStudio(R), Copyright (c) 2008-2020, Alliance for Sustainable Energy, LLC.
 # All rights reserved.

data/lib/measures/merge_floorspace_js_with_model/measure.xml

@@ -3,8 +3,8 @@
   <schema_version>3.0</schema_version>
   <name>merge_floorspace_js_with_model</name>
   <uid>16ef6369-6420-4f17-894c-a767895bcaa4</uid>
-  <version_id>81182772-83db-4244-bc0f-377cde800b1a</version_id>
-  <version_modified>20200509T155939Z</version_modified>
+  <version_id>1033eb89-6eeb-4ec3-8fa3-097b1db946a2</version_id>
+  <version_modified>20200624T003820Z</version_modified>
   <xml_checksum>0AD1E2E2</xml_checksum>
   <class_name>MergeFloorspaceJsWithModel</class_name>
   <display_name>Merge FloorspaceJs with Model</display_name>
@@ -59,12 +59,6 @@
       <usage_type>readmeerb</usage_type>
       <checksum>703C9964</checksum>
     </file>
-    <file>
-      <filename>.gitkeep</filename>
-      <filetype>gitkeep</filetype>
-      <usage_type>doc</usage_type>
-      <checksum>00000000</checksum>
-    </file>
     <file>
       <filename>office_floorplan.json</filename>
       <filetype>json</filetype>
@@ -78,7 +72,7 @@
       <checksum>757BD721</checksum>
     </file>
     <file>
-      <filename>test.osw</filename>
+      <filename>measure_test.osw</filename>
       <filetype>osw</filetype>
       <usage_type>test</usage_type>
       <checksum>3CCFE3D3</checksum>
@@ -95,12 +89,6 @@
       <usage_type>license</usage_type>
       <checksum>E0468DD6</checksum>
     </file>
-    <file>
-      <filename>merge_floorspace_js_with_model_test.rb</filename>
-      <filetype>rb</filetype>
-      <usage_type>test</usage_type>
-      <checksum>04B13C39</checksum>
-    </file>
     <file>
       <version>
         <software_program>OpenStudio</software_program>
@@ -112,5 +100,11 @@
       <usage_type>script</usage_type>
       <checksum>00F6B912</checksum>
     </file>
+    <file>
+      <filename>merge_floorspace_js_with_model_test.rb</filename>
+      <filetype>rb</filetype>
+      <usage_type>test</usage_type>
+      <checksum>43B11AF8</checksum>
+    </file>
   </files>
 </measure>

data/lib/measures/merge_spaces_from_external_file/measure.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # *******************************************************************************
 # OpenStudio(R), Copyright (c) 2008-2020, Alliance for Sustainable Energy, LLC.
 # All rights reserved.

data/lib/measures/merge_spaces_from_external_file/measure.xml

@@ -3,8 +3,8 @@
   <schema_version>3.0</schema_version>
   <name>merge_spaces_from_external_file</name>
   <uid>e439a1a9-d075-4a25-9f83-2dca79d2826e</uid>
-  <version_id>4e6b6bd7-0c53-4ef7-8e77-d987ab17a232</version_id>
-  <version_modified>20200509T155942Z</version_modified>
+  <version_id>fac6015b-aad1-4ebc-8285-d27109b95171</version_id>
+  <version_modified>20200624T003830Z</version_modified>
   <xml_checksum>D8922A73</xml_checksum>
   <class_name>MergeSpacesFromExternalFile</class_name>
   <display_name>Merge Spaces from External File</display_name>
@@ -182,7 +182,7 @@
   </attributes>
   <files>
     <file>
-      <filename>test.osw</filename>
+      <filename>measure_test.osw</filename>
       <filetype>osw</filetype>
       <usage_type>test</usage_type>
       <checksum>F5FABCCF</checksum>
@@ -238,7 +238,7 @@
       <filename>merge_spaces_from_external_file_test.rb</filename>
       <filetype>rb</filetype>
       <usage_type>test</usage_type>
-      <checksum>BAE573B6</checksum>
+      <checksum>6DE336DE</checksum>
     </file>
   </files>
 </measure>

data/lib/measures/merge_spaces_from_external_file/resources/ScheduleTranslator.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # *******************************************************************************
 # OpenStudio(R), Copyright (c) 2008-2020, Alliance for Sustainable Energy, LLC.
 # All rights reserved.
@@ -72,7 +74,7 @@ class ScheduleTranslator
       val = @os_schedule.getString(i).get
 
       # Trap for interpolated schedules
-      if val =~ /Interpolate/
+      if val.match?(/Interpolate/)
         puts "[WARNING] Schedule #{@sched_name} is interpolated.  It will not be translated to .osm"
         return false
       end
@@ -82,7 +84,7 @@ class ScheduleTranslator
       val = val.gsub(/For\s/, 'For: ')
       val = val.gsub(/Until\s/, 'Until: ')
 
-      if val =~ /through:/i
+      if val.match?(/through:/i)
         i_thru += 1
         i_for = -1
         i_until = -1
@@ -97,7 +99,7 @@ class ScheduleTranslator
         next
       end
 
-      if val =~ /for[:\s]/i
+      if val.match?(/for[:\s]/i)
         i_for += 1
         i_until = -1
 
@@ -106,7 +108,7 @@ class ScheduleTranslator
         next
       end
 
-      if val =~ /until:/i
+      if val.match?(/until:/i)
         i_until += 1
 
         str = val.split(':')[1..2].join(':').strip

data/lib/measures/radiance_measure/measure.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # *******************************************************************************
 # OpenStudio(R), Copyright (c) 2008-2020, Alliance for Sustainable Energy, LLC.
 # All rights reserved.

data/lib/measures/radiance_measure/measure.xml

@@ -3,8 +3,8 @@
   <schema_version>3.0</schema_version>
   <name>radiance_measure</name>
   <uid>1e3cfef8-b051-4e60-8bb0-ed2d29d4f45f</uid>
-  <version_id>f7e317e9-190f-4f45-b02a-77d2b39deb2f</version_id>
-  <version_modified>20200512T025556Z</version_modified>
+  <version_id>77b56312-1bff-49a4-91e8-64db8264357c</version_id>
+  <version_modified>20200624T011257Z</version_modified>
   <xml_checksum>381B7733</xml_checksum>
   <class_name>RadianceMeasure</class_name>
   <display_name>Radiance Daylighting Measure</display_name>
@@ -172,12 +172,6 @@
       <usage_type>test</usage_type>
       <checksum>4255EB94</checksum>
     </file>
-    <file>
-      <filename>test_model.osm</filename>
-      <filetype>osm</filetype>
-      <usage_type>test</usage_type>
-      <checksum>909929E9</checksum>
-    </file>
     <file>
       <filename>LICENSE.md</filename>
       <filetype>md</filetype>
@@ -199,7 +193,13 @@
       <filename>radiance_measure_test.rb</filename>
       <filetype>rb</filetype>
       <usage_type>test</usage_type>
-      <checksum>1182B148</checksum>
+      <checksum>DD169097</checksum>
+    </file>
+    <file>
+      <filename>measure_test_model.osm</filename>
+      <filetype>osm</filetype>
+      <usage_type>test</usage_type>
+      <checksum>909929E9</checksum>
     </file>
   </files>
 </measure>

data/lib/measures/radiant_slab_with_doas/LICENSE.md

@@ -0,0 +1,27 @@
+OpenStudio(R), Copyright (c) 2008-2020, 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:
+
+(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) Neither the name of the copyright holder nor the names of any contributors may be used to endorse 
+or promote products derived from this software without specific prior written permission from the 
+respective party.
+
+(4) Other than as required in clauses (1) and (2), distributions in any form of modifications or other 
+derivative works may not use the "OpenStudio" trademark, "OS", "os", or any other confusingly similar 
+designation without specific prior written permission from Alliance for Sustainable Energy, LLC.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND 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, THE UNITED STATES GOVERNMENT, 
+OR ANY CONTRIBUTORS 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.

data/lib/measures/radiant_slab_with_doas/README.md

@@ -0,0 +1,156 @@
+
+
+###### (Automatically generated documentation)
+
+# Radiant Slab with DOAS
+
+## Description
+Adds a radiant slab with DOAS ventilation system to the model.
+
+## Modeler Description
+This measure adds either a radiant floor slab or radiant ceiling slab with dedicated outdoor air system to conditioned zones in the model.
+Radiant systems are comfortable with wider zone air temperature range. Use the CBE Thermal Comfort Tool or other method to set thermostat setpoint temperatures.
+This measure optionally removes existing HVAC systems (recommended).
+This measure is dependent on an ASHRAE climate zone to set insulation and design supply temperature levels, so make sure this is set in the site parameters of the model.
+Plant equipment options are an Air Source Heat Pump or a Boiler for hot water, and an Air Cooled Chiller or Water Cooled Chiller for chilled water.
+The Air Source Heat Pump object uses a user-defined plant component in EnergyPlus and may not be compatible with several reporting measures, including the *Enable Detailed Output for Each Node in a Loop* measure.
+If Water Cooled Chiller is selected, the measure will add a condenser loop with a variable speed cooling tower, and optionally enable water-side economizing when wet bulb conditions allow.
+By default, the slab system does not include carpet. Carpet greatly reduces the heat transfer capacity of the radiant system.  If carpet is preferred, a ceiling-type slab and no lockout are recommended to avoid unmet hours.
+The measure includes several control parameters for radiant system operation. Use the defaults unless you have strong reasons to deviate from them.
+This measure runs a sizing run to set equipment efficiency values, so it may take up to a few minutes to run.
+This measure adds many EnergyManagementSystem objects to the model. **DO NOT** change design days after running this measure.  Adding additional HVAC measures after applying this measure may break the model.
+Radiant systems are particularly limited in cooling capacity and the model may have many unmet hours as a result.
+To reduce unmet hours, use an expanded comfort range as mentioned above, remove carpet, reduce internal loads, reduce solar and envelope gains during peak times, or disable the lockout.
+
+## Measure Type
+ModelMeasure
+
+## Taxonomy
+
+
+## Arguments
+
+
+### Remove existing HVAC system (keeps service water heating and zone exhaust fans)
+
+**Name:** remove_existing_hvac,
+**Type:** Boolean,
+**Units:** ,
+**Required:** true,
+**Model Dependent:** false
+
+### Heating Plant Type
+
+**Name:** heating_plant_type,
+**Type:** Choice,
+**Units:** ,
+**Required:** true,
+**Model Dependent:** false
+
+### Cooling Plant Type
+
+**Name:** cooling_plant_type,
+**Type:** Choice,
+**Units:** ,
+**Required:** true,
+**Model Dependent:** false
+
+### Water-side economizer (water cooled chiller only)
+
+**Name:** waterside_economizer,
+**Type:** Choice,
+**Units:** ,
+**Required:** true,
+**Model Dependent:** false
+
+### Radiant System Type
+
+**Name:** radiant_type,
+**Type:** Choice,
+**Units:** ,
+**Required:** true,
+**Model Dependent:** false
+
+### Include carpet over the radiant slab
+Only applicable in radiant floor systems. This will greatly reduce system effectiveness and controllability.
+**Name:** include_carpet,
+**Type:** Boolean,
+**Units:** ,
+**Required:** true,
+**Model Dependent:** false
+
+### Control Strategy
+
+**Name:** control_strategy,
+**Type:** Choice,
+**Units:** ,
+**Required:** true,
+**Model Dependent:** false
+
+### Proportional Gain
+
+**Name:** proportional_gain,
+**Type:** Double,
+**Units:** ,
+**Required:** true,
+**Model Dependent:** false
+
+### Minimum Operating Hours
+Fractional Hours Allowed, e.g. 30 min = 0.5
+**Name:** minimum_operation,
+**Type:** Double,
+**Units:** ,
+**Required:** true,
+**Model Dependent:** false
+
+### Switch Over Time
+Minimum time limitation for when the system can switch between heating and cooling.  Fractional hours allowed, e.g. 30 min = 0.5.
+**Name:** switch_over_time,
+**Type:** Double,
+**Units:** ,
+**Required:** true,
+**Model Dependent:** false
+
+### Enable radiant lockout
+Lockout the radiant system to avoid operating during peak hours.
+**Name:** radiant_lockout,
+**Type:** Boolean,
+**Units:** ,
+**Required:** true,
+**Model Dependent:** false
+
+### Lockout Start Time
+Decimal hour of when radiant lockout starts.  Fractional hours allowed, e.g. 30 min = 0.5.
+**Name:** lockout_start_time,
+**Type:** Double,
+**Units:** ,
+**Required:** true,
+**Model Dependent:** false
+
+### Lockout End Time
+Decimal hour of when radiant lockout ends.  Fractional hours allowed, e.g. 30 min = 0.5.
+**Name:** lockout_end_time,
+**Type:** Double,
+**Units:** ,
+**Required:** true,
+**Model Dependent:** false
+
+### Add output variables for radiant system
+
+**Name:** add_output_variables,
+**Type:** Boolean,
+**Units:** ,
+**Required:** true,
+**Model Dependent:** false
+
+### Standards Template
+Standards template to use for HVAC equipment efficiencies and controls.
+**Name:** standards_template,
+**Type:** Choice,
+**Units:** ,
+**Required:** true,
+**Model Dependent:** false
+
+
+
+

data/lib/measures/radiant_slab_with_doas/README.md.erb

@@ -0,0 +1,42 @@
+<%#= 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 %>