openstudio-analysis 0.3.2 → 0.3.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 36db3ffaec389ad563fbd3f673d03296e34aa188
-  data.tar.gz: 84cf2c11acae410f719d1521593a33330e38e8cc
+  metadata.gz: 0fe870e429ca62d620e81a6efc9d8893cf09ca52
+  data.tar.gz: 4226ac3ca16f4dce2ec3db097ed798904e9730de
 SHA512:
-  metadata.gz: 40d30b45fb9325c5a54f23cc99907ba2834e45faf4eba8d9191218de7a145d0bb441aef2be294f50c300ece8347f1e71bad8f42acddd915e585f9058547b9291
-  data.tar.gz: 5ae5179d6d2ccacffa3eb5d5a6e9f28d05748d7454a87b411db03539438f281af73eec38037f2b796097c94ec921ab8fd864fc3097c2b605ac1f1055b022a7bc
+  metadata.gz: 534247229fa8c6fe07fabb390cd28d6759c02fbcf236c615e18534a3f9afef97334e9c0835cb003dc215d875175a5e9a15f80d7e31f0abc1f6a5f00b0be5af23
+  data.tar.gz: 9d6811d8c106a225c341fecbb24b1b7bc30e1b20b04cf34ea7a9fc007e2988fb0f34be3b8344ad4ca70b80d31be2d7580eb15245d21b77bf4de502a77e8f50b9

data/CHANGELOG.md

@@ -4,6 +4,12 @@ OpenStudio Analysis Gem Change Log
 Unreleased
 --------------
 
+Version 0.3.3
+-------------
+* More unit tests
+* Allow a UUID model name to be automatically generated if the model name is not specified
+* Short name added to the variables input and output section of the spreadsheet. This required adding a new column and is not backwards compatible
+
 Version 0.3.2
 --------------
 * Support both relative and absolute paths in the spreadsheet

data/README.md

@@ -1,6 +1,6 @@
 OpenStudio Analysis Gem
 =======================
-
+[![Build Status](https://travis-ci.org/NREL/OpenStudio-analysis-gem.svg?branch=deve)](https://travis-ci.org/NREL/OpenStudio-analysis-gem)
 The OpenStudio Analysis Gem is used to communicate files to the OpenStudio Distributed Analysis.
 
 The purpose of this gem is to generate the analysis.json file, analysis.zip, and communicate with the server to upload 

data/Rakefile

@@ -29,7 +29,7 @@ end
 
 RSpec::Core::RakeTask.new("spec") do |spec|
   spec.rspec_opts = %w(--format progress --format CI::Reporter::RSpec)
-  spec.pattern = "spec/**/*_spec.rb"
+  spec.pattern = FileList['spec/**/*_spec.rb']
 end
 
 task :default => :spec

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

@@ -105,11 +105,13 @@ module OpenStudio
           @variables['data'].each do |measure|
             if measure['enabled']
               measure['variables'].each do |variable|
+
+
                 # Determine if row is suppose to be an argument or a variable to be perturbed.
                 if variable['variable_type'] == 'variable'
                   variable_names << variable['display_name']
 
-                  # make sure that the variable has a static value
+                  # make sure that variables have static values
                   if variable['distribution']['static_value'].nil? || variable['distribution']['static_value'] == ''
                     fail "Variable #{measure['name']}:#{variable['name']} needs a static value"
                   end
@@ -191,7 +193,7 @@ module OpenStudio
           uncertain_variable_template = ERB.new(File.open("#{template_root}/uncertain_variable.json.erb", 'r').read)
           discrete_uncertain_variable_template = ERB.new(File.open("#{template_root}/discrete_uncertain_variable.json.erb", 'r').read)
           pivot_variable_template = ERB.new(File.open("#{template_root}/pivot_variable.json.erb", 'r').read)
-          argument_template = ERB.new(File.open("#{template_root}/argument.json.erb", 'r').read)
+          argument_template = ERB.new(File.read("#{template_root}/argument.json.erb"))
 
           # Templated analysis json file (this is what is returned)
           puts "Analysis name is #{@name}"
@@ -347,41 +349,36 @@ module OpenStudio
             end
 
             # Add only the measures that are defined in the spreadsheet
-            added_measures = []
-            measure_files = Dir.glob("#{@measure_path}/**/measure.rb")
-
-            # go through each of the Variables
-            @variables['data'].each do |v|
-              measure_to_save = nil
-              measure_files.each do |measure|
-                # pp v['measure_file_name_directory']
-                if measure.include? "/#{v['measure_file_name_directory']}/"
-                  measure_to_save = File.dirname(measure)
-                  # pp "Measure to save is #{measure}"
-                  break
+            required_measures = @variables['data'].map { |v| v['measure_file_name_directory'] if v['enabled'] }.compact.uniq
+
+            # first validate that all the measures exist
+            errors = []
+            required_measures.each do |measure|
+              measure_dir_to_add = "#{@measure_path}/#{measure}"
+
+              if Dir.exist? measure_dir_to_add
+                unless File.exist? "#{measure_dir_to_add}/measure.rb"
+                  errors << "Measure in directory '#{@measure_path}/#{measure}' did not contain a measure.rb file"
                 end
+              else
+                errors << "Could not find measure '#{measure}' in directory '#{@measure_path}'"
               end
-
-              if measure_to_save && !added_measures.include?(measure_to_save)
-                # pp "Attempting to add measure #{measure_to_save}"
-                if File.exist?(measure_to_save)
-                  # pp "Adding measure directory to zip #{measure_to_save}"
-                  Dir[File.join(measure_to_save, '**')].each do |file|
-                    if File.directory?(file)
-                      if File.basename(file) == 'resources' || File.basename(file) == 'lib'
-                        add_directory_to_zip(zipfile, file, "./measures/#{v['measure_file_name_directory']}/#{File.basename(file)}")
-                      else
-                        # pp "Skipping Directory #{File.basename(file)}"
-                      end
-                    else
-                      # pp "Adding File #{file}"
-                      # added_measures << measure_dir unless added_measures.include? measure_dir
-                      zipfile.add(file.sub(measure_to_save, "./measures/#{v['measure_file_name_directory']}/"), file)
-                    end
+            end
+            fail errors.join("\n") unless errors.empty?
+
+            required_measures.each do |measure|
+              # pp "Adding measure directory to zip #{measure_to_save}"
+              Dir[File.join(measure, '**')].each do |file|
+                if File.directory?(file)
+                  if File.basename(file) == 'resources' || File.basename(file) == 'lib'
+                    add_directory_to_zip(zipfile, file, "./measures/#{v['measure_file_name_directory']}/#{File.basename(file)}")
+                  else
+                    # pp "Skipping Directory #{File.basename(file)}"
                   end
-                  added_measures << measure_to_save unless added_measures.include? measure_to_save
                 else
-                  fail "Could not find measure to add to zip for #{@measure_path}/#{v['measure_file_name_directory']}"
+                  # pp "Adding File #{file}"
+                  # added_measures << measure_dir unless added_measures.include? measure_dir
+                  zipfile.add(file.sub(measure, "./measures/#{v['measure_file_name_directory']}/"), file)
                 end
               end
             end
@@ -557,7 +554,7 @@ module OpenStudio
               end
 
             elsif b_algorithm_setup
-              if row[0]
+              if row[0] && !row[0].empty?
                 v = row[1]
                 v = v.to_i if v % 1 == 0
                 @algorithm["#{row[0].snake_case}"] = v
@@ -607,7 +604,31 @@ module OpenStudio
           # puts rows.inspect
           rows = nil
           begin
-            if @version >= '0.3.0'.to_version
+            if @version >= '0.3.3'.to_version
+              rows = @xls.sheet('Variables').parse(enabled: '# variable',
+                                                   measure_name_or_var_type: 'type',
+                                                   measure_file_name_or_var_display_name: 'parameter display name.*',
+                                                   measure_file_name_directory: 'measure directory',
+                                                   measure_type_or_parameter_name_in_measure: 'parameter name in measure',
+                                                   display_name_short: 'parameter short display name',
+                                                   #sampling_method: 'sampling method',
+                                                   variable_type: 'Variable Type',
+                                                   units: 'units',
+                                                   default_value: 'static.default value',
+                                                   enums: 'enumerations',
+                                                   min: 'min',
+                                                   max: 'max',
+                                                   mode: 'mean|mode',
+                                                   stddev: 'std dev',
+                                                   delta_x: 'delta.x',
+                                                   discrete_values: 'discrete values',
+                                                   discrete_weights: 'discrete weights',
+                                                   distribution: 'distribution',
+                                                   source: 'data source',
+                                                   notes: 'notes',
+                                                   relation_to_eui: 'typical var to eui relationship',
+                                                   clean: true)
+            elsif @version >= '0.3.0'.to_version
               rows = @xls.sheet('Variables').parse(enabled: '# variable',
                                                    measure_name_or_var_type: 'type',
                                                    measure_file_name_or_var_display_name: 'parameter display name.*',
@@ -745,6 +766,9 @@ module OpenStudio
                 var = {}
                 var['variable_type'] = row[:measure_name_or_var_type]
                 var['display_name'] = row[:measure_file_name_or_var_display_name]
+                var['display_name_short'] = row[:display_name_short] ? row[:display_name_short] : var['display_name']
+
+                # TODO: convert this to measure class and parameter name
                 var['machine_name'] = row[:measure_file_name_or_var_display_name].downcase.strip.gsub('-', '_').gsub(' ', '_').strip
                 var['name'] = row[:measure_type_or_parameter_name_in_measure]
                 var['index'] = variable_index # order of the variable (not sure of its need)
@@ -809,7 +833,20 @@ module OpenStudio
 
         def parse_outputs
           rows = nil
-          if @version >= '0.3.0'.to_version
+          if @version >= '0.3.3'.to_version
+            rows = @xls.sheet('Outputs').parse(display_name: 'Variable Display Name',
+                                               display_name_short: 'Short Display Name',
+                                               metadata_id: 'Taxonomy Identifier',
+                                               name: '^Name$',
+                                               units: 'Units',
+                                               visualize: 'Visualize',
+                                               export: 'Export',
+                                               variable_type: 'Variable Type',
+                                               objective_function: 'Objective Function',
+                                               objective_function_target: 'Objective Function Target',
+                                               scaling_factor: 'Scale',
+                                               objective_function_group: 'Objective Function Group')
+          elsif @version >= '0.3.0'.to_version
             rows = @xls.sheet('Outputs').parse(display_name: 'Variable Display Name',
                                                metadata_id: 'Taxonomy Identifier',
                                                name: '^Name$',
@@ -847,6 +884,7 @@ module OpenStudio
 
             var = {}
             var['display_name'] = row[:display_name]
+            var['display_name_short'] = row[:display_name_short] ? row[:display_name_short] : row[:display_name]
             var['metadata_id'] = row[:metadata_id]
             var['name'] = row[:name]
             var['units'] = row[:units]

data/lib/openstudio/analysis/version.rb

@@ -1,5 +1,5 @@
 module OpenStudio
   module Analysis
-    VERSION = '0.3.2'
+    VERSION = '0.3.3'
   end
 end

data/lib/openstudio/templates/argument.json.erb

@@ -1,5 +1,6 @@
 {
     "display_name": "<%= @variable['display_name'] %>",
+    "display_name_short": "<%= @variable['display_name_short'] %>",
     "machine_name": "<%= @variable['machine_name'] %>",
     "name": "<%= @variable['name'] %>",
     "value": <%= @static_value %>,

data/lib/openstudio/templates/discrete_uncertain_variable.json.erb

@@ -1,6 +1,7 @@
 {
     "argument": {
         "display_name": "<%= @variable['display_name'] %>",
+        "display_name_short": "<%= @variable['display_name_short'] %>",
         "machine_name": "<%= @variable['machine_name'] %>",
         "name": "<%= @variable['name'] %>",
         "required": false,
@@ -8,6 +9,7 @@
         "version_uuid": "<%= UUID.new.generate %>"
     },
     "display_name": "<%= @variable['display_name'] %>",
+    "display_name_short": "<%= @variable['display_name_short'] %>",
     "machine_name": "<%= @variable['machine_name'] %>",
     "maximum": <%= @variable['distribution']['max'] ?  @variable['distribution']['max'].inspect : 'null' %>,
     "minimum": <%= @variable['distribution']['min'] ?  @variable['distribution']['min'].inspect : 'null' %>,

data/lib/openstudio/templates/pivot_variable.json.erb

@@ -1,6 +1,7 @@
 {
     "argument": {
         "display_name": "<%= @variable['display_name'] %>",
+        "display_name_short": "<%= @variable['display_name_short'] %>",
         "machine_name": "<%= @variable['machine_name'] %>",
         "name": "<%= @variable['name'] %>",
         "required": false,
@@ -8,6 +9,7 @@
         "version_uuid": "<%= UUID.new.generate %>"
     },
     "display_name": "<%= @variable['display_name'] %>",
+    "display_name_short": "<%= @variable['display_name_short'] %>",
     "machine_name": "<%= @variable['machine_name'] %>",
     "name": "<%= @variable['machine_name'] %>",
     "pivot": true,

data/lib/openstudio/templates/uncertain_variable.json.erb

@@ -1,6 +1,7 @@
 {
     "argument": {
         "display_name": "<%= @variable['display_name'] %>",
+        "display_name_short": "<%= @variable['display_name_short'] %>",
         "machine_name": "<%= @variable['machine_name'] %>",
         "name": "<%= @variable['name'] %>",
         "required": false,
@@ -8,6 +9,7 @@
         "version_uuid": "<%= UUID.new.generate %>"
     },
     "display_name": "<%= @variable['display_name'] %>",
+    "display_name_short": "<%= @variable['display_name_short'] %>",
     "machine_name": "<%= @variable['machine_name'] %>",
     "maximum": <%= @variable['distribution']['max'] ?  @variable['distribution']['max'].inspect : 'null' %>,
     "minimum": <%= @variable['distribution']['min'] ?  @variable['distribution']['min'].inspect : 'null' %>,