openstudio-analysis 1.0.0.rc9 → 1.0.0.rc10

data/lib/openstudio/analysis/workflow_step.rb

@@ -38,6 +38,15 @@ module OpenStudio
         @measure_definition_version_uuid = nil
         @arguments = []
 
+        @arguments << {
+          display_name: 'Skip Entire Measure',
+          display_name_short: 'Skip',
+          name: '__SKIP__',
+          value_type: 'boolean',
+          default_value: false,
+          value: false
+        }
+
         # TODO: eventually the variables should be its own class. This would then be an array of Variable objects.
         @variables = []
       end
@@ -56,8 +65,8 @@ module OpenStudio
       # @return [Boolean] True/false if it assigned it
       def argument_value(argument_name, value)
         a = @arguments.find_all { |a| a[:name] == argument_name }
-        fail "could not find argument_name of #{argument_name} in measure #{name}. Valid argument names are #{argument_names}." if a.empty?
-        fail "more than one argument with the same name of #{argument_name} in measure #{name}" if a.size > 1
+        raise "could not find argument_name of #{argument_name} in measure #{name}. Valid argument names are #{argument_names}." if a.empty?
+        raise "more than one argument with the same name of #{argument_name} in measure #{name}" if a.size > 1
 
         a = a.first
 
@@ -101,11 +110,11 @@ module OpenStudio
         options = { variable_type: 'variable' }.merge(options)
         distribution[:mode] = distribution[:mean] if distribution.key? :mean
 
-        fail "Set the static value in the options 'options[:static_value]', not the distribution" if distribution[:static_value]
+        raise "Set the static value in the options 'options[:static_value]', not the distribution" if distribution[:static_value]
 
         a = @arguments.find_all { |a| a[:name] == argument_name }
-        fail "could not find argument_name of #{argument_name} in measure #{name}. Valid argument names are #{argument_names}." if a.empty?
-        fail "more than one argument with the same name of #{argument_name} in measure #{name}" if a.size > 1
+        raise "could not find argument_name of #{argument_name} in measure #{name}. Valid argument names are #{argument_names}." if a.empty?
+        raise "more than one argument with the same name of #{argument_name} in measure #{name}" if a.size > 1
 
         if distribution_valid?(distribution)
           # grab the argument hash
@@ -213,7 +222,7 @@ module OpenStudio
           end
 
         else
-          fail "Do not know how to create the Hash for Version #{version}"
+          raise "Do not know how to create the Hash for Version #{version}"
         end
 
         hash
@@ -240,7 +249,7 @@ module OpenStudio
         if File.exist?(path_to_measure) && File.file?(path_to_measure)
           path_to_measure = File.dirname(path_to_measure)
         else
-          fail "Could not find measure '#{instance_name}' in '#{path_to_measure}'" unless options[:ignore_not_found]
+          raise "Could not find measure '#{instance_name}' in '#{path_to_measure}'" unless options[:ignore_not_found]
         end
 
         # Extract the directory
@@ -328,7 +337,7 @@ module OpenStudio
         if File.exist?(path_to_measure) && File.file?(path_to_measure)
           path_to_measure = File.dirname(path_to_measure)
         else
-          fail "Could not find measure '#{instance_name}' in '#{path_to_measure}'" unless options[:ignore_not_found]
+          raise "Could not find measure '#{instance_name}' in '#{path_to_measure}'" unless options[:ignore_not_found]
         end
 
         # Extract the directo
@@ -409,31 +418,31 @@ module OpenStudio
       # validate the arguments of the distribution
       def distribution_valid?(d)
         # regardless of uncertainty description the following must be defined
-        fail 'No distribution defined for variable' unless d.key? :type
-        fail 'No minimum defined for variable' unless d.key? :minimum
-        fail 'No maximum defined for variable' unless d.key? :maximum
-        fail 'No mean/mode defined for variable' unless d.key? :mode
+        raise 'No distribution defined for variable' unless d.key? :type
+        raise 'No minimum defined for variable' unless d.key? :minimum
+        raise 'No maximum defined for variable' unless d.key? :maximum
+        raise 'No mean/mode defined for variable' unless d.key? :mode
 
         if d[:type] =~ /uniform/
           # Do we need to tell the user that we don't really need the mean/mode for uniform ?
         elsif d[:type] =~ /discrete/
           # require min, max, mode
-          fail 'No values passed for discrete distribution' unless d[:values] || d[:values].empty?
+          raise 'No values passed for discrete distribution' unless d[:values] || d[:values].empty?
           if d[:weights]
-            fail 'Weights are not the same length as values' unless d[:values].size == d[:weights].size
-            fail 'Weights do not sum up to one' unless d[:weights].reduce(:+).between?(0.99, 1.01) # allow a small error for now
+            raise 'Weights are not the same length as values' unless d[:values].size == d[:weights].size
+            raise 'Weights do not sum up to one' unless d[:weights].reduce(:+).between?(0.99, 1.01) # allow a small error for now
           else
             fraction = 1 / d[:values].size.to_f
             d[:weights] = [fraction] * d[:values].size
           end
         elsif d[:type] =~ /integer_sequence/
