Class: AddMonthlyUtilityData

Inherits:
OpenStudio::Measure::ModelMeasure
  • Object
show all
Defined in:
lib/measures/AddMonthlyUtilityData/measure.rb

Overview

start the measure

Instance Method Summary collapse

Instance Method Details

#arguments(_model) ⇒ Object

define the arguments that the user will input



40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
 
# File 'lib/measures/AddMonthlyUtilityData/measure.rb', line 40

def arguments(_model)
  args = OpenStudio::Measure::OSArgumentVector.new

  # make an electric json argument
  electric_json = OpenStudio::Measure::OSArgument.makeStringArgument('electric_json', true)
  electric_json.setDisplayName('Path to electric JSON')
  args << electric_json

  # make a gas json argument
  gas_json = OpenStudio::Measure::OSArgument.makeStringArgument('gas_json', true)
  gas_json.setDisplayName('Path to gas JSON')
  args << gas_json

  water_json = OpenStudio::Measure::OSArgument.makeStringArgument('water_json', false)
  water_json.setDisplayName('Path to water JSON')
  args << water_json

  # make a start date argument
  start_date = OpenStudio::Measure::OSArgument.makeStringArgument('start_date', true)
  start_date.setDisplayName('Start date')
  start_date.setDescription('YYYY-MM-DD format')
  args << start_date

  # make an end date argument
  end_date = OpenStudio::Measure::OSArgument.makeStringArgument('end_date', true)
  end_date.setDisplayName('End date')
  end_date.setDescription('YYYY-MM-DD format')
  args << end_date

  args
end

#name ⇒ Object

define the name that a user will see, this method may be deprecated as the display name in PAT comes from the name field in measure.xml



22
23
24
 
# File 'lib/measures/AddMonthlyUtilityData/measure.rb', line 22

def name
  'AddMonthlyUtilityData'
end

#run(model, runner, user_arguments) ⇒ Object

define what happens when the measure is run



73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
 
# File 'lib/measures/AddMonthlyUtilityData/measure.rb', line 73

