openstudio-analysis 0.1.6 → 0.1.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 13b5dec27ec223ea03b7ec5639507606f743cf3c
-  data.tar.gz: a36e11a236c5afc09ec0e63ca4298b98f0d4fb55
+  metadata.gz: 4ae67d42886b996287c5359e182083045cfe85b6
+  data.tar.gz: 89317f8592fb0d6d68be5d4d2b86fb8de0c33614
 SHA512:
-  metadata.gz: dcafcb379a586b42a980d9e8aad98b5bb7cff9389b7c32b28239c832629367f65c9b98207c4d63690e8acc1d1cc391adcb6915bdb99f0941f4ad73d3ad2a2b36
-  data.tar.gz: afbc982b5e00649b58a5aa70eb4ea648f2004c16d9eed61f8e61c1468aaa487bbe0080af34af926303fc2a66a7d65a214cd4cac7e9bd118a8a59b09d96d6b9e6
+  metadata.gz: d07df1298aeddd96b09b58a72ae55802d5badc04c194d50cac81df509dbf817b989b758a560306109d74a867ae8fd039543230f5b1edbac45870e77ad23525c7
+  data.tar.gz: ad4f1c8a02213360581455198bd1ffa8e19750967359ba223048b35f2a3de5296bd89e8a02de71494c2496cce8e95cfa1c277fda38caea5516e761b252c9ce75

data/CHANGELOG.md

@@ -1,6 +1,17 @@
 OpenStudio Analysis Gem Change Log
 ==================================
 
+Version 0.1.7
+-------------
+
+* Add setting section
+
+* Add problem and algorithm arguments
+
+Version 0.1.6
+-------------
+                 
+* Small fixes                
 Version 0.1.5
 -------------
 

data/Rakefile

@@ -28,7 +28,7 @@ task :release => :build do
 end
 
 RSpec::Core::RakeTask.new("spec") do |spec|
-  spec.rspec_opts = %w(--format progress --format CI::Reporter::RSpec)
+  #spec.rspec_opts = %w(--format progress --format CI::Reporter::RSpec)
   spec.pattern = "spec/**/*_spec.rb"
 end
 

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

@@ -2,20 +2,24 @@ module OpenStudio
   module Analysis
     module Translator
       class Excel
+        attr_reader :version
+        attr_reader :settings
         attr_reader :variables
         attr_reader :models
         attr_reader :weather_files
         attr_reader :measure_path
         attr_reader :export_path
         attr_reader :variables
-        
+        attr_reader :algorithm
+        attr_reader :problem
+
         # remove these once we have classes to construct the JSON file
         attr_reader :name
-        attr_reader :number_of_samples
+        attr_reader :machine_name
         attr_reader :template_json
 
         # methods to override instance variables
-        
+
         # pass in the filename to read
         def initialize(xls_filename)
           @root_path = File.expand_path(File.dirname(xls_filename))
@@ -29,15 +33,21 @@ module OpenStudio
           end
 
           # Initialize some other instance variables
+          @version = nil
+          @name = nil
+          @machine_name = nil
+          @settings = {}
           @weather_files = []
           @models = []
           @other_files = []
           @export_path = "./export"
           @measure_path = "./measures"
-          @number_of_samples = 0
+          @number_of_samples = 0 # todo: remove this
+          @problem = {}
+          @algorithm = {}
           @template_json = nil
         end
-        
+
         def process
           @setup = parse_setup()
           @variables = parse_variables()
@@ -76,7 +86,7 @@ module OpenStudio
           end
 
           FileUtils.mkdir_p(@export_path)
-          
+
           # verify that all continuous variables have all the data needed and create a name maps
           variable_names = []
           @variables['data'].each do |measure|
@@ -120,7 +130,7 @@ module OpenStudio
           if dupes.count > 0
             raise "duplicate variable names found in list #{dupes.inspect}"
           end
-          
+
           # most of the checks will raise a runtime exception, so this true will never be called
           true
         end
@@ -129,7 +139,7 @@ module OpenStudio
           # save the format in the OpenStudio analysis json format template without
           # the correct weather files or models
           @template_json = translate_to_analysis_json_template()
-          
+
           #validate_template_json
 
           # iterate over each model and save the zip and json
@@ -274,8 +284,6 @@ module OpenStudio
           analysis_json['analysis']['seed']['path'] = "./seed/#{File.basename(model[:path])}"
 
           # Set the weather file as the first in the list -- this is optional
-          # TODO: check if epw or if zip file
-
           analysis_json['analysis']['weather_file']['file_type'] = 'EPW'
           if File.extname(@weather_files.first) =~ /.zip/i
             analysis_json['analysis']['weather_file']['path'] = "./weather/#{File.basename(@weather_files.first, '.zip')}.epw"
@@ -288,48 +296,78 @@ module OpenStudio
 
           File.open("#{@export_path}/#{model[:name]}.json", "w") { |f| f << JSON.pretty_generate(analysis_json) }
         end
-        
+
         # parse_setup will pull out the data on the "setup" tab and store it in memory for later use
         def parse_setup()
           rows = @xls.sheet('Setup').parse()
+          b_settings = false
           b_run_setup = false
           b_problem_setup = false
+          b_algorithm_setup = false
           b_weather_files = false
           b_models = false
           b_other_libs = false
 
           rows.each do |row|
-            if row[0] == "Running Setup"
+            if row[0] == "Settings"
+              b_settings = true
+              b_run_setup = false
+              b_problem_setup = false
+              b_algorithm_setup = false
+              b_weather_files = false
+              b_models = false
+              b_other_libs = false
+              next
+            elsif row[0] == "Running Setup"
+              b_settings = false
               b_run_setup = true
               b_problem_setup = false
+              b_algorithm_setup = false
               b_weather_files = false
               b_models = false
               b_other_libs = false
               next
             elsif row[0] == "Problem Definition"
+              b_settings = false
               b_run_setup = false
               b_problem_setup = true
+              b_algorithm_setup = false
+              b_weather_files = false
+              b_models = false
+              b_other_libs = false
+              next
+            elsif row[0] == "Algorithm Setup"
+              b_settings = false
+              b_run_setup = false
+              b_problem_setup = false
+              b_algorithm_setup = true
               b_weather_files = false
               b_models = false
               b_other_libs = false
               next
             elsif row[0] == "Weather Files"
+              b_settings = false
               b_run_setup = false
               b_problem_setup = false
+              b_algorithm_setup = false
               b_weather_files = true
               b_models = false
               b_other_libs = false
               next
             elsif row[0] == "Models"
+              b_settings = false
               b_run_setup = false
               b_problem_setup = false
+              b_algorithm_setup = false
               b_weather_files = false
               b_models = true
               b_other_libs = false
               next
             elsif row[0] == "Other Library Files"
+              b_settings = false
               b_run_setup = false
               b_problem_setup = false
+              b_algorithm_setup = false
               b_weather_files = false
               b_models = false
               b_other_libs = true
@@ -338,12 +376,18 @@ module OpenStudio
 
             next if row[0].nil?
 
-            if b_run_setup
+            if b_settings
+              @version = row[1].chomp if row[0] == "Spreadsheet Version"
+              @settings["#{row[0].snake_case}"] = row[1] if row[0]
+            elsif b_run_setup
               @name = row[1].chomp if row[0] == "Analysis Name"
+              @machine_name = @name.snake_case
               @export_path = File.expand_path(File.join(@root_path, row[1])) if row[0] == "Export Directory"
               @measure_path = File.expand_path(File.join(@root_path, row[1])) if row[0] == "Measure Directory"
             elsif b_problem_setup
-              @number_of_samples = row[1].to_i if row[0] == "Number of Samples"
+              @problem["#{row[0].snake_case}"] = row[1] if row[0]
+            elsif b_algorithm_setup
+              @algorithm["#{row[0].snake_case}"] = row[1] if row[0]
             elsif b_weather_files
               if row[0] == "Weather File"
                 @weather_files += Dir.glob(File.expand_path(File.join(@root_path, row[1])))
@@ -362,11 +406,11 @@ module OpenStudio
         # be omitted as an intermediate step
         def parse_variables()
           rows = @xls.sheet('Variables').parse()
-          
-          if !rows 
+
+          if !rows
             raise "Could not find the sheet name 'Variables' in excel file #{@root_path}"
           end
-          
+
           data = {}
           data['data'] = []
 
@@ -429,7 +473,7 @@ module OpenStudio
               data['data'][measure_index] = {}
 
               #generate name id
-              puts "Parsing measure #{row[1]}"
+              #todo: put this into a logger. puts "Parsing measure #{row[1]}"
               display_name = row[1].chomp.strip
               measure_name = display_name.downcase.strip.gsub("-", "_").gsub(" ", "_")
               data['data'][measure_index]['display_name'] = display_name
@@ -438,7 +482,7 @@ module OpenStudio
               data['data'][measure_index]['measure_file_name'] = row[2]
               data['data'][measure_index]['measure_file_name_directory'] = row[2].underscore
               data['data'][measure_index]['measure_type'] = row[3]
-              
+
               data['data'][measure_index]['version'] = @version_id
 
               data['data'][measure_index]['variables'] = []

data/lib/openstudio/analysis/version.rb

@@ -1,6 +1,6 @@
 module OpenStudio
   module Analysis
-    VERSION = "0.1.6"
+    VERSION = "0.1.7"
     OPENSTUDIO_VERSION = "1.1.4"
   end
 end

data/lib/openstudio/helpers/string.rb

@@ -8,5 +8,10 @@ class String
         tr("-", "_").
         downcase
   end
+  
+  def snake_case
+    self.gsub(" ", "_").
+        downcase
+  end
 end
                      

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

@@ -4,15 +4,15 @@
         "name": "<%= @name.downcase.gsub(" ", "_") %>",
         "algorithm": {
             "sample_method": "lhs",
-            "number_of_samples": <%= @number_of_samples %>
+            "number_of_samples": <%= @problem['number_of_samples'].to_i %>
         },
         "parameter_space": [],
         "problem": {
-            "number_of_samples_KEEP_HERE_UNTIL_ALGO_IS_IMPLEMENTED": <%= @number_of_samples %>,
-            "number_of_samples": <%= @number_of_samples %>,
+            "number_of_samples_KEEP_HERE_UNTIL_ALGO_IS_IMPLEMENTED": <%= @problem['number_of_samples'].to_i %>,
+            "number_of_samples": <%= @problem['number_of_samples'].to_i %>,
             "algorithm": {
-                "number_of_samples": <%= @number_of_samples %>,
-                "sample_method": "all_variables"
+                "number_of_samples": <%= @problem['number_of_samples'].to_i %>,
+                "sample_method": <%= @problem['sensitivity_method'].to_i %>
             },
             "name": "Problem",
             "workflow": []