honeybee-openstudio 2.10.4 → 2.11.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4f6244a8a9d855497fd78c192ffbc9ede6cd337a9ed4ed1cbabdf654bb361056
-  data.tar.gz: 5572eb94ca3afea26ea15449e58c762e57973fa763f65671b2855a291b79706f
+  metadata.gz: f86f836af76719222d4ce8393755cd79a6243e52e700c40f54808f72b6d9f2bf
+  data.tar.gz: 98176f5bb8055c871951f56b21717f9f6b3efc35e2b87ae5dbf98520cb2eb954
 SHA512:
-  metadata.gz: 99de2b8728e7529d8046e5d5730c4edb66e159f93ab2776e60cab777d0de22fcc669034340a0d898fc8804f8007532f7df3caa5aaff845b08dce1fdb10f1a677
-  data.tar.gz: d5ab7db18ff0b5f53431d898361314dc1650329da2471d63040590a7c119c4cd43b9b3e63de5bcb8ba7ffa2d83b6a255a9f44dfcf3b7cc41e8fed4f5ee3d217e
+  metadata.gz: 2d2ddb1e445513e442caf0e7ec9846ce9653a25291cead36e00d7b2ca41e3f8b928d5c5a8ffa79880c11d557293c2af22e211b7be525eef32db3ee315ce15209
+  data.tar.gz: 3f69624f318a6d3dc5dc8db9ddafd850dbe487bf9d135996cfa9e1cd91fb286cbb1f49e63fb825f6e19dba79bda98ee396a604e4c8fe2027e2e0249e91a323a9

data/.gitignore

@@ -7,6 +7,7 @@
 /coverage/
 /doc/
 /pkg/
+/spec/coverage/
 /spec/output/
 /spec/reports/
 /spec/test/

data/honeybee-openstudio.gemspec

@@ -4,7 +4,7 @@ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 
 Gem::Specification.new do |spec|
   spec.name          = 'honeybee-openstudio'
-  spec.version       = '2.10.4'
+  spec.version       = '2.11.0'
   spec.authors       = ['Tanushree Charan', 'Dan Macumber', 'Chris Mackey', 'Mostapha Sadeghipour Roudsari']
   spec.email         = ['tanushree.charan@nrel.gov', 'chris@ladybug.tools']
 

data/lib/measures/from_honeybee_model/measure.rb

@@ -60,6 +60,19 @@ class FromHoneybeeModel < OpenStudio::Measure::ModelMeasure
     model_json.setDisplayName('Path to the Honeybee Model JSON file')
     args << model_json
 
+    # Make an argument for schedule csv dir
+    schedule_csv_dir = OpenStudio::Measure::OSArgument.makeStringArgument('schedule_csv_dir', false)
+    schedule_csv_dir.setDisplayName('Directory for exported CSV Schedules')
+    schedule_csv_dir.setDescription('If set, Fixed Interval Schedules will be translated to CSV Schedules in this directory')
+    schedule_csv_dir.setDefaultValue('')
+    args << schedule_csv_dir
+
+    # Make an argument for include datetimes
+    include_datetimes = OpenStudio::Measure::OSArgument.makeBoolArgument('include_datetimes', false)
+    include_datetimes.setDisplayName('Include date time column in exported CSV Schedules')
+    include_datetimes.setDefaultValue(false)
+    args << include_datetimes
+
     return args
   end
 
@@ -72,6 +85,8 @@ class FromHoneybeeModel < OpenStudio::Measure::ModelMeasure
     end
 
     model_json = runner.getStringArgumentValue('model_json', user_arguments)
+    schedule_csv_dir = runner.getStringArgumentValue('schedule_csv_dir', user_arguments)
+    include_datetimes = runner.getBoolArgumentValue('include_datetimes', user_arguments)
 
     if !File.exist?(model_json)
       runner.registerError("Cannot find file '#{model_json}'")
@@ -80,6 +95,14 @@ class FromHoneybeeModel < OpenStudio::Measure::ModelMeasure
 
     honeybee_model = Honeybee::Model.read_from_disk(model_json)
 
