Module: OpenStudio::Workflow::ApplyMeasures

Included in:
RunOpenstudio, RunPostprocess, RunReportingMeasures, RunRunmanager
Defined in:
lib/openstudio/workflow/jobs/lib/apply_measures.rb

Constant Summary collapse

MEASURE_TYPES = 
{
  openstudio_measure: 'RubyMeasure',
  energyplus_measure: 'EnergyPlusMeasure',
  reporting_measure: 'ReportingMeasure'
}

Instance Method Summary collapse

Instance Method Details

#apply_arguments(argument_map, argument) ⇒ Object 



38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
 
# File 'lib/openstudio/workflow/jobs/lib/apply_measures.rb', line 38

def apply_arguments(argument_map, argument)
  success = true

  unless argument[:value].nil?
    @logger.info "Setting argument value '#{argument[:name]}' to '#{argument[:value]}'"

    v = argument_map[argument[:name]]
    fail "Could not find argument map in measure for '#{argument[:name]}' with value '#{argument[:value]}'" unless v
    value_set = v.setValue(argument[:value])
    fail "Could not set argument '#{argument[:name]}' of value '#{argument[:value]}' on model" unless value_set
    argument_map[argument[:name]] = v.clone
  else
    @logger.warn "Value for argument '#{argument[:name]}' not set in argument list therefore will use default"
    # success = false

    # TODO: what is the fail case (success = false?)
  end

  success
end

#apply_measure(workflow_item) ⇒ Object 



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
 
# File 'lib/openstudio/workflow/jobs/lib/apply_measures.rb', line 97

def apply_measure(workflow_item)
  @logger.info "Starting #{__method__} for #{workflow_item[:name]}"
  @time_logger.start("Measure:#{workflow_item[:name]}")
  # start_time = ::Time.now
  current_dir = Dir.pwd
  begin
    measure_working_directory = "#{@run_directory}/#{workflow_item[:measure_definition_class_name]}"

    @logger.info "Creating run directory to #{measure_working_directory}"
    FileUtils.mkdir_p measure_working_directory
    Dir.chdir measure_working_directory

    measure_path = workflow_item[:measure_definition_directory]
    measure_name = workflow_item[:measure_definition_class_name]
    @logger.info "Apply measure running in #{Dir.pwd}"

    measure_file_path = nil
    if (Pathname.new measure_path).absolute?
      measure_file_path = measure_path
    else
      measure_file_path = File.expand_path(File.join(@options[:analysis_root_path], measure_path, 'measure.rb'))
    end

    @logger.info "Loading Measure from #{measure_file_path}"
    fail "Measure file does not exist #{measure_name} in #{measure_file_path}" unless File.exist? measure_file_path

    measure = nil
    runner = nil
    result = nil
    begin
      require measure_file_path
      measure = Object.const_get(measure_name).new
      runner = OpenStudio::Ruleset::OSRunner.new
    rescue => e
      log_message = "Error requiring measure #{__FILE__}. Failed with #{e.message}, #{e.backtrace.join("\n")}"
      raise log_message
    end

    arguments = nil

    begin
      if workflow_item[:measure_type] == 'RubyMeasure'
        arguments = measure.arguments(@model)
      elsif workflow_item[:measure_type] == 'EnergyPlusMeasure'
        arguments = measure.arguments(@model)
      elsif workflow_item[:measure_type] == 'ReportingMeasure'
        arguments = measure.arguments
      end

      @logger.info "Extracted the following arguments: #{arguments}"

      # Create argument map and initialize all the arguments
      argument_map = OpenStudio::Ruleset::OSArgumentMap.new
      arguments.each do |v|
        argument_map[v.name] = v.clone
      end
      # @logger.info "Argument map for measure is #{argument_map}"

      @logger.info "Iterating over arguments for workflow item '#{workflow_item[:name]}'"
      if workflow_item[:arguments]
        workflow_item[:arguments].each do |argument|
          success = apply_arguments(argument_map, argument)
          fail 'Could not set arguments' unless success
        end
      end

      @logger.info "Iterating over variables for workflow item '#{workflow_item[:name]}'"
      if workflow_item[:variables]
        workflow_item[:variables].each do |variable|
          success = apply_variables(argument_map, variable)
          fail 'Could not set variables' unless success
        end
      end
    rescue => e
      log_message = "Error assigning argument in measure #{__FILE__}. Failed with #{e.message}, #{e.backtrace.join("\n")}"
      raise log_message
    end

    begin
      @logger.info "Calling measure.run for '#{workflow_item[:name]}'"
      if workflow_item[:measure_type] == 'RubyMeasure'
        measure.run(@model, runner, argument_map)
      elsif workflow_item[:measure_type] == 'EnergyPlusMeasure'
        measure.run(@model_idf, runner, argument_map)
      elsif workflow_item[:measure_type] == 'ReportingMeasure'
        # This is silly, set the last model and last sqlfile instead of passing it into the measure.run method
        runner.setLastOpenStudioModel(@model)
        runner.setLastEnergyPlusSqlFilePath(@sql_filename)

        measure.run(runner, argument_map)
      end
      @logger.info "Finished measure.run for '#{workflow_item[:name]}'"
    rescue => e
      log_message = "Runner error #{__FILE__} failed with #{e.message}, #{e.backtrace.join("\n")}"
      raise log_message
    end

    begin
      result = runner.result
      @logger.info "Running of measure '#{workflow_item[:name]}' completed. Post-processing measure output"

      @logger.info result.initialCondition.get.logMessage unless result.initialCondition.empty?
      @logger.info result.finalCondition.get.logMessage unless result.finalCondition.empty?

      result.warnings.each { |w| @logger.warn w.logMessage }
      an_error = false
      result.errors.each do |w|
        @logger.error w.logMessage
        an_error = true
      end
      fail "Measure #{measure_name} reported an error, check log" if an_error
      result.info.each { |w| @logger.info w.logMessage }
    rescue => e
      log_message = "Runner error #{__FILE__} failed with #{e.message}, #{e.backtrace.join("\n")}"
      raise log_message
    end

    begin
      measure_attributes = JSON.parse(OpenStudio.toJSON(result.attributes), symbolize_names: true)
      @output_attributes[workflow_item[:name].to_sym] = measure_attributes[:attributes]
    rescue => e
      log_message = "#{__FILE__} failed with #{e.message}, #{e.backtrace.join("\n")}"
      @logger.error log_message
    end
  rescue => e
    log_message = "#{__FILE__} failed with message #{e.message} in #{e.backtrace.join("\n")}"
    @logger.error log_message
    raise log_message
  ensure
    Dir.chdir current_dir
    @time_logger.stop("Measure:#{workflow_item[:name]}")

    @logger.info "Finished #{__method__} for #{workflow_item[:name]} in #{@time_logger.delta("Measure:#{workflow_item[:name]}")} s"
  end
