Class: OpenStudio::Analysis::ServerApi

Inherits:
Object
  • Object
show all
Defined in:
lib/openstudio/analysis/server_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(options = {}) ⇒ ServerApi

Returns a new instance of ServerApi.



8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
 
# File 'lib/openstudio/analysis/server_api.rb', line 8

def initialize(options = {})
  defaults = {hostname: 'http://localhost:8080'}
  options = defaults.merge(options)
  @logger = Logger.new('faraday.log')

  @hostname = options[:hostname]

  fail 'no host defined for server api class' if @hostname.nil?

  # todo: add support for the proxy

  # create connection with basic capabilities
  @conn = Faraday.new(url: @hostname) do |faraday|
    faraday.request :url_encoded # form-encode POST params
    faraday.use Faraday::Response::Logger, @logger
    # faraday.response @logger # log requests to STDOUT
    faraday.adapter Faraday.default_adapter # make requests with Net::HTTP
  end

  # create connection to server api with multipart capabilities
  @conn_multipart = Faraday.new(url: @hostname) do |faraday|
    faraday.request :multipart
    faraday.request :url_encoded # form-encode POST params
    faraday.use Faraday::Response::Logger, @logger
    # faraday.response :logger # log requests to STDOUT
    faraday.adapter Faraday.default_adapter # make requests with Net::HTTP
  end
end

Instance Attribute Details

#hostname ⇒ Object (readonly)

Returns the value of attribute hostname.



6
7
8
 
# File 'lib/openstudio/analysis/server_api.rb', line 6

def hostname
  @hostname
end

Instance Method Details

#delete_all ⇒ Object 



55
56
57
58
59
60
61
62
63
64
65
66
 
# File 'lib/openstudio/analysis/server_api.rb', line 55

def delete_all
  ids = get_project_ids
  puts "Deleting Projects #{ids}"
  ids.each do |id|
    response = @conn.delete "/projects/#{id}.json"
    if response.status == 204
      puts "Successfully deleted project #{id}"
    else
      puts "ERROR deleting project #{id}"
    end
  end
end

#download_all_data_points(analysis_id, save_directory = ".") ⇒ Object 



202
203
204
205
206
207
208
209
 
# File 'lib/openstudio/analysis/server_api.rb', line 202

