Class: OpenStudio::Workflow::InputAdapter::Local

Inherits:
Object
  • Object
show all
Defined in:
lib/openstudio/workflow/adapters/input/local.rb

Instance Method Summary collapse

Constructor Details

#initialize(osw_path = './workflow.osw') ⇒ Local

Returns a new instance of Local.



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
71
72
73
74
75
76
 
# File 'lib/openstudio/workflow/adapters/input/local.rb', line 45

def initialize(osw_path = './workflow.osw')
  @osw_abs_path = File.absolute_path(osw_path, Dir.pwd)

  @workflow = nil
  if File.exist? @osw_abs_path
    @workflow = ::JSON.parse(File.read(@osw_abs_path), symbolize_names: true)
  end

  begin
    # configure the OSW with paths for loaded extension gems
    # Bundler.require is called in the CLI to load extension gems
    @workflow = OpenStudio::Extension.configure_osw(@workflow)
  rescue NameError => e
  end

  @workflow_json = nil
  @run_options = nil
  if @workflow
    begin
      # Create a temporary WorkflowJSON, will not be same one used in registry during simulation
      @workflow_json = OpenStudio::WorkflowJSON.new(JSON.fast_generate(workflow))
      @workflow_json.setOswDir(osw_dir)
    rescue NameError => e
      @workflow_json = WorkflowJSON_Shim.new(workflow, osw_dir)
    end

    begin
      @run_options = @workflow_json.runOptions
    rescue StandardError
    end
  end
end

Instance Method Details

#analysis ⇒ Object

Get the associated OSA (analysis) definition from the local filesystem



415
416
417
418
419
420
421
422
423
 
# File 'lib/openstudio/workflow/adapters/input/local.rb', line 415

def analysis
  # DLM: should this come from the OSW?  the osd id and checksum are specified there.
  osa_abs_path = File.join(osw_dir, '../analysis.json')
  result = nil
  if File.exist? osa_abs_path
    result = ::JSON.parse(File.read(osa_abs_path), symbolize_names: true)
  end
  return result
end

#cleanup(user_options, default) ⇒ Object 



261
262
263
264
265
266
267
268
269
270
271
 
# File 'lib/openstudio/workflow/adapters/input/local.rb', line 261

def cleanup(user_options, default)
  # user option trumps all others
  return user_options[:cleanup] if user_options[:cleanup]

  # try to read from OSW
  if @run_options && !@run_options.empty?
    return @run_options.get.cleanup
  end

  return default
end

#datapoint ⇒ Object

Get the associated OSD (datapoint) file from the local filesystem



403
404
405
406
407
408
409
410
411
 
# File 'lib/openstudio/workflow/adapters/input/local.rb', line 403

def datapoint
  # DLM: should this come from the OSW?  the osd id and checksum are specified there.
  osd_abs_path = File.join(osw_dir, 'datapoint.osd')
  result = nil
  if File.exist? osd_abs_path
    result = ::JSON.parse(File.read(osd_abs_path), symbolize_names: true)
  end
  return result
end

#debug(user_options, default) ⇒ Object 



165
166
167
168
169
170
171
172
173
174
175
 
# File 'lib/openstudio/workflow/adapters/input/local.rb', line 165

def debug(user_options, default)
  # user option trumps all others
  return user_options[:debug] if user_options[:debug]

  # try to read from OSW
  if @run_options && !@run_options.empty?
    return @run_options.get.debug
  end

  return default
end

#energyplus_path(user_options, default) ⇒ Object 



273
274
275
276
277
278
 
# File 'lib/openstudio/workflow/adapters/input/local.rb', line 273

def energyplus_path(user_options, default)
  # user option trumps all others
  return user_options[:energyplus_path] if user_options[:energyplus_path]

  return default
end

#epjson(user_options, default, logger) ⇒ Object 



294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
 
# File 'lib/openstudio/workflow/adapters/input/local.rb', line 294

def epjson(user_options, default, logger)
  # check version for this feature
  os_version = OpenStudio::VersionString.new(OpenStudio.openStudioVersion)
  min_version_feature = OpenStudio::VersionString.new('3.3.0')
  unless os_version >= min_version_feature
    log_message = 'epJSON is only supported for versions >= 3.3.0. Falling back to using IDF'
    logger.info log_message
    return default
  end

  # user option trumps all others
  return user_options[:epjson] if user_options[:epjson]

  # try to read from OSW

  if @run_options.is_initialized && @run_options.get.respond_to?(:epjson)
    return @run_options.get.epjson
  end

  return default
end

#fast(user_options, default) ⇒ Object 



177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
 
# File 'lib/openstudio/workflow/adapters/input/local.rb', line 177

def fast(user_options, default)
  # user option trumps all others
  return user_options[:fast] if user_options[:fast]

  # try to read from OSW
  if @run_options && !@run_options.empty?
    if @run_options.get.respond_to?(:fast)
      return @run_options.get.fast
    else
      if @workflow[:run_options]
        return @workflow[:run_options][:fast]
      end
    end
  end

  return default