end

#apply_measures(measure_type) ⇒ Object 



233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
 
# File 'lib/openstudio/workflow/jobs/lib/apply_measures.rb', line 233

def apply_measures(measure_type)
  if @analysis_json[:analysis][:problem] && @analysis_json[:analysis][:problem][:workflow]
    current_dir = Dir.pwd
    begin
      @logger.info "Applying measures for #{MEASURE_TYPES[measure_type]}"
      @analysis_json[:analysis][:problem][:workflow].each do |wf|
        next unless wf[:measure_type] == MEASURE_TYPES[measure_type]

        apply_measure(wf)
      end
    ensure
      Dir.chdir current_dir
    end
  end
end

#apply_variables(argument_map, variable) ⇒ Object

Apply the variable values to the measure argument map object



60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
 
# File 'lib/openstudio/workflow/jobs/lib/apply_measures.rb', line 60

def apply_variables(argument_map, variable)
  success = true

  # save the uuid of the variable
  variable_uuid = variable[:uuid].to_sym
  if variable[:argument]
    variable_name = variable[:argument][:name]

    # Get the value from the data point json that was set via R / Problem Formulation
    if @datapoint_json[:data_point]
      if @datapoint_json[:data_point][:set_variable_values]
        unless @datapoint_json[:data_point][:set_variable_values][variable_uuid].nil?
          @logger.info "Setting variable '#{variable_name}' to #{@datapoint_json[:data_point][:set_variable_values][variable_uuid]}"
          v = argument_map[variable_name]
          fail 'Could not find argument map in measure' unless v
          variable_value = @datapoint_json[:data_point][:set_variable_values][variable_uuid]
          value_set = v.setValue(variable_value)
          fail "Could not set variable '#{variable_name}' of value #{variable_value} on model" unless value_set
          argument_map[variable_name] = v.clone
        else
          fail "[ERROR] Value for variable '#{variable_name}:#{variable_uuid}' not set in datapoint object"
          # @logger.error "Value for variable '#{variable_name}:#{variable_uuid}' not set in datapoint object"
          # success = false
        end
      else
        fail 'No block for set_variable_values in data point record'
      end
    else
      fail 'No block for data_point in data_point record'
    end
  else
    fail "Variable '#{variable_name}' is defined but no argument is present"
  end

  success
end