+    if schedule_csv_dir && !schedule_csv_dir.empty?
+      if !Dir.exist?(schedule_csv_dir)
+        runner.registerError("Directory for exported CSV Schedules does not exist '#{schedule_csv_dir}'")
+        return false
+      end
+      honeybee_model.set_schedule_csv_dir(schedule_csv_dir, include_datetimes)
+    end
+
     STDOUT.flush
     honeybee_model.to_openstudio_model(model)
     STDOUT.flush

data/lib/to_openstudio/model.rb

@@ -34,9 +34,38 @@ require 'honeybee/model'
 require 'openstudio'
 
 module Honeybee
+
+  def self.write_schedule_csv(schedule_csv_dir, schedule_csv)
+    filename = schedule_csv[:filename]
+    columns = schedule_csv[:columns]
+    if !columns.empty?
+      n = columns[0].size
+      path = File.join(schedule_csv_dir, filename)
+      File.open(path, 'w') do |file|
+        (0...n).each do |i|
+          row = []
+          columns.each do |column|
+            row << column[i]
+          end
+          file.puts row.join(',')
+        end
+      end
+    end
+  end
+
   class Model
 
     attr_reader :openstudio_model
+    attr_reader :schedule_csv_dir, :include_datetimes, :schedule_csvs
+
+    # if a schedule csv dir is specified then ScheduleFixedIntervalAbridged objects
+    # will be translated to ScheduleFile objects instead of ScheduleFixedInterval
+    # the optional schedule_csv_include_datetimes argument controls whether schedule csv
+    # files include a first column of date times for verification
+    def set_schedule_csv_dir(schedule_csv_dir, include_datetimes = false)
+      @schedule_csv_dir = schedule_csv_dir
+      @include_datetimes = include_datetimes
+    end
 
     # convert to openstudio model, clears errors and warnings
     def to_openstudio_model(openstudio_model=nil, log_report=true)
@@ -99,7 +128,7 @@ module Honeybee
         create_schedule_type_limits(@hash[:properties][:energy][:schedule_type_limits])
       end
       if @hash[:properties][:energy][:schedules]
-        create_schedules(@hash[:properties][:energy][:schedules])
+        create_schedules(@hash[:properties][:energy][:schedules], false, true)
       end
 
       if log_report
@@ -283,7 +312,32 @@ module Honeybee
       end
     end
 
-    def create_schedules(schedule_dicts, check_existing=false)
+    def create_schedules(schedule_dicts, check_existing=false, check_leap_year=true)
+
+      # clear out schedule_csvs
+      @schedule_csvs = {}
+
+      if check_leap_year
+        is_leap_year = :unknown
+        schedule_dicts.each do |schedule|
+          # set is leap year = true in case start date has 3 integers
+          this_leap_year = false
+          if schedule[:start_date] && schedule[:start_date][2]
+            this_leap_year = true
+          end
+          if is_leap_year == :unknown
+            is_leap_year = this_leap_year
+          elsif is_leap_year != this_leap_year
+            raise("Mixed leap year information.")
+          end
+        end
+
+        if is_leap_year != :unknown
+          year_description = openstudio_model.getYearDescription
+          year_description.setIsLeapYear(is_leap_year)
+        end
+      end
+
       schedule_dicts.each do |schedule|
         # check if there's already a schedule in the model with the identifier
         add_obj = true
@@ -305,9 +359,15 @@ module Honeybee
           else
             raise("Unknown schedule type #{schedule_type}.")
           end
-          schedule_object.to_openstudio(@openstudio_model)
+          schedule_object.to_openstudio(@openstudio_model, @schedule_csv_dir, @include_datetimes, @schedule_csvs)
         end
       end
+
+      # write schedule csvs
+      @schedule_csvs.each_value do |schedule_csv|
+        Honeybee.write_schedule_csv(@schedule_csv_dir, schedule_csv)
+      end
+
     end
 
     def create_program_types(program_dicts, check_existing=false)
@@ -343,7 +403,7 @@ module Honeybee
       end
       @@standards[:schedules].each do |schedule|
         if schedule[:identifier] == 'Always On'
-          create_schedules([schedule], true)
+          create_schedules([schedule], true, false)
         end
       end
 

data/lib/to_openstudio/schedule/fixed_interval.rb

@@ -42,26 +42,60 @@ module Honeybee
       nil
     end
 
