openstudio-analysis 0.4.5 → 1.0.0.pat1

data/lib/openstudio/analysis/translator/workflow.rb

@@ -0,0 +1,106 @@
+module OpenStudio
+  module Analysis
+    module Translator
+
+      require 'json'
+      require 'securerandom'
+
+      class Workflow
+        attr_reader :osa_filename
+        attr_reader :root_path
+        attr_reader :analysis
+        attr_reader :osa
+        attr_reader :osw_version
+        attr_reader :options
+        attr_reader :file_paths
+        attr_reader :measure_paths
+        attr_reader :seed_file
+        attr_reader :weather_file
+        attr_reader :osa_id
+        attr_reader :steps
+
+        def initialize(osa_filename, options = {})
+          @osa_filename = osa_filename
+          @root_path = File.expand_path(File.dirname(@osa_filename))
+
+          # try to read the osa json file
+          if File.exist?(@osa_filename)
+            @osa = ::JSON.parse(File.read(@osa_filename), {symbolize_names: true})[:analysis]
+          else
+            fail "File #{@osa_filename} does not exist"
+          end
+
+          # Initialize some other instance variables
+          @osw_version = '0.0.1'
+          @options = options
+          @file_paths = options[:file_paths] ? options[:file_paths] : []
+          @measure_paths = options[:measure_paths] ? options[:measure_paths] : []
+
+          # Initialize static inputs from the OSA
+          @seed_file = File.basename @osa[:seed][:path]
+          @weather_file = File.basename @osa[:weather_file][:path]
+          @osa_id = @osa[:_id]
+          @steps = []
+          @osa[:problem][:workflow].each_with_index do |step, i|
+            step_hash = {}
+            step_hash[:measure_dir_name] = File.basename(step[:measure_definition_directory])
+            step_hash[:arguments] = {}
+            @osa[:problem][:workflow][i][:arguments].each do |arg|
+              step_hash[:arguments][arg[:name].to_sym] = arg[:value]
+            end
+            @steps << step_hash
+          end
+        end
+
+        def process_datapoint(osd_filename)
+          # Try to read the osd json file
+          if File.exist?(osd_filename)
+            warn('data_point selector in ods will be changed to datapoint in version 1.0')
+            osd = ::JSON.parse(File.read(osd_filename), {symbolize_names: true})[:data_point]
+          else
+            fail "File #{osd_filename} does not exist"
+          end
+
+          # Parse the osd hash based off of the osa hash. First check that the analysis id matches
+          fail "File #{osd_filename} does not reference #{@osa_id}." unless @osa_id == osd[:analysis_id]
+          # @todo (rhorsey) Fix the spec so this line can be uncommented
+          osw_steps_instance = @steps
+          osw_steps_instance.each_with_index do |step, i|
+            @osa[:problem][:workflow][i][:variables].each do |var|
+              var_name = var[:argument][:name]
+              var_value_uuid = var[:uuid]
+              var_value = osd[:set_variable_values][var_value_uuid.to_sym]
+              step[:arguments][var_name.to_sym] = var_value
+            end
+          end
+
+          # Save the OSW hash
+          osw = {}
+          created_at = ::Time.now
+          osw[:seed_model] = @seed_file
+          osw[:weather_file] = @weather_file
+          osw[:file_format_version] = @osw_version
+          osw[:osa_id] = @osa_id
+          osw[:osd_id] = osd[:_id]
+          osw[:created_at] = created_at
+          osw[:measure_paths] = @measure_paths
+          osw[:file_paths] = @file_paths
+          osw[:run_directory] = './'
+          osw[:steps] = osw_steps_instance
+          return osw
+        end
+
+        # Runs an array of OSD files
+        def process_datapoints(osd_filename_array)
+          osd_filename_array.each do |osd_file|
+            begin
+              yield process_datapoint(osd_file)
+            rescue => e
+              puts "Warning: Failed to processes datapoint #{osd_file} with error #{e.message} in #{e.backtrace.join('\n')}"
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/openstudio/analysis/version.rb

@@ -1,5 +1,5 @@
 module OpenStudio
   module Analysis
-    VERSION = '0.4.5'
+    VERSION = '1.0.0.pat1'
   end
 end

data/lib/openstudio/analysis/workflow_step.rb

@@ -179,8 +179,11 @@ module OpenStudio
             v[:static_value] = v[:argument][:default_value] unless v[:static_value]
 
             v[:uncertainty_description] = {}
-            v[:uncertainty_description][:type] = v[:type] =~ /uncertain/ ? "#{v[:type]}" : "#{v[:type]}_uncertain"
-            warn "Deprecation Warning. In Version 0.5 the _uncertain text will be removed from distribution types: #{v[:uncertainty_description][:type]}"
+            # In Version 0.5 the _uncertain text will be removed from distribution
+            if v[:type] =~ /uncertain/
+              v[:type].delete!('_uncertain')
+            end
+            v[:uncertainty_description][:type] = v[:type]
 
             # This is not neatly coded. This should be a new object that knows how to write itself out.
             v[:uncertainty_description][:attributes] = []

data/lib/openstudio/analysis.rb

@@ -29,6 +29,12 @@ module OpenStudio
       csv.analysis
     end
 
+    # Process an OSA with a set of OSDs into OSWs
+    def self.make_osws(osa_filename, osd_array)
+      translator = OpenStudio::Analysis::Translator::Workflow.new(osa_filename)
+      osd_array.each {|osd| translator.process_datapoints osd}
+    end
+
     # Retrieve aws instance options from a project. This will return a hash
     def self.aws_instance_options(filename)
       if File.extname(filename) == '.xlsx'
@@ -54,5 +60,84 @@ module OpenStudio
 
       return options
     end
+
+    # Generate a DEnCity complient hash for uploading from the analysis hash
+    #TODO make this work off of the analysis object, not the hash.
+    def self.to_dencity_analysis(analysis_hash, analysis_uuid)
+      dencity_hash = {}
+      a = analysis_hash[:analysis]
+      provenance = {}
+      provenance[:user_defined_id] = analysis_uuid
+      provenance[:user_created_date] = ::Time.now
+      provenance[:analysis_types] = [a[:problem][:analysis_type]]
+      provenance[:name] = a[:name]
+      provenance[:display_name] = a[:display_name]
+      provenance[:description] = 'Auto-generated DEnCity analysis hash using the OpenStudio Analysis Gem'
+      measure_metadata = []
+      if a[:problem]
+        if a[:problem][:algorithm]
+          provenance[:analysis_information] = a[:problem][:algorithm]
+        else
+          fail 'No algorithm found in the analysis.json.'
+        end
+
+        if a[:problem][:workflow]
+          a[:problem][:workflow].each do |wf|
+            new_wfi = {}
+            new_wfi[:id] = wf[:measure_definition_uuid]
+            new_wfi[:version_id] = wf[:measure_definition_version_uuid]
+
+            # Eventually all of this could be pulled directly from BCL
+            new_wfi[:name] = wf[:measure_definition_class_name] if wf[:measure_definition_class_name]
+            new_wfi[:display_name] = wf[:measure_definition_display_name] if wf[:measure_definition_display_name]
+            new_wfi[:type] = wf[:measure_type] if wf[:measure_type]
+            new_wfi[:modeler_description] = wf[:modeler_description] if wf[:modeler_description]
+            new_wfi[:description] = wf[:description] if wf[:description]
+            new_wfi[:arguments] = []
+
+            if wf[:arguments]
+              wf[:arguments].each do |arg|
+                wfi_arg = {}
+                wfi_arg[:display_name] = arg[:display_name] if arg[:display_name]
+                wfi_arg[:display_name_short] = arg[:display_name_short] if arg[:display_name_short]
+                wfi_arg[:name] = arg[:name] if arg[:name]
+                wfi_arg[:data_type] = arg[:value_type] if arg[:value_type]
+                wfi_arg[:default_value] = nil
+                wfi_arg[:description] = ''
+                wfi_arg[:display_units] = '' # should be haystack compatible unit strings
+                wfi_arg[:units] = '' # should be haystack compatible unit strings
+
+                new_wfi[:arguments] << wfi_arg
+              end
+            end
+
+            if wf[:variables]
+              wf[:variables].each do |arg|
+                wfi_var = {}
+                wfi_var[:display_name] = arg[:argument][:display_name] if arg[:argument][:display_name]
+                wfi_var[:display_name_short] = arg[:argument][:display_name_short] if arg[:argument][:display_name_short]
+                wfi_var[:name] = arg[:argument][:name] if arg[:argument][:name]
+                wfi_var[:default_value] = nil
+                wfi_var[:data_type] = arg[:argument][:value_type] if arg[:argument][:value_type]
+                wfi_var[:description] = ''
+                wfi_var[:display_units] = arg[:units] if arg[:units]
+                wfi_var[:units] = '' # should be haystack compatible unit strings
+                new_wfi[:arguments] << wfi_var
+              end
+            end
+
+            measure_metadata << new_wfi
+          end
+        else
+          fail 'No workflow found in the analysis.json'
+        end
+
+        dencity_hash[:analysis] = provenance
+        dencity_hash[:measure_definitions] = measure_metadata
+      else
+        fail 'No problem found in the analysis.json'
+      end
+      return dencity_hash
+    end
   end
 end

data/lib/openstudio-analysis.rb

@@ -30,6 +30,7 @@ require 'openstudio/analysis/algorithm_attributes'
 # translators
 require 'openstudio/analysis/translator/excel'
 require 'openstudio/analysis/translator/datapoints'
+require 'openstudio/analysis/translator/workflow'
 
 # helpers / core_ext
 require 'openstudio/helpers/string'

data/openstudio-analysis.gemspec

@@ -24,11 +24,12 @@ Gem::Specification.new do |s|
 
   s.add_dependency 'faraday', '~> 0.8'
   s.add_dependency 'nokogiri', '~> 1.6'
-  s.add_dependency 'roo', '~> 1.12'
-  s.add_dependency 'rubyzip', '~> 1.0' # don't update because of jruby
+  s.add_dependency 'roo', '~> 2.3'
+  s.add_dependency 'rubyzip', '~> 1.2' # Should be at 1.0 because of jruby
   s.add_dependency 'semantic', '~> 1.4'
   s.add_dependency 'bcl', '~> 0.5.5'
+  s.add_dependency 'dencity', '~> 0.1.0'
 
   s.add_development_dependency 'bundler', '~> 1.7'
-  s.add_development_dependency 'rake', '~> 10.0'
+  s.add_development_dependency 'rake', '~> 11.1'
 end