openstudio-analysis 0.3.7 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 9d66a0d90f0f410e7db18fbdc523c191991d5d20
-  data.tar.gz: da6f448c4902518e932ad8a17dd183be1d6ff8d7
+  metadata.gz: 8716110e6823303d2e72cbcf6b2ddb1a4284776c
+  data.tar.gz: 7a7a80b05caa4e9c9ab2172b1b65965ce8f3cd77
 SHA512:
-  metadata.gz: d5440d40d0d9bcaf5d0d07e4f8a88471df0d8063b88c2fd2da335b5d48fd3900fe39c72045b398d8929f594ee5fb40fb3038c96bb9896bfef83e0c55f8c489cb
-  data.tar.gz: 22f2c7ab4cc3bae5e0bccda01921f95c22c7ee3b6bd221e0e75950cc79b760e5ccda9aaf1d660c6d5a249f16fbaf159c3c04e76cbc2fd43285d114353ad871b4
+  metadata.gz: bc00fe5e63398aeace567d74799dbfb677446a33edd9586c770488133028fcfc328a4285782a72d1ba2f414e6133327a26de4c3d3a069c5d6aac19bf2676ea75
+  data.tar.gz: 543aa0bbc534055de801d433dd5446c05cc4e9fbff5d1c8134605c0f6d9414800cc27266924f3ce0d9113c86ff0c792c71dc9f479c57ab2f4d6eb1c3376eec0b

data/CHANGELOG.md

@@ -1,10 +1,14 @@
 OpenStudio Analysis Gem Change Log
 ==================================
 
-Version 0.3.7 (Unreleased)
+Version 0.4.0
 -------------
-* Worker initilization and finalization scripts
-* Do not allow the file to proccess if the Measure Display Names are not unique
+* Add programmatic interface. This is now used when translating the Excel file into the JSON.
+
+Version 0.3.7
+-------------
+* Worker initialization and finalization scripts
+* Do not allow the file to process if the Measure Display Names are not unique
 
 Version 0.3.6
 -------------
@@ -96,7 +100,7 @@ Version 0.1.7
 Version 0.1.6
 -------------
 * Small fixes
-                
+
 Version 0.1.5
 -------------
 * Now depends on json_pure for window users
@@ -119,5 +123,3 @@ Version 0.1.1
 * Convert argument values to the right variable types
 
 * Add measure type parsing by reading the inherited class
-
-

data/README.md

@@ -1,5 +1,5 @@
-OpenStudio Analysis Gem
-=======================
+# OpenStudio Analysis Gem
+
 [![Build Status](https://travis-ci.org/NREL/OpenStudio-analysis-gem.svg?branch=develop)](https://travis-ci.org/NREL/OpenStudio-analysis-gem) [![Dependency Status](https://www.versioneye.com/user/projects/540a2fe5ccc023dd23000002/badge.svg?style=flat)](https://www.versioneye.com/user/projects/540a2fe5ccc023dd23000002)
 
 The OpenStudio Analysis Gem is used to communicate files to the OpenStudio Distributed Analysis.
@@ -7,13 +7,61 @@ The OpenStudio Analysis Gem is used to communicate files to the OpenStudio Distr
 The purpose of this gem is to generate the analysis.json file, analysis.zip, and communicate with the server to upload
 the simulations.
 
-The gem does not create the cluster. Currently the only supported Cloud platform is
+This gem does not create the cluster. Currently the only supported Cloud platform is
 Amazon AWS using either [OpenStudio's PAT](https://openstudio.nrel.gov) the [openstudio-aws gem](https://rubygems.org/gems/openstudio-aws) or using [vagrant](http://www.vagrantup.com/).
 
-Instructions
-------------
+## Instructions
+
+There are two ways to create an OpenStudio Analysis description:
+* Use the Excel Translator
+
+
+* Programmatically
+
+```
+analysis = OpenStudio::Analysis.create
+analysis.seed_model = "local/dir/seed.osm"
+analysis.name = "Analysis Name"
+
+# override existing workflow from a file by
+analysis.workflow = OpenStudio::Analysis::Workflow.load_from_file(...)
+
+# add measures to the workflow
+wf = analysis.workflow
+wf.add_measure_from_path("path_to_measure")
+wf.add_measure_from_path("path_to_measure_2")
+
+# or allow the system to search for the measure based on default_measure_paths
+OpenStudio::Analysis.measure_paths = ['measures', '../project_specific_measures']
+wf.add_measure_by_name('measure_name')
+
+# make a measure's argument a variable
+m = wf.add_measure("path_to_measure_3")
+m.make_variable('variable_argument_name', 'discrete')
+
+m = wf.add_measure('path_to_measure_4')
+m.make_variable('variable_argument_name', 'pivot')
+m.argument_static_value('variable_argument_name', value)
+
+```
+
+
+## Testing
 
-Testing
--------
 
 This gem used RSpec for testing.  To test simply run `rspec` at the command line.
+
+# Todos
+
+In the programmatic interface there are still several items that need to be checked
+
+* verify that the measure.xml file exists
+* Check the type of measure being added and make sure that it is in the right workflow (e.g. no energyplus measures before rubymeasures)
+* add reverse translator from existing analysis.jsons
+* more explicit run workflows. For example, add workflow steps for running energyplus, openstudio translator, radiance, etc
+* more explicit assignment of the analyses that can run. This would be nice:
+    ```
+    a = OpenStudio::Analysis.create("new analysis")
+    a.analysis_type('single_run')
+    ```
+

data/Rakefile

@@ -23,3 +23,13 @@ task 'spec:unit' => 'ci:setup:rspec'
 task 'spec:integration' => 'ci:setup:rspec'
 
 task default: 'spec:unit'
+
+require 'rubocop/rake_task'
+desc 'Run RuboCop on the lib directory'
+RuboCop::RakeTask.new(:rubocop) do |task|
+  task.options = ['--no-color', '--out=rubocop-results.xml']
+  task.formatters = ['RuboCop::Formatter::CheckstyleFormatter']
+  task.requires = ['rubocop/formatter/checkstyle_formatter']
+  # don't abort rake on failure
+  task.fail_on_error = false
+end

data/lib/openstudio/analysis/algorithm_attributes.rb

@@ -0,0 +1,22 @@
+# OpenStudio::Analysis::Algorithm to define the algorithm parameters. The module and class names start to conflict
+# with OpenStudio's namespace. Be careful adding new classes without first making sure that the namespace conflict
+# is clear.
+module OpenStudio
+  module Analysis
+    class AlgorithmAttributes
+      # Create a new instance of an algorithm
+      #
+      def initialize
+        @attributes = {}
+      end
+
+      def set_attribute(attribute_name, attribute_value)
+        @attributes[attribute_name] = attribute_value
+      end
+
+      def to_hash(_version = 1)
+        @attributes
+      end
+    end
+  end
+end

data/lib/openstudio/analysis/formulation.rb

@@ -0,0 +1,174 @@
+# OpenStudio formulation class handles the generation of the OpenStudio Analysis format.
+module OpenStudio
+  module Analysis
+    SeedModel = Struct.new(:path)
+    WeatherFile = Struct.new(:path)
+
+    class Formulation
+      attr_reader :seed_model
+      attr_reader :weather_file
+      attr_accessor :display_name
+      attr_accessor :workflow
+      attr_accessor :algorithm
+
+      attr_reader :analysis_type
+
+      # Create an instance of the OpenStudio::Analysis::Formulation
+      #
+      # @param display_name [String] Display name of the project.
+      # @return [Object] An OpenStudio::Analysis::Formulation object
+      def initialize(display_name)
+        @display_name = display_name
+        @analysis_type = nil
+        @outputs = []
+
+        # Initialize child objects (expect workflow)
+        @weather_file = WeatherFile.new
+        @seed_model = SeedModel.new
+        @algorithm = OpenStudio::Analysis::AlgorithmAttributes.new
+      end
+
+      # Initialize or return the current workflow object
+      #
+      # @return [Object] An OpenStudio::Analysis::Workflow object
+      def workflow
+        @workflow ||= OpenStudio::Analysis::Workflow.new
+      end
+
+      # Define the type of analysis that this is going to be running
+      #
+      # @param name [String] Name of the algorithm/analysis. (e.g. rgenoud, lhs, single_run)
+      attr_writer :analysis_type
+
+      # Path to the seed model
+      #
+      # @param path [String] Path to the seed model. This should be relative.
+      def seed_model(path)
+        @seed_model = SeedModel.new(path: path)
+      end
+
+      # Path to the weather file (or folder). If it is a folder, then the measures will look for the weather file
+      # by name in that folder.
+      #
+      # @param path [String] Path to the weather file or folder.
+      def weather_file(path)
+        @weather_file = WeatherFile.new(path: path)
+      end
+
+      # Add an output of interest to the problem formulation
+      #
+      # @param output_hash [Hash] Hash of the output variable in the legacy format
+      # @option output_hash [String] :display_name Name to display
+      # @option output_hash [String] :display_name_short A shorter display name
+      # @option output_hash [String] :metadata_id Link to DEnCity ID in which this output corresponds
+      # @option output_hash [String] :name Unique machine name of the variable. Typically this is measure.attribute
+      # @option output_hash [String] :export Export the variable to CSV and dataframes from OpenStudio-server
+      # @option output_hash [String] :visualize Visualize the variable in the plots on OpenStudio-server
+      # @option output_hash [String] :units Units of the variable as a string
+      # @option output_hash [String] :variable_type Data type of the variable
+      # @option output_hash [Boolean] :objective_function Whether or not this output is an objective function. Default: false
+      # @option output_hash [Integer] :objective_function_index Index of the objective function. Default: nil
+      # @option output_hash [Float] :objective_function_target Target for the objective function to reach (if defined). Default: nil
+      # @option output_hash [Float] :scaling_factor How to scale the objective function(s). Default: nil
+      # @option output_hash [Integer] :objective_function_group If grouping objective functions, then group ID. Default: nil
+      def add_output(output_hash)
+        output_hash = {
+          units: '',
+          objective_function: false,
+          objective_function_index: nil,
+          objective_function_target: nil,
+          objective_function_group: nil,
+          scaling_factor: nil
+        }.merge(output_hash)
+
+        # if the objective_function index is nil and the variable is an objective function, then increment and
+        # assign and objective function index
+        unless output_hash[:objective_function_index]
+          values = @outputs.map { |o| o[:objective_function_index] }
+          output_hash[:objective_function_index] = values.empty? ? 0 : values.max + 1
+        end
+
+        @outputs << output_hash
+      end
+
+      # return a hash.
+      #
+      # @param version [Integer] Version of the format to return
+      # @return [Hash]
+      def to_hash(version = 1)
+        # fail 'Must define an analysis type' unless @analysis_type
+        if version == 1
+          h = {
+            analysis: {
+              display_name: @display_name,
+              name: @display_name.snake_case,
+              output_variables: @outputs,
+              problem: {
+                analysis_type: @analysis_type,
+                algorithm: algorithm.to_hash(version),
+                workflow: workflow.to_hash(version)
+              },
+              seed: @seed_model[:path],
+              weather_file: @weather_file[:path],
+              file_format_version: version
+            }
+          }
+
+          # This is a hack right now, but after the initial hash is created go back and add in the objective functions
+          # to the the algorithm as defined in the output_variables list
+          ofs = @outputs.map { |i| i[:name] if i[:objective_function] }.compact
+          if h[:analysis][:problem][:algorithm]
+            h[:analysis][:problem][:algorithm][:objective_functions] = ofs
+          end
+
+          h
+        else
+          fail "Version #{version} not defined for #{self.class} and #{__method__}"
+        end
+      end
+
+      # return a hash of the data point with the static variables set
+      #
+      # @param version [Integer] Version of the format to return
+      # @return [Hash]
+      def to_static_data_point_hash(version = 1)
+        if version == 1
+          static_hash = {}
+          # TODO: this method should be on the workflow step and bubbled up to this interface
+          @workflow.items.map do |item|
+            item.variables.map { |v| static_hash[v[:uuid]] = v[:static_value] }
+          end
+
+          h = {
+            data_point: {
+              set_variable_values: static_hash,
+              status: 'na',
+              uuid: SecureRandom.uuid
+            }
+          }
+          h
+        end
+      end
+
+      # save the file to JSON. Will overwrite the file if it already exists
+      #
+      # @param version [Integer] Version of the format to return
+      # @return [Boolean]
+      def save(filename, version = 1)
+        File.open(filename, 'w') { |f| f << JSON.pretty_generate(to_hash(version)) }
+
+        true
+      end
+
+      # save the data point JSON with the variables set to the static values. Will overwrite the file if it already exists
+      #
+      # @param version [Integer] Version of the format to return
+      # @return [Boolean]
+      def save_static_data_point(filename, version = 1)
+        File.open(filename, 'w') { |f| f << JSON.pretty_generate(to_static_data_point_hash(version)) }
+
+        true
+      end
+    end
+  end
+end

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

@@ -139,12 +139,11 @@ module OpenStudio
             fail "Measure Display Names are not unique for '#{measure_display_names_mult.join('\', \'')}'"
           end
 
-          # verify that all continuous variables have all the data needed and create a name maps
+          # verify that all continuous variables have all the data needed and create a name map
           variable_names = []
           @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']
@@ -179,7 +178,7 @@ module OpenStudio
                     if variable['distribution']['max'].nil? || variable['distribution']['max'] == ''
                       fail "Variable #{measure['name']}:#{variable['name']} must have a maximum"
                     end
-                    unless variable['type'] == 'string'
+                    unless variable['type'] == 'string' || variable['type'] =~ /bool/
                       if variable['distribution']['min'] > variable['distribution']['max']
                         fail "Variable min is greater than variable max for #{measure['name']}:#{variable['name']}"
                       end
@@ -205,6 +204,9 @@ module OpenStudio
           # the correct weather files or models
           @template_json = translate_to_analysis_json_template
 
+          # save the other format for now
+          translate_to_analysis
+
           @template_json
         end
 
@@ -223,7 +225,31 @@ module OpenStudio
           end
         end
 
-        # TODO: move this into a new class that helps construct this file
+        # New method that uses the objects to hold the analysis
+        def translate_to_analysis
+          # Use the programmatic interface to make the analysis json now
+          analysis = OpenStudio::Analysis.create(@analysis_name)
+
+          @variables['data'].each do |measure|
+            next unless measure['enabled']
+
+            # TODO: make this read the measure.rb file, then override any of the differences. That is call workflow.add_from_measure_path
+            analysis.workflow.add_measure_from_excel(measure)
+          end
+
+          # Add in the outputs
+
+          @outputs['output_variables'].each do |o|
+            o = Hash[o.map { |k, v| [k.to_sym, v] }]
+            analysis.add_output(o)
+          end
+
+          # Temp save of the json file
+          analysis.save("spec/files/analysis/#{analysis.display_name}_api.json")
+
+          analysis
+        end
+
         def translate_to_analysis_json_template
           # Load in the templates for constructing the JSON file
           template_root = File.join(File.dirname(__FILE__), '../../templates')
@@ -267,21 +293,10 @@ module OpenStudio
 
                   # add this as an argument
                   case @variable['type'].downcase
-                    when 'double'
-                      @static_value = @variable['distribution']['static_value'].to_f
-                    when 'integer'
-                      @static_value = @variable['distribution']['static_value'].to_i
-                    # TODO: update openstudio export to write only Strings
                     when 'string', 'choice'
                       @static_value = @variable['distribution']['static_value'].inspect
-                    when 'bool'
-                      if @variable['distribution']['static_value'].downcase == 'true'
-                        @static_value = true
-                      else
-                        @static_value = false
-                      end
                     else
-                      fail "Unknown variable type of '#{@variable['type']}'"
+                      @static_value = @variable['distribution']['static_value']
                   end
                   ag = JSON.parse(argument_template.result(get_binding))
                   fail "Argument '#{@variable['name']}' did not process.  Most likely it did not have all parameters defined." if ag.nil?
@@ -290,21 +305,10 @@ module OpenStudio
                   vr = nil
                   # add this as an argument
                   case @variable['type'].downcase
-                    when 'double'
-                      @static_value = @variable['distribution']['static_value'].to_f
-                    when 'integer'
-                      @static_value = @variable['distribution']['static_value'].to_i
-                    # TODO: update openstudio export to write only Strings
                     when 'string', 'choice'
                       @static_value = @variable['distribution']['static_value'].inspect
-                    when 'bool'
-                      if @variable['distribution']['static_value'].downcase == 'true'
-                        @static_value = true
-                      else
-                        @static_value = false
-                      end
                     else
-                      fail "Unknown variable type of '#{@variable['type']}'"
+                      @static_value = @variable['distribution']['static_value']
                   end
 
                   # TODO: remove enum and choice as this is not the variable type
@@ -313,24 +317,11 @@ module OpenStudio
                     vr = JSON.parse(discrete_uncertain_variable_template.result(get_binding))
                   elsif @variable['distribution']['type'] == 'discrete_uncertain'
                     # puts @variable.inspect
-                    weights = nil
-                    if @variable['distribution']['discrete_weights'] && @variable['distribution']['discrete_weights'] != ''
-                      weights = eval(@variable['distribution']['discrete_weights'])
-                    end
-
-                    values = nil
-                    if variable['type'].downcase == 'bool'
-                      values = eval(@variable['distribution']['discrete_values'])
-                      values.map! { |v| v.to_s == 'true' }
-                    else
-                      values = eval(@variable['distribution']['discrete_values'])
-                    end
-
-                    if weights
-                      fail "Discrete variable '#{@variable['name']}' does not have equal length of values and weights" if values.size != weights.size
-                      @values_and_weights = values.zip(weights).map { |v, w| { value: v, weight: w } }.to_json
+                    if @variable['distribution']['discrete_weights']
+                      fail "Discrete variable '#{@variable['name']}' does not have equal length of values and weights" if @variable['distribution']['discrete_values'].size != @variable['distribution']['discrete_weights'].size
+                      @values_and_weights = @variable['distribution']['discrete_values'].zip(@variable['distribution']['discrete_weights']).map { |v, w| { value: v, weight: w } }.to_json
                     else
-                      @values_and_weights = values.map { |v| { value: v } }.to_json
+                      @values_and_weights = @variable['distribution']['discrete_values'].map { |v| { value: v } }.to_json
                     end
 
                     if @variable['variable_type'] == 'pivot'
@@ -903,7 +894,7 @@ module OpenStudio
 
             # check if we are a measure - nil means that the cell was blank
             if row[:enabled].nil?
-              unless measure_name.nil?
+              if measure_name && data['data'][measure_index]['enabled']
                 variable_index += 1
 
                 var = {}
@@ -912,7 +903,7 @@ module OpenStudio
                 var['display_name_short'] = row[:display_name_short] ? row[:display_name_short] : var['display_name']
                 var['name'] = row[:measure_type_or_parameter_name_in_measure]
                 var['index'] = variable_index # order of the variable (not sure of its need)
-                var['type'] = row[:variable_type] ? row[:variable_type].downcase : row[:variable_type]
+                var['type'] = row[:variable_type].downcase
                 var['units'] = row[:units]
                 var['distribution'] = {}
 
@@ -933,6 +924,32 @@ module OpenStudio
                 var['distribution']['discrete_weights'] = row[:discrete_weights]
                 var['distribution']['type'] = row[:distribution]
                 var['distribution']['static_value'] = row[:default_value]
+                var['distribution']['delta_x'] = row[:delta_x]
+
+                # type various values correctly
+                var['distribution']['min'] = typecast_value(var['type'], var['distribution']['min'])
+                var['distribution']['max'] = typecast_value(var['type'], var['distribution']['max'])
+                var['distribution']['mean'] = typecast_value(var['type'], var['distribution']['mean'])
+                var['distribution']['stddev'] = typecast_value(var['type'], var['distribution']['stddev'])
+                var['distribution']['static_value'] = typecast_value(var['type'], var['distribution']['static_value'])
+
+                # eval the discrete value and weight arrays
+                case var['type']
+                  when 'bool', 'boolean'
+                    if var['distribution']['discrete_values']
+                      var['distribution']['discrete_values'] = eval(var['distribution']['discrete_values']).map { |v| v.to_s == 'true' }
+                    end
+                    if var['distribution']['discrete_weights'] && var['distribution']['discrete_weights'] != ''
+                      var['distribution']['discrete_weights'] = eval(var['distribution']['discrete_weights'])
+                    end
+                  else
+                    if var['distribution']['discrete_values']
+                      var['distribution']['discrete_values'] = eval(var['distribution']['discrete_values'])
+                    end
+                    if var['distribution']['discrete_weights'] && var['distribution']['discrete_weights'] != ''
+                      var['distribution']['discrete_weights'] = eval(var['distribution']['discrete_weights'])
+                    end
+                end
 
                 var['distribution']['source'] = row[:source]
                 var['notes'] = row[:notes]
@@ -1028,7 +1045,7 @@ module OpenStudio
             var['units'] = row[:units]
             var['visualize'] = row[:visualize].downcase == 'true' ? true : false if row[:visualize]
             var['export'] = row[:export].downcase == 'true' ? true : false if row[:export]
-            var['variable_type'] = row[:variable_type] if row[:variable_type]
+            var['variable_type'] = row[:variable_type].downcase if row[:variable_type]
             var['objective_function'] = row[:objective_function].downcase == 'true' ? true : false
             if var['objective_function']
               @algorithm['objective_functions'] << var['name']

data/lib/openstudio/analysis/version.rb

@@ -1,5 +1,5 @@
 module OpenStudio
   module Analysis
-    VERSION = '0.3.7'
+    VERSION = '0.4.0'
   end
 end