end

#ft_options(user_options, default, logger) ⇒ Object

Process the ‘run` method `ft_options` subhash

This will validate that each suboption is supported in the current version as well as enhance the hash with the corresponding ForwardTranslator method name to set the value on the FT later in ‘translate_to_energyplus` user option trumps all others



323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
 
# File 'lib/openstudio/workflow/adapters/input/local.rb', line 323

def ft_options(user_options, default, logger)
  # check version for this feature
  os_version = OpenStudio::VersionString.new(OpenStudio.openStudioVersion)

  os300 = OpenStudio::VersionString.new('3.0.0')
  os330 = OpenStudio::VersionString.new('3.3.0')
  known_ft_opts = {
    # All Versions
    runcontrolspecialdays: { method_name: :setKeepRunControlSpecialDays, min_version: nil },
    ip_tabular_output: { method_name: :setIPTabularOutput, min_version: nil },
    no_lifecyclecosts: { method_name: :setExcludeLCCObjects, min_version: nil },
    # 3.0.0
    no_sqlite_output: { method_name: :setExcludeSQliteOutputReport, min_version: os300 },
    no_html_output: { method_name: :setExcludeHTMLOutputReport, min_version: os300 },
    no_variable_dictionary: { method_name: :setExcludeVariableDictionary, min_version: os300 },
    # 3.3.0
    no_space_translation: { method_name: :setExcludeSpaceTranslation, min_version: os330 }
  }

  # user option trumps all others
  if user_options[:ft_options]
    ft_opts = {}
    user_options[:ft_options].each do |opt_flag_name, opt_flag|
      puts "#{opt_flag_name} = #{opt_flag}"
      unless known_ft_opts.key?(opt_flag_name)
        log_message = "'ft_options' suboption '#{opt_flag_name}' is not recognized, ignoring it."
        logger.warn log_message
        next
      end
      min_version = known_ft_opts[opt_flag_name][:min_version]
      if !min_version.nil? && os_version < min_version
        log_message = "'ft_options' suboption '#{opt_flag_name}' is only supported for OpenStudio Version >= #{min_version.str}, ignoring it."
        logger.warn log_message
        next
      end
      ft_opts[opt_flag_name] = { method_name: known_ft_opts[opt_flag_name][:method_name], value: opt_flag }
    end

    return ft_opts
  end

  # try to read from OSW

  if @run_options.is_initialized && @run_options.get.respond_to?(:forwardTranslateOptions) && !@run_options.get.forwardTranslateOptions().empty?
    ft_opts = {}
    JSON.parse(@run_options.get.forwardTranslateOptions, symbolize_names: true).each do |opt_flag_name, opt_flag|
      unless known_ft_opts.key?(opt_flag_name)
        log_message = "'ft_options' suboption '#{opt_flag_name}' is not recognized, ignoring it."
        logger.warn log_message
        next
      end
      min_version = known_ft_opts[opt_flag_name.to_sym][:min_version]
      if !min_version.nil? && os_version < min_version
        log_message = "'ft_options' suboption '#{opt_flag_name}' is only supported for OpenStudio Version >= #{min_version.str}, ignoring it."
        logger.warn log_message
        next
      end
      ft_opts[opt_flag_name] = { method_name: known_ft_opts[opt_flag_name][:method_name], value: opt_flag }
    end

    return ft_opts
  end

  return default
end

#jobs(user_options, default, logger) ⇒ Object 



151
152
153
154
155
156
157
158
159
160
161
162
163
 
# File 'lib/openstudio/workflow/adapters/input/local.rb', line 151

def jobs(user_options, default, logger)
  # user option trumps all others
  return user_options[:jobs] if user_options[:jobs]

  # try to read from OSW
  begin
    # log_message = "Reading custom job states from OSW is not currently supported'"
    # logger.info log_message
  rescue StandardError
  end

  return default
end

#osw_dir ⇒ Object

Get the OSW dir



94
95
96
 
# File 'lib/openstudio/workflow/adapters/input/local.rb', line 94

def osw_dir
  File.dirname(@osw_abs_path)
end

#osw_path ⇒ Object

Get the OSW path



88
89
90
 
# File 'lib/openstudio/workflow/adapters/input/local.rb', line 88

def osw_path
  @osw_abs_path
end

#output_adapter(user_options, default, logger) ⇒ Object 



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
 
# File 'lib/openstudio/workflow/adapters/input/local.rb', line 111