-    def to_openstudio(openstudio_model)
+    def to_openstudio(openstudio_model, schedule_csv_dir = nil, include_datetimes = nil, schedule_csvs = nil)
+      if schedule_csv_dir
+        to_schedule_file(openstudio_model, schedule_csv_dir, include_datetimes, schedule_csvs)
+      else
+        to_schedule_fixed_interval(openstudio_model)
+      end
+    end
+
+    def start_month
+      if @hash[:start_date]
+        return @hash[:start_date][0]
+      end
+      defaults[:start_date][:default][0]
+    end
+
+    def start_day
+      if @hash[:start_date]
+        return @hash[:start_date][1]
+      end
+      defaults[:start_date][:default][1]
+    end
+
+    def interpolate
+      if @hash[:interpolate]
+        return @hash[:interpolate]
+      end
+      defaults[:interpolate][:default]
+    end
+
+    def timestep
+      if @hash[:timestep]
+        return @hash[:timestep]
+      end
+      defaults[:timestep][:default]
+    end
+
+    def placeholder_value
+      if @hash[:placeholder_value]
+        return @hash[:placeholder_value]
+      end
+      defaults[:placeholder_value][:default]
+    end
+
+    def to_schedule_fixed_interval(openstudio_model)
       # create the new schedule
       os_fi_schedule = OpenStudio::Model::ScheduleFixedInterval.new(openstudio_model)
       os_fi_schedule.setName(@hash[:identifier])
 
       # assign start date
-      if @hash[:start_date]
-        os_fi_schedule.setStartMonth(@hash[:start_date][0])
-        os_fi_schedule.setStartDay(@hash[:start_date][1])
-      else
-        os_fi_schedule.setStartMonth(defaults[:start_date][:default][0])
-        os_fi_schedule.setStartDay(defaults[:start_date][:default][1])
-      end
+      os_fi_schedule.setStartMonth(start_month)
+      os_fi_schedule.setStartDay(start_day)
 
       # assign the interpolate value
-      unless @hash[:interpolate].nil?
-        os_fi_schedule.setInterpolatetoTimestep(@hash[:interpolate])
-      else
-        os_fi_schedule.setInterpolatetoTimestep(defaults[:interpolate][:default])
-      end
+      os_fi_schedule.setInterpolatetoTimestep(interpolate)
 
       # assign the schedule type limit
       if @hash[:schedule_type_limit]
@@ -73,32 +107,114 @@ module Honeybee
       end
 
       # assign the timestep
-      if @hash[:timestep]
-        timestep = @hash[:timestep]
-        interval_length = 60 / timestep
-        os_fi_schedule.setIntervalLength(interval_length)
-      else
-        timestep = defaults[:timestep][:default]
-        interval_length = 60 / timestep
-        os_fi_schedule.setIntervalLength(interval_length)
-      end
+      interval_length = 60 / timestep
+      os_fi_schedule.setIntervalLength(interval_length)
       openstudio_interval_length = OpenStudio::Time.new(0, 0, interval_length)
 
       # assign the values as a timeseries
       year_description = openstudio_model.getYearDescription
+      start_date = year_description.makeDate(start_month, start_day)
+      timeseries = OpenStudio::TimeSeries.new(start_date, openstudio_interval_length, OpenStudio.createVector(@hash[:values]), '')
+      os_fi_schedule.setTimeSeries(timeseries)
 
-      # set is leap year = true in case start date has 3 integers
-      if @hash[:start_date][2]
-        year_description.setIsLeapYear(true)
-      end
+      os_fi_schedule
+    end
+
+    def to_schedule_file(openstudio_model, schedule_csv_dir, include_datetimes, schedule_csvs)
+
+      # in order to combine schedules in the same csv file they must have the same key
+      schedule_key = "#{@hash[:identifier]}_#{start_month}_#{start_day}_#{timestep}"
 
-      start_date = year_description.makeDate(@hash[:start_date][0], @hash[:start_date][1])
+      # get start and end date times
+      yd = openstudio_model.getYearDescription
+      date_time = OpenStudio::DateTime.new(yd.makeDate(1, 1), OpenStudio::Time.new(0,0,0))
+      start_date_time = OpenStudio::DateTime.new(yd.makeDate(start_month, start_day), OpenStudio::Time.new(0,0,0))
+      end_date_time = OpenStudio::DateTime.new(yd.makeDate(12, 31), OpenStudio::Time.new(1,0,0))
 
