openstudio-analysis 0.3.1 → 0.3.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 74c0043c7f139238a9d7794eba641042e2fcf941
-  data.tar.gz: 3f6c3788437d50dce80865981d5d97a5717c6204
+  metadata.gz: 36db3ffaec389ad563fbd3f673d03296e34aa188
+  data.tar.gz: 84cf2c11acae410f719d1521593a33330e38e8cc
 SHA512:
-  metadata.gz: ee7e7dd7efbe7c142e128a5f1409775f6a74b5e9bbff3476c8536cfe51300c7292e9c64a9c2f4517cf7d7429f8cf42b5ff49783fac706dec4f8f4481dd9b2db1
-  data.tar.gz: ea72ccaf13c8fabba36290b2c8451fbae3a30245650bcde78f8237b25e3f72d56c0ca62ecee09ecadd420a173f9b9f327e904a3cebd058727f4417bb90a8e2ef
+  metadata.gz: 40d30b45fb9325c5a54f23cc99907ba2834e45faf4eba8d9191218de7a145d0bb441aef2be294f50c300ece8347f1e71bad8f42acddd915e585f9058547b9291
+  data.tar.gz: 5ae5179d6d2ccacffa3eb5d5a6e9f28d05748d7454a87b411db03539438f281af73eec38037f2b796097c94ec921ab8fd864fc3097c2b605ac1f1055b022a7bc

data/CHANGELOG.md

@@ -4,7 +4,18 @@ OpenStudio Analysis Gem Change Log
 Unreleased
 --------------
 
-Version 0.3.0 (not yet on RubyGems)
+Version 0.3.2
+--------------
+* Support both relative and absolute paths in the spreadsheet
+* Helper methods for submitting analyses
+* Add get_analysis method to Server API to get the status of an analysis
+
+Version 0.3.1
+--------------
+* Grab the first EPW file, not the first file
+* Download various formats via server API
+
+Version 0.3.0
 --------------
 * Remove the column for Sampling Method. That is now part of the analysis config.
 * All variables need static values now
@@ -13,90 +24,59 @@ Version 0.3.0 (not yet on RubyGems)
 
 Version 0.2.3
 --------------
-
 * Support for optional variables
 * Display names and Machine names in the models now
 * More error checking
 
 Version 0.1.14
 --------------
-
 * Symbolize headers parsed from excel file.
 
 
 Version 0.1.12/13
 -------------
-
 * Add machine name to pivot variables
-
 * Force generation of unique UUIDs
-
 * Add data types to arguments and variables for XML based measures
-
 * Move Pivot variable type to Type (not sample method)
 
 Version 0.1.11
 -------------
-
 * Add cluster name and openstudio server version
-
 * Make the booleans in run_options actual booleans
 
-
 Version 0.1.10
 -------------
-
 * Add output variables to the spreadsheet as a separate tab
 
 Version 0.1.9
 -------------
-
 * Downcase checking of variable data types
 
 Version 0.1.9
 -------------
-
 * Clean up the "delete_mes" in the JSONs
-
 * Added discrete variables to the spreadsheet and bumped version
 
 Version 0.1.8
 -------------
-
 * Parsing of Proxy parameters
 
 Version 0.1.7
 -------------
-
 * Add setting section
-
 * Add problem and algorithm arguments
 
 Version 0.1.6
 -------------
-                 
 * Small fixes
                 
 Version 0.1.5
 -------------
-
-### Major Changes (may be backwards incompatible)
-
-### New Features
-
-### Resolved Issues
-
 * Now depends on json_pure for window users
 
 Version 0.1.3
 -------------
-
-### Major Changes (may be backwards incompatible)
-
-### New Features
-
-### Resolved Issues
-
 * Removed spaced in measure type
 
 Version 0.1.1
@@ -106,8 +86,6 @@ Version 0.1.1
 
 * Change XLSX translator to read from a "Variables" spreadsheet instead of "Sensitivity"
 
-### New Features
-
 ### Resolved Issues
 
 * Added check for when weather file is a zip or an epw

data/lib/openstudio-analysis.rb

@@ -17,5 +17,6 @@ require 'openstudio/analysis/version'
 # translators
 require 'openstudio/analysis/translator/excel'
 
-# helpers
+# helpers / core_ext
 require 'openstudio/helpers/string'
+require 'openstudio/helpers/hash'

data/lib/openstudio/analysis/server_api.rb

@@ -6,7 +6,7 @@ module OpenStudio
       attr_reader :hostname
 
       def initialize(options = {})
-        defaults = { hostname: 'http://localhost:8080' }
+        defaults = {hostname: 'http://localhost:8080'}
         options = defaults.merge(options)
         @logger = Logger.new('faraday.log')
 
@@ -66,12 +66,12 @@ module OpenStudio
       end
 
       def new_project(options = {})
-        defaults = { project_name: "Project #{Time.now.strftime('%Y-%m-%d %H:%M:%S')}" }
+        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]}" } }
+        project_hash = {project: {name: "#{options[:project_name]}"}}
 
         response = @conn.post do |req|
           req.url '/projects.json'
@@ -109,12 +109,71 @@ module OpenStudio
         analysis_ids
       end
 
+      # return the entire analysis JSON
+      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
+
+      # 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"
+      #     }
+      #   ]
+      # }
+      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
+
+      # return the data point results in JSON format
+      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
+
       def download_dataframe(analysis_id, format='rdata', save_directory=".")
-        response = @conn.get "/analyses/#{analysis_id}/download_data.#{format}"
+        # 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}")
-          File.open("#{save_directory}/#{filename}",'w') {|f| f << response.body}
+          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
 
@@ -123,7 +182,20 @@ module OpenStudio
         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}",'w') {|f| f << response.body}
+          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
+
+      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
 
@@ -132,48 +204,59 @@ module OpenStudio
         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}",'w') {|f| f << response.body}
+          File.open("#{save_directory}/#{filename}", 'wb') { |f| f << response.body }
         end
       end
 
       def new_analysis(project_id, options)
-        defaults = { analysis_name: nil, reset_uuids: false }
+        defaults = {analysis_name: nil, reset_uuids: false}
         options = defaults.merge(options)
 
         fail 'No project id passed' if project_id.nil?
-        fail 'no formulation passed to new_analysis' unless 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)
+        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 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
+        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
-            end
-            if wf[:variables]
-              wf[:variables].each do |var|
-                var[:uuid] = UUID.new.generate
-                var[:argument][:uuid] = UUID.new.generate if var[:argument]
+              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
-          analysis_id = formulation_json[:analysis][:uuid]
+          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?
 
-        # set the analysis name
-        formulation_json[:analysis][:name] = "#{options[:analysis_name]}" unless options[:analysis_name].nil?
-
         # save out this file to compare
         # File.open('formulation_merge.json', 'w') { |f| f << JSON.pretty_generate(formulation_json) }
 
@@ -197,7 +280,7 @@ module OpenStudio
         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') }
+          payload = {file: Faraday::UploadIO.new(options[:upload_file], 'application/zip')}
           response = @conn_multipart.post "analyses/#{analysis_id}/upload.json", payload
 
           if response.status == 201
@@ -211,7 +294,7 @@ module OpenStudio
       end
 
       def upload_datapoint(analysis_id, options)
-        defaults = { reset_uuids: false }
+        defaults = {reset_uuids: false}
         options = defaults.merge(options)
 
         fail 'No analysis id passed' if analysis_id.nil?
@@ -264,7 +347,7 @@ module OpenStudio
       end
 
       def run_analysis(analysis_id, options)
-        defaults = { analysis_action: 'start', without_delay: false }
+        defaults = {analysis_action: 'start', without_delay: false}
         options = defaults.merge(options)
 
         puts "Run analysis is configured with #{options.to_json}"
@@ -283,7 +366,7 @@ module OpenStudio
       end
 
       def kill_analysis(analysis_id)
-        analysis_action = { analysis_action: 'stop' }
+        analysis_action = {analysis_action: 'stop'}
 
         response = @conn.post do |req|
           req.url "analyses/#{analysis_id}/action.json"
@@ -313,16 +396,137 @@ module OpenStudio
       end
 
       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"
-            puts "Data points (all): #{resp}"
+            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
-            puts "Data points (#{filter}): #{resp}"
+            if resp.status == 200
+              data_points = JSON.parse(resp.body, symbolize_names: true)[:data_points]
+            end
           end
         end
+
+        data_points
+      end
+
+      # Return the JSON (Full) of the datapoint
+      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
+
+      ## here are a bunch of runs that really don't belong here.
+
+      # create a new analysis and run a single model
+      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
+
+      # creates a new analysis and runs rgenoud optimization - number of generations isn't used right now
+      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
+
+      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
     end
   end