def output_adapter(user_options, default, logger)
  # user option trumps all others
  return user_options[:output_adapter] if user_options[:output_adapter]

  # try to read from OSW
  if @run_options && !@run_options.empty?
    custom_adapter = @run_options.get.customOutputAdapter
    if !custom_adapter.empty?
      begin
        custom_file_name = custom_adapter.get.customFileName
        class_name = custom_adapter.get.className
        options = ::JSON.parse(custom_adapter.get.options, symbolize_names: true)

        # merge with user options, user options will replace options loaded from OSW
        options.merge!(user_options)

        # stick output_directory in options
        options[:output_directory] = run_dir

        p = @workflow_json.findFile(custom_file_name)
        if !p.empty?
          load(p.get.to_s)
          output_adapter = eval("#{class_name}.new(options)")
          return output_adapter
        else
          log_message = "Failed to load custom adapter file '#{custom_file_name}'"
          logger.error log_message
          raise log_message
        end
      rescue StandardError
        log_message = "Failed to load custom adapter '#{class_name}' from file '#{custom_file_name}'"
        logger.error log_message
        raise log_message
      end
    end
  end

  return default
end

#preserve_run_dir(user_options, default) ⇒ Object 



213
214
215
216
217
218
219
220
221
222
223
 
# File 'lib/openstudio/workflow/adapters/input/local.rb', line 213

def preserve_run_dir(user_options, default)
  # user option trumps all others
  return user_options[:preserve_run_dir] if user_options[:preserve_run_dir]

  # try to read from OSW
  if @run_options && !@run_options.empty?
    return @run_options.get.preserveRunDir
  end

  return default
end

#profile(user_options, default) ⇒ Object 



280
281
282
283
284
285
 
# File 'lib/openstudio/workflow/adapters/input/local.rb', line 280

def profile(user_options, default)
  # user option trumps all others
  return user_options[:profile] if user_options[:profile]

  return default
end

#run_dir ⇒ Object

Get the run dir



100
101
102
103
104
105
106
107
108
109
 
# File 'lib/openstudio/workflow/adapters/input/local.rb', line 100

def run_dir
  result = File.join(osw_dir, 'run')
  if @workflow_json
    begin
      result = @workflow_json.absoluteRunDir.to_s
    rescue StandardError
    end
  end
  result
end

#skip_energyplus_preprocess(user_options, default) ⇒ Object 



243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
 
# File 'lib/openstudio/workflow/adapters/input/local.rb', line 243

def skip_energyplus_preprocess(user_options, default)
  # user option trumps all others
  return user_options[:skip_energyplus_preprocess] if user_options[:skip_energyplus_preprocess]

  # try to read from OSW
  if @run_options && !@run_options.empty?
    if @run_options.get.respond_to?(:skipEnergyPlusPreprocess)
      return @run_options.get.skipEnergyPlusPreprocess
    else
      if @workflow[:run_options]
        return @workflow[:run_options][:skip_energyplus_preprocess]
      end
    end
  end

  return default
end

#skip_expand_objects(user_options, default) ⇒ Object 



225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
 
# File 'lib/openstudio/workflow/adapters/input/local.rb', line 225

def skip_expand_objects(user_options, default)
  # user option trumps all others
  return user_options[:skip_expand_objects] if user_options[:skip_expand_objects]

  # try to read from OSW
  if @run_options && !@run_options.empty?
    if @run_options.get.respond_to?(:skipExpandObjects)
      return @run_options.get.skipExpandObjects
    else
      if @workflow[:run_options]
        return @workflow[:run_options][:skip_expand_objects]
      end
    end
  end

  return default
end

#skip_zip_results(user_options, default) ⇒ Object 



195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
 
# File 'lib/openstudio/workflow/adapters/input/local.rb', line 195

def skip_zip_results(user_options, default)
  # user option trumps all others
  return user_options[:skip_zip_results] if user_options[:skip_zip_results]

  # try to read from OSW
  if @run_options && !@run_options.empty?
    if @run_options.get.respond_to?(:skipZipResults)
      return @run_options.get.skipZipResults
    else
      if @workflow[:run_options]
        return @workflow[:run_options][:skip_zip_results]
      end
    end
  end

  return default
end

#verify_osw(user_options, default) ⇒ Object 



287
288
289
290
291
292
 
# File 'lib/openstudio/workflow/adapters/input/local.rb', line 287

def verify_osw(user_options, default)
  # user option trumps all others
  return user_options[:verify_osw] if user_options[:verify_osw]

  return default
end

#weather_file(user_options, default) ⇒ Object 



389
390
391
392
393
394
395
396
397
398
399
 
# File 'lib/openstudio/workflow/adapters/input/local.rb', line 389

def weather_file(user_options, default)
  # user option trumps all others
  return user_options[:weather_file] if user_options[:weather_file]

  # try to read from OSW
  if !@workflow_json.weatherFile.empty?
    return @workflow_json.weatherFile.get.to_s
  end

  return default
end

#workflow ⇒ Object

Get the OSW file from the local filesystem



80
81
82
83
84
 
# File 'lib/openstudio/workflow/adapters/input/local.rb', line 80

def workflow
  raise "Could not read workflow from #{@osw_abs_path}" if @workflow.nil?

  @workflow
end