def run(model, runner, user_arguments)
  super(model, runner, user_arguments)

  # use the built-in error checking
  unless runner.validateUserArguments(arguments(model), user_arguments)
    return false
  end

  # assign the user inputs to variables
  electric_json = runner.getStringArgumentValue('electric_json', user_arguments)
  gas_json = runner.getStringArgumentValue('gas_json', user_arguments)
  water_json = runner.getOptionalStringArgumentValue('water_json', user_arguments)
  start_date = runner.getStringArgumentValue('start_date', user_arguments)
  end_date = runner.getStringArgumentValue('end_date', user_arguments)

  # set start date
  if date = year_month_day(start_date)

    start_date = OpenStudio::Date.new(OpenStudio::MonthOfYear.new(date[1]), date[2], date[0])

    # actual year of start date
    yearDescription = model.getYearDescription
    yearDescription.setCalendarYear(date[0])

    runPeriod = model.getRunPeriod
    runPeriod.setBeginMonth(date[1])
    runPeriod.setBeginDayOfMonth(date[2])
  else
    runner.registerError("Unknown start date '#{start_date}'")
    raise "Unknown start date '#{start_date}'"
    return false
  end

  # set end date
  if date = year_month_day(end_date)

    end_date = OpenStudio::Date.new(OpenStudio::MonthOfYear.new(date[1]), date[2], date[0])

    runPeriod = model.getRunPeriod
    runPeriod.setEndMonth(date[1])
    runPeriod.setEndDayOfMonth(date[2])
  else
    runner.registerError("Unknown end date '#{end_date}'")
    raise "Unknown end date '#{end_date}'"
    return false
  end

  # remove all utility bills
  model.getUtilityBills.each(&:remove)
  runner.registerInfo("electric_json is #{electric_json}")
  electric_json_path = File.expand_path(electric_json.to_s, __FILE__)
  runner.registerInfo("electric_json_path is #{electric_json_path}")
  temp = File.read(electric_json_path)
  electric_data = JSON.parse(temp)
  unless electric_data.nil?

    utilityBill = OpenStudio::Model::UtilityBill.new('Electricity'.to_FuelType, model)
    utilityBill.setName('Electric Bill')
    utilityBill.setConsumptionUnit('kWh')
    utilityBill.setPeakDemandUnit('kW')

    electric_data['data'].each do |period|
      from_date = period['from'] ? Time.iso8601(period['from']).strftime('%Y%m%dT%H%M%S') : nil
      to_date = period['to'] ? Time.iso8601(period['to']).strftime('%Y%m%dT%H%M%S') : nil

      if from_date.nil? || to_date.nil?
        runner.registerError("Unknown date format in period '#{period}'")
        raise "Unknown date format in period '#{period}'"
        return false
      end

      period_start_date = OpenStudio::DateTime.fromISO8601(from_date).get.date
      # period_start_date = OpenStudio::Date.new(OpenStudio::MonthOfYear.new(from_date[1]), from_date[2], from_date[0])
      period_end_date = OpenStudio::DateTime.fromISO8601(to_date).get.date - OpenStudio::Time.new(1.0)
      # period_end_date = OpenStudio::Date.new(OpenStudio::MonthOfYear.new(to_date[1]), to_date[2], to_date[0])

      if (period_start_date < start_date) || (period_end_date > end_date)
        runner.registerInfo("skipping period #{period_start_date} to #{period_end_date}")
        next
      end

      if period['tot_kwh'].nil?
        runner.registerError("Billing period missing tot_kwh '#{period}'")
        return false
      end
      tot_kwh = period['tot_kwh'].to_f

      peak_kw = nil
      peak_kw = period['peak_kw'].to_f unless period['peak_kw'].nil?

      runner.registerInfo("electric period #{period}")
      runner.registerInfo("electric period_start_date: #{period_start_date}, period_end_date: #{period_end_date}, tot_kwh: #{tot_kwh}, peak_kw: #{peak_kw}")

      bp = utilityBill.addBillingPeriod
      bp.setStartDate(period_start_date)
      bp.setEndDate(period_end_date)
      bp.setConsumption(tot_kwh)
      bp.setPeakDemand(peak_kw) if peak_kw
    end
  end
  runner.registerInfo("gas_json is #{gas_json}")
  gas_json_path = File.expand_path(gas_json.to_s, __FILE__)
  runner.registerInfo("gas_json_path is #{gas_json_path}")
  temp = File.read(gas_json_path)
  gas_data = JSON.parse(temp)
  unless gas_data.nil?

    utilityBill = OpenStudio::Model::UtilityBill.new('Gas'.to_FuelType, model)
    utilityBill.setName('Gas Bill')
    utilityBill.setConsumptionUnit('therms')

    gas_data['data'].each do |period|
      from_date = period['from'] ? Time.iso8601(period['from']).strftime('%Y%m%dT%H%M%S') : nil
      to_date = period['to'] ? Time.iso8601(period['to']).strftime('%Y%m%dT%H%M%S') : nil

      if from_date.nil? || to_date.nil?
        runner.registerError("Unknown date format in period '#{period}'")
        raise "Unknown date format in period '#{period}'"
        return false
      end

      period_start_date = OpenStudio::DateTime.fromISO8601(from_date).get.date
      # period_start_date = OpenStudio::Date.new(OpenStudio::MonthOfYear.new(from_date[1]), from_date[2], from_date[0])
      period_end_date = OpenStudio::DateTime.fromISO8601(to_date).get.date - OpenStudio::Time.new(1.0)
      # period_end_date = OpenStudio::Date.new(OpenStudio::MonthOfYear.new(to_date[1]), to_date[2], to_date[0])

      if (period_start_date < start_date) || (period_end_date > end_date)
        runner.registerInfo("skipping period #{period_start_date} to #{period_end_date}")
        next
      end

      if period['tot_therms'].nil?
        runner.registerError("Billing period missing tot_therms '#{period}'")
        return false
      end
      tot_therms = period['tot_therms'].to_f

      runner.registerInfo("gas period: #{period}")
      runner.registerInfo("gas period_start_date: #{period_start_date}, period_end_date: #{period_end_date}, tot_therms: #{tot_therms}")

      bp = utilityBill.addBillingPeriod
      bp.setStartDate(period_start_date)
      bp.setEndDate(period_end_date)
      bp.setConsumption(tot_therms)
    end
  end

  # water bills
  if water_json.is_initialized

    runner.registerInfo("water_json is #{water_json}")
    water_json_path = File.expand_path(water_json.to_s, __FILE__)
    runner.registerInfo("water_json_path is #{water_json_path}")
    temp = File.read(water_json_path)
    water_data = JSON.parse(temp)

    if water_data

      utilityBill = OpenStudio::Model::UtilityBill.new('Water'.to_FuelType, model)
      utilityBill.setName('Water Bill')
      utilityBill.setConsumptionUnit('gal')
      # utilityBill.setPeakDemandUnit("kW")

      water_data['data'].each do |period|
        from_date = period['from'] ? Time.iso8601(period['from']).strftime('%Y%m%dT%H%M%S') : nil
        to_date = period['to'] ? Time.iso8601(period['to']).strftime('%Y%m%dT%H%M%S') : nil

        if from_date.nil? || to_date.nil?
          runner.registerError("Unknown date format in period '#{period}'")
          raise "Unknown date format in period '#{period}'"
          return false
        end

        period_start_date = OpenStudio::DateTime.fromISO8601(from_date).get.date
        # period_start_date = OpenStudio::Date.new(OpenStudio::MonthOfYear.new(from_date[1]), from_date[2], from_date[0])
        period_end_date = OpenStudio::DateTime.fromISO8601(to_date).get.date - OpenStudio::Time.new(1.0)
        # period_end_date = OpenStudio::Date.new(OpenStudio::MonthOfYear.new(to_date[1]), to_date[2], to_date[0])

        if (period_start_date < start_date) || (period_end_date > end_date)
          runner.registerInfo("skipping period #{period_start_date} to #{period_end_date}")
          next
        end

        if period['tot_gal'].nil?
          runner.registerError("Billing period missing tot_gal '#{period}'")
          return false
        end
        tot_gal = period['tot_gal'].to_f

        tot_cost = nil
        tot_cost = period['tot_cost'].to_f if period['tot_cost']

        runner.registerInfo("water period #{period}")
        runner.registerInfo("water period_start_date: #{period_start_date}, period_end_date: #{period_end_date}")

        bp = utilityBill.addBillingPeriod
        bp.setStartDate(period_start_date)
        bp.setEndDate(period_end_date)
        bp.setConsumption(tot_gal)
      end
    end
  end

  # reporting final condition of model
  runner.registerFinalCondition('Utility bill data has been added to the model.')

  true
end

#year_month_day(str) ⇒ Object 



26
27
28
29
30
31
32
33
34
35
36
37
 
# File 'lib/measures/AddMonthlyUtilityData/measure.rb', line 26

def year_month_day(str)
  result = nil
  if match_data = /(\d+)-(\d+)-(\d+)/.match(str)
    year = match_data[1].to_i
    month = match_data[2].to_i
    day = match_data[3].to_i
    result = [year, month, day]
  else
    puts "no match for '#{str}'"
  end
  result
end