def download_all_data_points(analysis_id, save_directory=".")
  response = @conn.get "/analyses/#{analysis_id}/download_all_data_points"
  if response.status == 200
    filename = response['content-disposition'].match(/filename=(\"?)(.+)\1/)[2]
    puts "File #{filename} already exists, overwriting" if File.exist?("#{save_directory}/#{filename}")
    File.open("#{save_directory}/#{filename}", 'wb') { |f| f << response.body }
  end
end

#download_dataframe(analysis_id, format = 'rdata', save_directory = ".") ⇒ Object 



166
167
168
169
170
171
172
173
174
175
176
177
178
 
# File 'lib/openstudio/analysis/server_api.rb', line 166

def download_dataframe(analysis_id, format='rdata', save_directory=".")
  # Set the export = true flag to retrieve all the variables for the export (not just the visualize variables)
  response = @conn.get "/analyses/#{analysis_id}/download_data.#{format}?export=true"
  if response.status == 200
    filename = response['content-disposition'].match(/filename=(\"?)(.+)\1/)[2]
    puts "File #{filename} already exists, overwriting" if File.exist?("#{save_directory}/#{filename}")
    if format == 'rdata'
      File.open("#{save_directory}/#{filename}", 'wb') { |f| f << response.body }
    else
      File.open("#{save_directory}/#{filename}", 'w') { |f| f << response.body }
    end
  end
end

#download_datapoint(datapoint_id, save_directory = ".") ⇒ Object 



193
194
195
196
197
198
199
200
 
# File 'lib/openstudio/analysis/server_api.rb', line 193

def download_datapoint(datapoint_id, save_directory=".")
  response = @conn.get "/data_points/#{datapoint_id}/download"
  if response.status == 200
    filename = response['content-disposition'].match(/filename=(\"?)(.+)\1/)[2]
    puts "File #{filename} already exists, overwriting" if File.exist?("#{save_directory}/#{filename}")
    File.open("#{save_directory}/#{filename}", 'wb') { |f| f << response.body }
  end
end

#download_variables(analysis_id, format = 'rdata', save_directory = ".") ⇒ Object 



180
181
182
183
184
185
186
187
188
189
190
191
 
# File 'lib/openstudio/analysis/server_api.rb', line 180

def download_variables(analysis_id, format='rdata', save_directory=".")
  response = @conn.get "/analyses/#{analysis_id}/variables/download_variables.#{format}"
  if response.status == 200
    filename = response['content-disposition'].match(/filename=(\"?)(.+)\1/)[2]
    puts "File #{filename} already exists, overwriting" if File.exist?("#{save_directory}/#{filename}")
    if format == 'rdata'
      File.open("#{save_directory}/#{filename}", 'wb') { |f| f << response.body }
    else
      File.open("#{save_directory}/#{filename}", 'w') { |f| f << response.body }
    end
  end
end

#get_analyses(project_id) ⇒ Object 



95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
 
# File 'lib/openstudio/analysis/server_api.rb', line 95

def get_analyses(project_id)
  analysis_ids = []
  response = @conn.get "/projects/#{project_id}.json"
  if response.status == 200
    puts 'received the list of analyses for the project'

    analyses = JSON.parse(response.body, symbolize_names: true, max_nesting: false)
    if analyses[:analyses]
      analyses[:analyses].each do |analysis|
        analysis_ids << analysis[:_id]
      end
    end
  end

  analysis_ids
end

#get_analysis(analysis_id) ⇒ Object

return the entire analysis JSON



113
114
115
116
117
118
119
120
121
 
# File 'lib/openstudio/analysis/server_api.rb', line 113

def get_analysis(analysis_id)
  result = nil
  response = @conn.get "/analyses/#{analysis_id}.json"
  if response.status == 200
    result = JSON.parse(response.body, symbolize_names: true, max_nesting: false)[:analysis]
  end

  result
end

#get_analysis_results(analysis_id) ⇒ Object

return the data point results in JSON format



155
156
157
158
159
160
161
162
163
164
 
# File 'lib/openstudio/analysis/server_api.rb', line 155

def get_analysis_results(analysis_id)
  analysis = nil

  response = @conn.get "/analyses/#{analysis_id}/analysis_data.json"
  if response.status == 200
    analysis = JSON.parse(response.body, symbolize_names: true, max_nesting: false)
  end

  analysis
end

#get_analysis_status(analysis_id, analysis_type) ⇒ Object

Check the status of the simulation. Format should be: { analysis: { status: "completed", analysis_type: "batch_run" }, data_points: [ { _id: "bbd57e90-ce59-0131-35de-080027880ca6", status: "completed" } ] }



136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
 
# File 'lib/openstudio/analysis/server_api.rb', line 136

def get_analysis_status(analysis_id, analysis_type)
  status = nil

  #sleep 2  # super cheesy---need to update how this works. Right now there is a good chance to get a
           # race condition when the analysis state changes.
  unless analysis_id.nil?
    resp = @conn.get "analyses/#{analysis_id}/status.json"
    if resp.status == 200
      j = JSON.parse resp.body, symbolize_names: true
      if j && j[:analysis] && j[:analysis][:analysis_type] == analysis_type
        status = j[:analysis][:status]
      end
    end
  end

  status
end

#get_datapoint(data_point_id) ⇒ Object

Return the JSON (Full) of the datapoint



419
420
421
422
423
424
425
426
427
428
 
# File 'lib/openstudio/analysis/server_api.rb', line 419

def get_datapoint(data_point_id)
  data_point = nil

  resp = @conn.get "/data_points/#{data_point_id}/show_full.json"
  if resp.status == 200
    data_point = JSON.parse resp.body, symbolize_names: true
  end

  data_point
end

#get_datapoint_status(analysis_id, filter = nil) ⇒ Object 



398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
 
# File 'lib/openstudio/analysis/server_api.rb', line 398

def get_datapoint_status(analysis_id, filter = nil)
  data_points = nil
  # get the status of all the entire analysis
  unless analysis_id.nil?
    if filter.nil? || filter == ''
      resp = @conn.get "analyses/#{analysis_id}/status.json"
      if resp.status == 200
        data_points = JSON.parse(resp.body, symbolize_names: true)[:data_points]
      end
    else
      resp = @conn.get "#{@hostname}/analyses/#{analysis_id}/status.json", jobs: filter
      if resp.status == 200
        data_points = JSON.parse(resp.body, symbolize_names: true)[:data_points]
      end
    end
  end

  data_points
end

#get_project_ids ⇒ Object 



50
51
52
53
 
# File 'lib/openstudio/analysis/server_api.rb', line 50

def get_project_ids
  ids = get_projects
  ids.map { |project| project[:uuid] }
end

#get_projects ⇒ Object 



37
38
39
40
41
42
43
44
45
46
47
48
 
# File 'lib/openstudio/analysis/server_api.rb', line 37

def get_projects
  response = @conn.get '/projects.json'

  projects_json = nil
  if response.status == 200
    projects_json = JSON.parse(response.body, symbolize_names: true, max_nesting: false)
  else
    fail 'did not receive a 200 in get_projects'
  end

  projects_json
end

#kill_all_analyses ⇒ Object 



384
385
386
387
388
389
390
391
392
393
394
395
396
 
# File 'lib/openstudio/analysis/server_api.rb', line 384

def kill_all_analyses
  project_ids = get_project_ids
  puts "List of projects ids are: #{project_ids}"

  project_ids.each do |project_id|
    analysis_ids = get_analyses(project_id)
    puts analysis_ids
    analysis_ids.each do |analysis_id|
      puts "Trying to kill #{analysis_id}"
      kill_analysis(analysis_id)
    end
  end
end

#kill_analysis(analysis_id) ⇒ Object 



368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
 
# File 'lib/openstudio/analysis/server_api.rb', line 368

def kill_analysis(analysis_id)
  analysis_action = {analysis_action: 'stop'}

  response = @conn.post do |req|
    req.url "analyses/#{analysis_id}/action.json"
    req.headers['Content-Type'] = 'application/json'
    req.body = analysis_action.to_json
  end

  if response.status == 200
    puts "Killed analysis #{analysis_id}"
  else
    # raise "Could not kill the analysis with response of #{response.inspect}"
  end
end

#new_analysis(project_id, options) ⇒ Object 



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
281
282
283
284
285
286
287
288
289
290
291
292
293
294
 
# File 'lib/openstudio/analysis/server_api.rb', line 211

def new_analysis(project_id, options)
  defaults = {analysis_name: nil, reset_uuids: false}
  options = defaults.merge(options)

  fail 'No project id passed' if project_id.nil?

  formulation_json = nil
  if options[:formulation_file]
    fail "No formulation exists #{options[:formulation_file]}" unless File.exist?(options[:formulation_file])
    formulation_json = JSON.parse(File.read(options[:formulation_file]), symbolize_names: true)
  end

  # read in the analysis id from the analysis.json file
  analysis_id = nil
  if formulation_json
    if options[:reset_uuids]
      analysis_id = UUID.new.generate
      formulation_json[:analysis][:uuid] = analysis_id

      formulation_json[:analysis][:problem][:workflow].each do |wf|
        wf[:uuid] = UUID.new.generate
        if wf[:arguments]
          wf[:arguments].each do |arg|
            arg[:uuid] = UUID.new.generate
          end
        end
        if wf[:variables]
          wf[:variables].each do |var|
            var[:uuid] = UUID.new.generate
            var[:argument][:uuid] = UUID.new.generate if var[:argument]
          end
        end
      end
    else
      analysis_id = formulation_json[:analysis][:uuid]
    end

    # set the analysis name
    formulation_json[:analysis][:name] = "#{options[:analysis_name]}" unless options[:analysis_name].nil?
  else
    formulation_json = {
        analysis: options
    }
    puts formulation_json
    analysis_id = UUID.new.generate
    formulation_json[:analysis][:uuid] = analysis_id
  end
  fail "No analysis id defined in analyis.json #{options[:formulation_file]}" if analysis_id.nil?

  # save out this file to compare
  # File.open('formulation_merge.json', 'w') { |f| f << JSON.pretty_generate(formulation_json) }

  response = @conn.post do |req|
    req.url "projects/#{project_id}/analyses.json"
    req.headers['Content-Type'] = 'application/json'
    req.body = formulation_json.to_json
  end

  if response.status == 201
    puts "asked to create analysis with #{analysis_id}"
    # puts resp.inspect
    analysis_id = JSON.parse(response.body)['_id']

    puts "new analysis created with ID: #{analysis_id}"
  else
    fail 'Could not create new analysis'
  end

  # check if we need to upload the analysis zip file
  if options[:upload_file]
    fail "upload file does not exist #{options[:upload_file]}" unless File.exist?(options[:upload_file])

    payload = {file: Faraday::UploadIO.new(options[:upload_file], 'application/zip')}
    response = @conn_multipart.post "analyses/#{analysis_id}/upload.json", payload

    if response.status == 201
      puts 'Successfully uploaded ZIP file'
    else
      fail response.inspect
    end
  end

  analysis_id
end

#new_project(options = {}) ⇒ Object 



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
 
# File 'lib/openstudio/analysis/server_api.rb', line 68

def new_project(options = {})
  defaults = {project_name: "Project #{Time.now.strftime('%Y-%m-%d %H:%M:%S')}"}
  options = defaults.merge(options)
  project_id = nil

  # TODO: make this a display name and a machine name
  project_hash = {project: {name: "#{options[:project_name]}"}}

  response = @conn.post do |req|
    req.url '/projects.json'
    req.headers['Content-Type'] = 'application/json'
    req.body = project_hash.to_json
  end

  if response.status == 201
    project_id = JSON.parse(response.body)['_id']

    puts "new project created with ID: #{project_id}"
    # grab the project id
  elsif response.status == 500
    puts '500 Error'
    puts response.inspect
  end

  project_id
end

#run_analysis(analysis_id, options) ⇒ Object 



349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
 
# File 'lib/openstudio/analysis/server_api.rb', line 349

def run_analysis(analysis_id, options)
  defaults = {analysis_action: 'start', without_delay: false}
  options = defaults.merge(options)

  puts "Run analysis is configured with #{options.to_json}"
  response = @conn.post do |req|
    req.url "analyses/#{analysis_id}/action.json"
    req.headers['Content-Type'] = 'application/json'
    req.body = options.to_json
    req.options[:timeout] = 1800 # seconds
  end

  if response.status == 200
    puts "Recieved request to run analysis #{analysis_id}"
  else
    fail 'Could not start the analysis'
  end
end

#run_lhs(formulation_filename, analysis_zip_filename) ⇒ Object 



496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
 
# File 'lib/openstudio/analysis/server_api.rb', line 496

def run_lhs(formulation_filename, analysis_zip_filename)
  project_options = {}
  project_id = new_project(project_options)

  analysis_options = {
      formulation_file: formulation_filename,
      upload_file: analysis_zip_filename,
      reset_uuids: true
  }
  analysis_id = new_analysis(project_id, analysis_options)

  run_options = {
      analysis_action: "start",
      without_delay: false,
      analysis_type: 'lhs',
      allow_multiple_jobs: true,
      use_server_as_worker: true,
      simulate_data_point_filename: 'simulate_data_point.rb',
      run_data_point_filename: 'run_openstudio_workflow_monthly.rb'
  }
  run_analysis(analysis_id, run_options)

  run_options = {
      analysis_action: "start",
      without_delay: false, # run in background
      analysis_type: 'batch_run',
      allow_multiple_jobs: true,
      use_server_as_worker: true,
      simulate_data_point_filename: 'simulate_data_point.rb',
      run_data_point_filename: 'run_openstudio_workflow_monthly.rb'
  }
  run_analysis(analysis_id, run_options)

  analysis_id
end

#run_rgenoud(formulation_filename, analysis_zip_filename, number_of_generations) ⇒ Object

creates a new analysis and runs rgenoud optimization - number of generations isn't used right now



471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
 
# File 'lib/openstudio/analysis/server_api.rb', line 471

def run_rgenoud(formulation_filename, analysis_zip_filename, number_of_generations)
  project_options = {}
  project_id = new_project(project_options)

  analysis_options = {
      formulation_file: formulation_filename,
      upload_file: analysis_zip_filename,
      reset_uuids: true
  }
  analysis_id = new_analysis(project_id, analysis_options)

  run_options = {
      analysis_action: "start",
      without_delay: false,
      analysis_type: 'rgenoud',
      allow_multiple_jobs: true,
      use_server_as_worker: true,
      simulate_data_point_filename: 'simulate_data_point.rb',
      run_data_point_filename: 'run_openstudio_workflow_monthly.rb'
  }
  run_analysis(analysis_id, run_options)

  analysis_id
end

#run_single_model(formulation_filename, analysis_zip_filename) ⇒ Object

create a new analysis and run a single model



433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
 
# File 'lib/openstudio/analysis/server_api.rb', line 433

def run_single_model(formulation_filename, analysis_zip_filename)
  project_options = {}
  project_id = new_project(project_options)

  analysis_options = {
      formulation_file: formulation_filename,
      upload_file: analysis_zip_filename,
      reset_uuids: true
  }
  analysis_id = new_analysis(project_id, analysis_options)

  # Force this to run in the foreground for now until we can deal with checing the 'analysis state of various anlaysis'
  run_options = {
      analysis_action: "start",
      without_delay: true, # run this in the foreground
      analysis_type: 'single_run',
      allow_multiple_jobs: true,
      use_server_as_worker: true,
      simulate_data_point_filename: 'simulate_data_point.rb',
      run_data_point_filename: 'run_openstudio_workflow_monthly.rb'
  }
  run_analysis(analysis_id, run_options)

  run_options = {
      analysis_action: "start",
      without_delay: false, # run in background
      analysis_type: 'batch_run',
      allow_multiple_jobs: true,
      use_server_as_worker: true,
      simulate_data_point_filename: 'simulate_data_point.rb',
      run_data_point_filename: 'run_openstudio_workflow_monthly.rb'
  }
  run_analysis(analysis_id, run_options)

  analysis_id
end

#upload_datapoint(analysis_id, options) ⇒ Object 



296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
 
# File 'lib/openstudio/analysis/server_api.rb', line 296

def upload_datapoint(analysis_id, options)
  defaults = {reset_uuids: false}
  options = defaults.merge(options)

  fail 'No analysis id passed' if analysis_id.nil?
  fail 'No datapoints file passed to new_analysis' unless options[:datapoint_file]
  fail "No datapoints_file exists #{options[:datapoint_file]}" unless File.exist?(options[:datapoint_file])

  dp_hash = JSON.parse(File.open(options[:datapoint_file]).read, symbolize_names: true)

  if options[:reset_uuids]
    dp_hash[:analysis_uuid] = analysis_id
    dp_hash[:uuid] = UUID.new.generate
  end

  # merge in the analysis_id as it has to be what is in the database
  response = @conn.post do |req|
    req.url "analyses/#{analysis_id}/data_points.json"
    req.headers['Content-Type'] = 'application/json'
    req.body = dp_hash.to_json
  end

  if response.status == 201
    puts "new datapoints created for analysis #{analysis_id}"
  else
    fail "could not create new datapoints #{response.body}"
  end
end

#upload_datapoints(analysis_id, options) ⇒ Object 



325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
 
# File 'lib/openstudio/analysis/server_api.rb', line 325

def upload_datapoints(analysis_id, options)
  defaults = {}
  options = defaults.merge(options)

  fail 'No analysis id passed' if analysis_id.nil?
  fail 'No datapoints file passed to new_analysis' unless options[:datapoints_file]
  fail "No datapoints_file exists #{options[:datapoints_file]}" unless File.exist?(options[:datapoints_file])

  dp_hash = JSON.parse(File.open(options[:datapoints_file]).read, symbolize_names: true)

  # merge in the analysis_id as it has to be what is in the database
  response = @conn.post do |req|
    req.url "analyses/#{analysis_id}/data_points/batch_upload.json"
    req.headers['Content-Type'] = 'application/json'
    req.body = dp_hash.to_json
  end

  if response.status == 201
    puts "new datapoints created for analysis #{analysis_id}"
  else
    fail "could not create new datapoints #{response.body}"
  end
end