-            d[:weights] = 1
-            d[:values] = 1
+          d[:weights] = 1
+          d[:values] = 1
         elsif d[:type] =~ /triangle/
           # requires min, max, mode
         elsif d[:type] =~ /normal/ # both normal and lognormal
           # require min, max, mode, stddev
-          fail 'No standard deviation for variable' unless d[:standard_deviation]
+          raise 'No standard deviation for variable' unless d[:standard_deviation]
         end
 
         true

data/lib/openstudio/analysis.rb

@@ -32,7 +32,7 @@ module OpenStudio
     # 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}
+      osd_array.each { |osd| translator.process_datapoints osd }
     end
 
     # Retrieve aws instance options from a project. This will return a hash
@@ -55,14 +55,14 @@ module OpenStudio
         csv.process
         options = csv.settings
       else
-        fail 'Invalid file extension'
+        raise 'Invalid file extension'
       end
 
       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.
+    # 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]
@@ -78,7 +78,7 @@ module OpenStudio
         if a[:problem][:algorithm]
           provenance[:analysis_information] = a[:problem][:algorithm]
         else
-          fail 'No algorithm found in the analysis.json.'
+          raise 'No algorithm found in the analysis.json.'
         end
 
         if a[:problem][:workflow]
@@ -129,13 +129,13 @@ module OpenStudio
             measure_metadata << new_wfi
           end
         else
-          fail 'No workflow found in the analysis.json'
+          raise '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'
+        raise 'No problem found in the analysis.json'
       end
       return dencity_hash
     end

data/lib/openstudio/helpers/string.rb

@@ -20,11 +20,11 @@ def typecast_value(variable_type, value, inspect_string = false)
           elsif value.downcase == 'false'
             out_value = false
           else
-            fail "Can't cast to a bool from a value of '#{value}' of class '#{value.class}'"
+            raise "Can't cast to a bool from a value of '#{value}' of class '#{value.class}'"
           end
         end
       else
-        fail "Unknown variable type of '#{@variable['type']}'"
+        raise "Unknown variable type of '#{@variable['type']}'"
     end
   end
 

data/lib/openstudio/weather/epw.rb

@@ -56,7 +56,7 @@ module OpenStudio
       end
 
       def self.load(filename)
-        fail "EPW file does not exist: #{filename}" unless File.exist?(filename)
+        raise "EPW file does not exist: #{filename}" unless File.exist?(filename)
         f = OpenStudio::Weather::Epw.new(filename)
       end
 
@@ -65,7 +65,7 @@ module OpenStudio
           xml_builder_obj.name @city
           xml_builder_obj.visibility '0'
           xml_builder_obj.description do