+      # get timestep
+      interval_length = 60 / timestep
+      dt = OpenStudio::Time.new(0, 0, interval_length, 0)
+
+      # get values and date times
       values = @hash[:values]
-      timeseries = OpenStudio::TimeSeries.new(start_date, openstudio_interval_length, OpenStudio.createVector(values), '')
-      os_fi_schedule.setTimeSeries(timeseries)
+      num_values = values.size
+      i_values = 0
+      padded_values = []
+      date_times = []
+      pv = placeholder_value
 
-      os_fi_schedule
+      while date_time < end_date_time
+        date = date_time.date
+        time = date_time.time
+        date_times << "#{date.dayOfMonth} #{date.monthOfYear.valueName} #{time.hours.to_s.rjust(2,'0')}:#{time.minutes.to_s.rjust(2,'0')}"
+
+        if date_time < start_date_time
+          padded_values << pv
+        elsif i_values < num_values
+          padded_values << values[i_values]
+          i_values += 1
+        else
+          padded_values << pv
+        end
+
+        date_time += dt
+      end
+
+
+      # find or create the schedule csv object which will hold the filename and columns
+      filename = nil
+      columns = nil
+      os_external_file = nil
+      schedule_csv = schedule_csvs[schedule_key]
+      if schedule_csv.nil?
+        # file name to write
+        filename = "#{@hash[:identifier]}.csv".gsub(' ', '_')
+
+        # columns of data
+        columns = []
+        if include_datetimes
+          columns << ['Date Times'].concat(date_times)
+        end
+
+        # schedule csv file must exist even though it has no content yet
+        path = File.join(schedule_csv_dir, filename)
+        if !File.exist?(path)
+          File.open(path, 'w') {|f| f.puts ''}
+        end
+
+        # get the external file which points to the schedule csv file
+        os_external_file = OpenStudio::Model::ExternalFile.getExternalFile(openstudio_model, filename)
+        os_external_file = os_external_file.get
+
+        schedule_csv = {filename: filename, columns: columns, os_external_file: os_external_file}
+        schedule_csvs[schedule_key] = schedule_csv
+      else
+        filename = schedule_csv[:filename]
+        columns = schedule_csv[:columns]
+        os_external_file = schedule_csv[:os_external_file]
+      end
+
+      # insert the padded_values to write later
+      columns << [@hash[:identifier]].concat(padded_values)
+
+      # create the schedule file
+      column = columns.size # 1 based index
+      rowsToSkip = 1
+      os_schedule_file = OpenStudio::Model::ScheduleFile.new(os_external_file, column, rowsToSkip)
+      os_schedule_file.setName(@hash[:identifier])
+      os_schedule_file.setInterpolatetoTimestep(interpolate)
+      os_schedule_file.setMinutesperItem(interval_length.to_s)
+
+      # assign the schedule type limit
+      if @hash[:schedule_type_limit]
+        schedule_type_limit = openstudio_model.getScheduleTypeLimitsByName(@hash[:schedule_type_limit])
+        unless schedule_type_limit.empty?
+          schedule_type_limit_object = schedule_type_limit.get
+          os_schedule_file.setScheduleTypeLimits(schedule_type_limit_object)
+        end
+      end
+
+      os_schedule_file
     end
 
   end #ScheduleFixedIntervalAbridged

data/lib/to_openstudio/schedule/ruleset.rb

@@ -42,7 +42,8 @@ module Honeybee
       nil
     end
 
-    def to_openstudio(openstudio_model)
+    def to_openstudio(openstudio_model, schedule_csv_dir = nil, include_datetimes = nil, schedule_csvs = nil)
+
       # create openstudio schedule ruleset object
       os_sch_ruleset = OpenStudio::Model::ScheduleRuleset.new(openstudio_model)
       os_sch_ruleset.setName(@hash[:identifier])

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: honeybee-openstudio
 version: !ruby/object:Gem::Version
-  version: 2.10.4
+  version: 2.11.0
 platform: ruby
 authors:
 - Tanushree Charan
@@ -11,7 +11,7 @@ authors:
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2021-01-02 00:00:00.000000000 Z
+date: 2021-01-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler