Merge pull request #31 from NREL/dfg_sch_ruleset

Dfg sch ruleset - bring in all schedules as ScheduleRuleset and hooking up to load instances

Author: David Goldwasser

measures/advanced_import_gbxml/measure.rb

@@ -94,6 +94,8 @@ def run(model, runner, user_arguments)
     advanced_inputs[:spaces] = {}
     advanced_inputs[:schedule_sets] = {} # key is "light|equip|people|"
     advanced_inputs[:schedules] = {}
+    advanced_inputs[:week_schedules] = {}
+    advanced_inputs[:day_schedules] = {}
     advanced_inputs[:people_num] = {} # osm gen code should use default if this isn't found
     advanced_inputs[:people_defs] = {}
     advanced_inputs[:light_defs] = {}
@@ -120,12 +122,6 @@ def run(model, runner, user_arguments)
           advanced_inputs[:schedule_sets][target_sch_set_key][:equipment_schedule_id_ref] = elec_sch
           advanced_inputs[:schedule_sets][target_sch_set_key][:people_schedule_id_ref] = occ_sch
 
-          [light_sch,elec_sch,occ_sch].each do |sch_id|
-            next if sch_id.nil?
-            if ! advanced_inputs[:schedules].has_key?(sch_id)
-              advanced_inputs[:schedules][sch_id] = {} # todo - populate hash
-            end
-          end
         end
       end
 
@@ -185,7 +181,6 @@ def run(model, runner, user_arguments)
     end
 
     puts "**Looping through schedules"
-    # todo - import schedules that were not associated with space loads?
     # note, schedules and schedule sets will be generated as used when looping through spaces
     gbxml_doc.elements.each('gbXML/Schedule') do |element|
       name = element.elements['Name']
@@ -194,6 +189,50 @@ def run(model, runner, user_arguments)
       else
         puts "Schedule #{element.attributes['id']} does not have a name"
       end
+      # add schedules to hash with array of week schedules
+      # todo - get sample with multiple WeekScheduleId objects and support that in schedule generation
+      sch_week = element.elements['YearSchedule/WeekScheduleId'].attributes['weekScheduleIdRef']
+      advanced_inputs[:schedules][element.attributes['id']] = {'name' => name.text, 'sch_week' => sch_week}
+    end
+
+    runner.registerInfo("removing ScheduleYear, ScheduleWeek, and ScheduleDay, objects. That data will be re-imported as ScheduleRuleset")
+    model.getScheduleYears.each { |year| year.remove }
+    model.getScheduleWeeks.each { |week| week.remove }
+    model.getScheduleDays.each { |day| day.remove }
+
+    puts "**Looping through week schedules"
+    # note, schedules and schedule sets will be generated as used when looping through spaces
+    gbxml_doc.elements.each('gbXML/WeekSchedule') do |element|
+      name = element.elements['Name']
+      if ! name.nil?
+        puts name.text
+      else
+        puts "WeekSchedule #{element.attributes['id']} does not have a name"
+      end
+      # add schedules to hash with array of week schedules
+      day_types = {}
+      element.elements.each do |day_type|
+        next if !day_type.attributes.has_key?('dayType')
+        day_types[day_type.attributes['dayType']] = day_type.attributes['dayScheduleIdRef']
+      end
+      advanced_inputs[:week_schedules][element.attributes['id']] = day_types
+    end
+
+    puts "**Looping through day schedules"
+    # note, schedules and schedule sets will be generated as used when looping through spaces
+    gbxml_doc.elements.each('gbXML/DaySchedule') do |element|
+      name = element.elements['Name']
+      if ! name.nil?
+        puts name.text
+      else
+        puts "DaySchedule #{element.attributes['id']} does not have a name"
+      end
+      # add schedules to hash with array of week schedules
+      hourly_values = []
+      element.elements.each('ScheduleValue') do |hour|
+        hourly_values << hour.text.to_f
+      end
+      advanced_inputs[:day_schedules][element.attributes['id']] = hourly_values
     end
 
     puts "**Looping through zones"
@@ -236,19 +275,25 @@ def run(model, runner, user_arguments)
       end
     end
 
+=begin
     # todo - remove temp code to inspect hash
     puts "** inspecting space hash"
     puts advanced_inputs[:spaces]
     puts "** inspecting schedule set hash"
     puts advanced_inputs[:schedule_sets]
     puts "** inspecting schedule hash"
     puts advanced_inputs[:schedules]
+    puts "** inspecting week schedule hash"
+    puts advanced_inputs[:week_schedules]
+    puts "** inspecting day schedule hash"
+    puts advanced_inputs[:day_schedules]
     puts "** inspecting lights"
     puts advanced_inputs[:light_defs]
     puts "** inspecting elec equip"
     puts advanced_inputs[:equip_defs]
     puts "** inspecting people"
     puts advanced_inputs[:people_defs]
+=end
 
     # create model objects from hash
     OsLib_AdvImport.add_objects_from_adv_import_hash(runner,model,advanced_inputs)

measures/advanced_import_gbxml/measure.xml

@@ -2,8 +2,8 @@
   <schema_version>3.0</schema_version>
   <name>advanced_import_gbxml</name>
   <uid>f82940f7-8046-4fd1-9dbb-df6411e86de2</uid>
-  <version_id>8ebb625a-3eee-4eb3-974b-91907896eea7</version_id>
-  <version_modified>20180816T171715Z</version_modified>
+  <version_id>085bb2f6-7320-4a39-9ae1-63283ed068f4</version_id>
+  <version_modified>20181011T202835Z</version_modified>
   <xml_checksum>D8922A73</xml_checksum>
   <class_name>AdvancedImportGbxml</class_name>
   <display_name>Advanced Import Gbxml</display_name>
@@ -89,29 +89,12 @@
       <usage_type>resource</usage_type>
       <checksum>5F1CEF3A</checksum>
     </file>
-    <file>
-      <version>
-        <software_program>OpenStudio</software_program>
-        <identifier>2.6.0</identifier>
-        <min_compatible>2.6.0</min_compatible>
-      </version>
-      <filename>measure.rb</filename>
-      <filetype>rb</filetype>
-      <usage_type>script</usage_type>
-      <checksum>9F7573ED</checksum>
-    </file>
     <file>
       <filename>advanced_import_gbxml_test.rb</filename>
       <filetype>rb</filetype>
       <usage_type>test</usage_type>
       <checksum>9144BE24</checksum>
     </file>
-    <file>
-      <filename>os_lib_adv_import.rb</filename>
-      <filetype>rb</filetype>
-      <usage_type>resource</usage_type>
-      <checksum>34DB316B</checksum>
-    </file>
     <file>
       <filename>Test Villa Scenario 2_alt_a.xml</filename>
       <filetype>xml</filetype>
@@ -124,5 +107,22 @@
       <usage_type>doc</usage_type>
       <checksum>00000000</checksum>
     </file>
+    <file>
+      <version>
+        <software_program>OpenStudio</software_program>
+        <identifier>2.6.0</identifier>
+        <min_compatible>2.6.0</min_compatible>
+      </version>
+      <filename>measure.rb</filename>
+      <filetype>rb</filetype>
+      <usage_type>script</usage_type>
+      <checksum>E3A8A0A5</checksum>
+    </file>
+    <file>
+      <filename>os_lib_adv_import.rb</filename>
+      <filetype>rb</filetype>
+      <usage_type>resource</usage_type>
+      <checksum>1FEE8F25</checksum>
+    </file>
   </files>
 </measure>

measures/advanced_import_gbxml/resources/os_lib_adv_import.rb

@@ -43,7 +43,7 @@ module OsLib_AdvImport
   def self.add_objects_from_adv_import_hash(runner, model, advanced_inputs)
 
     # make schedules
-    schedules = import_schs(runner, model, advanced_inputs[:schedules])
+    schedules = import_schs(runner, model, advanced_inputs[:schedules],advanced_inputs[:week_schedules],advanced_inputs[:day_schedules])
 
     # make schedules sets
     schedule_sets = import_sch_set(runner, model, advanced_inputs[:schedule_sets], schedules)
@@ -148,17 +148,101 @@ def self.assign_space_attributes(runner, model, spaces, schedule_sets, lights, e
   end
 
   # create ruleset schedule from inputs
-  def self.import_schs(runner, model, schedules)
+  def self.import_schs(runner, model, schedules, week_schedules, day_schedules)
 
     # loop through and add schedules
     new_schedules = {}
+
+    # process schedule data
     schedules.each do |id, schedule_data|
-      # todo - populate schedule using schedule_data to update default profile and add rules to complex schedule
-      options = {'name' => id, 'default_day' => ['always_on', [24.0, 0.3]]}
+
+      # get schedule name
+      if !schedule_data['name'].nil?
+        ruleset_name = schedule_data['name']
+      else
+        ruleset_name = id
+      end
+      date_range = '1/1-12/31' # todo - in future pull form gbxml
+      winter_design_day = nil
+      summer_design_day = nil
+      default_day = nil
+      rules = []
+
+      # get WeekSchedule
+      week_schs = week_schedules[schedule_data['sch_week']]
+
+      # loop through dayTypes
+      week_schs.each do |day_type,day_obj|
+
+        # get associated dayType items
+        time_value_array_raw = []
+        day_schedules[day_obj].each_with_index do  |value,i|
+          time_value_array_raw << [i+1,value]
+        end
+
+        # clean up excess values
+        time_value_array = []
+        last_val = nil
+        time_value_array_raw.reverse.each do |time_val|
+          if last_val.nil?
+            time_value_array << time_val
+          elsif last_val != time_val[1]
+            time_value_array << time_val
+          end
+          last_val = time_val[1]
+        end
+        time_value_array = time_value_array.reverse
+
+        # create default profile, rule, or design day #
+        if day_type == "HeatingDesignDay"
+          winter_design_day = time_value_array
+        elsif day_type == "CoolingDesignDay"
+          summer_design_day = time_value_array
+        elsif day_type == "Holiday"
+          # do nothing, not currently supporting holidays
+        elsif default_day.nil?
+          default_day = time_value_array.insert(0,day_type) #day_type is name of default day profile object
+        elsif day_type == "All"
+          prefix_array = [day_type,date_range,'Mon/Tue/Wed/Thu/Fri/Sat/Sun']
+          rules << prefix_array + time_value_array
+        elsif day_type == "Weekday"
+          prefix_array = [day_type,date_range,'Mon/Tue/Wed/Thu/Fri']
+          rules << prefix_array + time_value_array
+        elsif day_type == "Sat"
+          prefix_array = [day_type,date_range,'Sat']
+          rules << prefix_array + time_value_array
+        elsif day_type == "Sun"
+          prefix_array = [day_type,date_range,'Sun']
+          rules << prefix_array + time_value_array
+        elsif day_type == "Mon"
+          prefix_array = [day_type,date_range,'Mon']
+          rules << prefix_array + time_value_array
+        elsif day_type == "Tue"
+          prefix_array = [day_type,date_range,'Tue']
+          rules << prefix_array + time_value_array
+        elsif day_type == "Wed"
+          prefix_array = [day_type,date_range,'Wed']
+          rules << prefix_array + time_value_array
+        elsif day_type == "Thu" #todo - confirm weekday abbreviations
+          prefix_array = [day_type,date_range,'Thu']
+          rules << prefix_array + time_value_array
+        elsif day_type == "Fri"
+          prefix_array = [day_type,date_range,'Fri']
+          rules << prefix_array + time_value_array
+        end
+      end
+
+      # populate schedule using schedule_data to update default profile and add rules to complex schedule
+      options = { 'name' => ruleset_name,
+                  'winter_design_day' => winter_design_day,
+                  'summer_design_day' => summer_design_day,
+                  'default_day' => default_day,
+                  'rules' => rules }
+
       sch_ruleset = OsLib_Schedules.createComplexSchedule(model, options)
       new_schedules[id] = sch_ruleset
     end
-    runner.registerInfo("Created #{new_schedules.size} new Schedule Ruleset objets.")
+    runner.registerInfo("Created #{new_schedules.size} new ScheduleRuleset objects (not including activity schedules).")
 
     return new_schedules
   end
@@ -186,7 +270,7 @@ def self.import_sch_set(runner, model, schedule_sets, schedules)
         default_sch_set.setNumberofPeopleSchedule(target_sch)
       end
     end
-    runner.registerInfo("Created #{new_schedule_sets.size} new Default Schedule Set objets.")
+    runner.registerInfo("Created #{new_schedule_sets.size} new DefaultScheduleSet objects.")
 
     return new_schedule_sets
   end