-            xml_builder_obj.cdata!("<img src=\"kml/ep_header8.png\" width=180 align=right><br><table><tr><td colspan=\"2\">"\
+            xml_builder_obj.cdata!('<img src="kml/ep_header8.png" width=180 align=right><br><table><tr><td colspan="2">'\
                            "<b>#{@city}</b></href></td></tr>\n" +
                                        # "<tr><td></td><td><b>Data Type</td></tr>\n"+
                                        "<tr><td></td><td>WMO <b>#{@wmo}</b></td></tr>\n" +

data/openstudio-analysis.gemspec

@@ -25,7 +25,7 @@ Gem::Specification.new do |s|
   s.add_dependency 'faraday', '~> 0.8'
   s.add_dependency 'nokogiri', '~> 1.6'
   s.add_dependency 'roo', '~> 2.4'
-  s.add_dependency 'rubyzip', '~> 1.2' 
+  s.add_dependency 'rubyzip', '~> 1.2'
   s.add_dependency 'semantic', '~> 1.4'
   s.add_dependency 'bcl', '~> 0.5.7'
   s.add_dependency 'dencity', '~> 0.1.0'

data/spec/openstudio/excel_spec.rb

@@ -54,7 +54,7 @@ describe OpenStudio::Analysis::Translator::Excel do
     end
 
     it 'should fail to process' do
-      expect { @excel.process }.to raise_error("duplicate variable names found in list [\"Insulation R-value (ft^2*h*R/Btu).\"]")
+      expect { @excel.process }.to raise_error('duplicate variable names found in list ["Insulation R-value (ft^2*h*R/Btu)."]')
     end
   end
 
@@ -443,8 +443,8 @@ describe OpenStudio::Analysis::Translator::Excel do
       expect(j['analysis']['output_variables'].first['display_name_short']).to eq 'Site EUI'
       expect(j['analysis']['problem']['workflow'][0]['variables'][0]['argument']['display_name']).to eq 'Orientation'
       expect(j['analysis']['problem']['workflow'][0]['variables'][0]['argument']['display_name_short']).to eq 'Shorter Display Name'
-      expect(j['analysis']['problem']['workflow'][1]['arguments'][0]['display_name']).to eq 'unknown'
-      expect(j['analysis']['problem']['workflow'][1]['arguments'][0]['display_name_short']).to eq 'un'
+      expect(j['analysis']['problem']['workflow'][1]['arguments'][1]['display_name']).to eq 'unknown'
+      expect(j['analysis']['problem']['workflow'][1]['arguments'][1]['display_name_short']).to eq 'un'
     end
   end
 
@@ -485,7 +485,7 @@ describe OpenStudio::Analysis::Translator::Excel do
 
       expect(@excel.worker_inits.size).to eq 2
       expect(@excel.worker_inits[0][:name]).to eq 'initialize me'
-      expect(@excel.worker_inits[0][:args]).to eq "[\"first_arg\",2,{a_hash: \"input\"}]"
+      expect(@excel.worker_inits[0][:args]).to eq '["first_arg",2,{a_hash: "input"}]'
 
       # test the eval'ing of the args
       a = eval(@excel.analysis.worker_inits.first[:metadata][:args])

data/spec/openstudio/formulation_spec.rb

@@ -47,7 +47,7 @@ describe OpenStudio::Analysis::Formulation do
 
     h = a.to_hash
     expect(h[:analysis][:problem][:analysis_type]).to eq nil
-    expect(a.save "#{run_dir}/analysis.json").to eq true
+    expect(a.save("#{run_dir}/analysis.json")).to eq true
   end
 
   it 'should increment objective functions' do
@@ -124,7 +124,7 @@ describe OpenStudio::Analysis::Formulation do
     m.argument_value('heating_sch', 'some-string')
 
     expect(a.workflow.measures.size).to eq 2
-    expect(a.workflow.measures[1].arguments[2][:value]).to eq 'some-string'
+    expect(a.workflow.measures[1].arguments[3][:value]).to eq 'some-string'
     expect(a.workflow.measures[1].variables[0][:uuid]).to match /[\w]{8}(-[\w]{4}){3}-[\w]{12}/
 
     a.analysis_type = 'single_run'

data/spec/openstudio/osw_spec.rb

@@ -65,7 +65,7 @@ describe OpenStudio::Analysis::Translator::Workflow do
       expect(result).to be_a(Hash)
 
       # Save the file to the export directory
-      File.open('../../../spec/files/export/workflow/0.osw', 'w') { |f| f << JSON.pretty_generate(result)}
+      File.open('../../../spec/files/export/workflow/0.osw', 'w') { |f| f << JSON.pretty_generate(result) }
 
       expect(result.key?(:seed_model)).to eq false
       expect(result[:seed_file]).to eq 'large_office_air_cooled_chiller.osm'
@@ -75,7 +75,7 @@ describe OpenStudio::Analysis::Translator::Workflow do
 
     it 'should not write a osd with a different osa id' do
       osd_path = 'datapoint_wrong_osa_id.osd'
-      expect{ @translator.process_datapoint(osd_path).first }.to raise_error(RuntimeError)
+      expect { @translator.process_datapoint(osd_path).first }.to raise_error(RuntimeError)
     end
 
     it 'should write several osds' do

data/spec/openstudio/support_files_spec.rb

@@ -38,14 +38,12 @@ describe OpenStudio::Analysis::SupportFiles do
     expect(@s.size).to eq 1
 
     f = 'non-existent.rb'
-    expect{@s.add(f)}.to raise_error /Path or file does not exist and cannot be added.*/
+    expect { @s.add(f) }.to raise_error /Path or file does not exist and cannot be added.*/
   end
 
   it 'should add metadata data' do
-
   end
 
-
   it 'should add a directory' do
     @s.clear
     @s.add_files('spec/files/measures/**/*.rb', d: 'new')

data/spec/openstudio/workflow_spec.rb

@@ -64,7 +64,7 @@ describe OpenStudio::Analysis::Workflow do
     @w.add_measure_from_path('thermostat_2', 'thermostat 2', p)
 
     m = @w.find_measure('thermostat_2')
-    expect(m.argument_names).to eq %w(zones cooling_sch heating_sch material_cost)
+    expect(m.argument_names).to eq %w(__SKIP__ zones cooling_sch heating_sch material_cost)
 
     d = {
       type: 'uniform',

data/spec/schema/osa.json

@@ -287,6 +287,9 @@
         "description": {
           "description": "Description of design alternative",
           "type": "string"
+        },
+        "seed": {
+          "$ref": "#/definitions/Seed Object"
         }
       },
       "required": [

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: openstudio-analysis
 version: !ruby/object:Gem::Version
-  version: 1.0.0.rc9
+  version: 1.0.0.rc10
 platform: ruby
 authors:
 - Nicholas Long
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-11-08 00:00:00.000000000 Z
+date: 2016-11-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday