openstudio-analysis 0.4.4 → 0.4.5

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

@@ -235,7 +235,7 @@ module OpenStudio
           end
 
           @worker_inits.each do |w|
-            a.worker_inits.add(w[:path],  args: w[:args])
+            a.worker_inits.add(w[:path], args: w[:args])
           end
 
           @worker_finals.each do |w|
@@ -701,7 +701,7 @@ module OpenStudio
                 # parse the choices/enums
                 if var['type'] == 'enum' || var['type'] == 'choice' # this is now a choice
                   if row[:enums]
-                    var['distribution']['enumerations'] = row[:enums].gsub('|', '').split(',').map(&:strip)
+                    var['distribution']['enumerations'] = row[:enums].delete('|').split(',').map(&:strip)
                   end
                 elsif var['type'] == 'bool'
                   var['distribution']['enumerations'] = []
@@ -758,7 +758,7 @@ module OpenStudio
               # generate name id
               # TODO: put this into a logger. puts "Parsing measure #{row[1]}"
               display_name = row[:measure_name_or_var_type]
-              measure_name = display_name.downcase.strip.gsub('-', '_').gsub(' ', '_').gsub('__', '_')
+              measure_name = display_name.downcase.strip.tr('-', '_').tr(' ', '_').gsub('__', '_')
               data['data'][measure_index]['display_name'] = display_name
               data['data'][measure_index]['name'] = measure_name
               data['data'][measure_index]['enabled'] = row[:enabled] == 'TRUE' ? true : false

data/lib/openstudio/analysis/version.rb

@@ -1,5 +1,5 @@
 module OpenStudio
   module Analysis
-    VERSION = '0.4.4'
+    VERSION = '0.4.5'
   end
 end

data/lib/openstudio/analysis/workflow.rb

@@ -140,10 +140,45 @@ module OpenStudio
         end
       end
 
+      # Add a measure from the format that CSV parses into. This is a helper method to map the csv data to the new
+      # programmatic interface format
+      #
+      # @params measure [Hash] The measure in the format of the CSV translator
+      # @return [Object] Returns the measure that was added as an OpenStudio::AnalysisWorkflowStep object
+      def add_measure_from_csv(measure)
+        hash = {}
+        hash[:classname] = measure[:measure_data][:classname]
+        hash[:name] = measure[:measure_data][:name]
+        hash[:display_name] = measure[:measure_data][:display_name]
+        hash[:measure_type] = measure[:measure_data][:measure_type]
+        hash[:uid] = measure[:measure_data][:uid] ? measure[:measure_data][:uid] : SecureRandom.uuid
+        hash[:version_id] = measure[:measure_data][:version_id] ? measure[:measure_data][:version_id] : SecureRandom.uuid
+
+        # map the arguments - this can be a variable or argument, add them all as arguments first,
+        # the make_variable will remove from arg and place into variables
+        hash[:arguments] = measure[:args]
+
+        m = add_measure(measure[:measure_data][:name], measure[:measure_data][:display_name], measure[:measure_data][:local_path_to_measure], hash)
+
+        measure[:vars].each do |variable|
+          next unless %w(variable pivot).include? variable[:variable_type]
+
+          dist = variable[:distribution]
+          opt = {
+            variable_type: variable[:variable_type],
+            variable_display_name_short: variable[:display_name_short],
+            static_value: variable[:distribution][:mode]
+          }
+
+          m.make_variable(variable[:name], variable[:display_name], dist, opt)
+        end
+      end
+
       # Iterate over all the WorkflowItems
       def each
         @items.each { |i| yield i }
       end
+
       # Find the measure by its instance name
       #
       # @params instance_name [String] instance name of the measure

data/lib/openstudio/analysis/workflow_step.rb

@@ -132,7 +132,6 @@ module OpenStudio
           v[:values] = distribution[:values] if distribution[:values]
           v[:standard_deviation] = distribution[:standard_deviation] if distribution[:standard_deviation]
           v[:step_size] = distribution[:step_size] ? distribution[:step_size] : nil
-          v[:step_size] = distribution[:step_size] ? distribution[:step_size] : nil
 
           # assign uuid and version id to the variable
           v[:uuid] = SecureRandom.uuid
@@ -241,7 +240,7 @@ module OpenStudio
           fail "Could not find measure '#{instance_name}' in '#{path_to_measure}'" unless options[:ignore_not_found]
         end
 
-        # Extract the directo
+        # Extract the directory
         path_to_measure_local = path_to_measure
         path_to_measure = "./measures/#{File.basename(path_to_measure)}"
 
@@ -389,7 +388,7 @@ module OpenStudio
             var_options[:variable_type] = variable[:variable_type]
             var_options[:variable_display_name_short] = variable[:display_name_short]
             var_options[:static_value] = variable[:static_value]
-            distribution =  variable[:uncertainty_description]
+            distribution = variable[:uncertainty_description]
             distribution[:minimum] = variable[:minimum]
             distribution[:mean] = distribution[:attributes].find { |a| a[:name] == 'modes' }[:value]
             distribution[:maximum] = variable[:maximum]

data/lib/openstudio/weather/epw.rb

@@ -168,7 +168,7 @@ module OpenStudio
           if row_count == 1
             @valid = true
 
-            @city = row[1].gsub('/', '-')
+            @city = row[1].tr('/', '-')
             @state = row[2]
             @country = row[3]
             @data_type = row[4]

data/openstudio-analysis.gemspec

@@ -14,7 +14,7 @@ Gem::Specification.new do |s|
   s.description = 'Basic classes for generating the files needed for OpenStudio-Server'
   s.license = 'LGPL'
 
-  s.required_ruby_version = '>= 1.9.3'
+  s.required_ruby_version = '>= 2.0'
   s.required_rubygems_version = '>= 1.3.6'
 
   s.files         = `git ls-files -z`.split("\x0")
@@ -23,6 +23,7 @@ Gem::Specification.new do |s|
   s.require_paths = ['lib']
 
   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 'semantic', '~> 1.4'

data/spec/schema/osa.json

@@ -0,0 +1,550 @@
+{
+	"$schema": "http://json-schema.org/draft-04/schema#",
+	"description": "JSON Schema for the OpenStudioAnalysis File Type",
+	"type": "object",
+	"properties": {
+		"analysis": {
+			"$ref": "#/definitions/Analysis"
+		}
+	},
+	"required": [
+		"analysis"
+	],
+	"additionalProperties": false,
+	"definitions": {
+		"Output": {
+			"description": "Hash",
+			"type": "object",
+			"properties": {
+				"units": {
+					"description": "Haystack complient unit string, or empty string if not applicable",
+					"type": "string"
+				},
+				"objective_function": {
+					"description": "Determines if output is part of an objective function",
+					"type": "boolean"
+				},
+				"objective_function_index": {
+					"description": "Key used to define multi-objective functions, null if not applicale",
+					"type": "number"
+				},
+				"objective_function_target": {
+					"description": "Key used to define target of the objective function, null if not applicable",
+					"type": [
+						"number",
+						"null"
+					]
+				},
+				"objective_function_group": {
+					"description": "Optional key used to define multi-objective functions",
+					"type": "number"
+				},
+				"scaling_factor": {
+					"description": "????",
+					"type": "null"
+				},
+				"display_name": {
+					"description": "User facing name of objective which must be unique",
+					"type": "string"
+				},
+				"display_name_short": {
+					"description": "User facing name less that 20 chareters",
+					"type": "string"
+				},
+				"metadata_id": {
+					"description": "??????",
+					"type": [
+						"string",
+						"null"
+					]
+				},
+				"name": {
+					"description": "Snake cased output machine name",
+					"type": "string"
+				},
+				"visualize": {
+					"description": "Determines if variable will be include in plots on the server",
+					"type": "boolean"
+				},
+				"export": {
+					"description": "?????",
+					"type": "boolean"
+				},
+				"variable_type": {
+					"description": "Allowed values of 'string', 'bool', or 'number'",
+					"type": "string"
+				}
+			},
+			"required": [
+				"units",
+				"objective_function",
+				"objective_function_index",
+				"objective_function_target",
+				"scaling_factor",
+				"display_name",
+				"metadata_id",
+				"name"
+			],
+			"additionalProperties": false
+		},
+		"Algorithm Attributes": {
+			"title": "algorithm",
+			"description": "Hash of ttributes associated with the analysis_type",
+			"type": "object",
+			"additionalProperties": {
+				"description": "Attibutes defined by analysis type"
+			}
+		},
+		"Argument": {
+			"title": "argument",
+			"description": "Indivigual argument instance",
+			"type": "object",
+			"properties": {
+				"display_name": {
+					"description": "User-facing display name which must be unique",
+					"type": "string"
+				},
+				"display_name_short": {
+					"description": "Optional user-facing display name under 20 charecters",
+					"type": "string"
+				},
+				"name": {
+					"description": "Machine readable snake-cased name of agrument as defined in the measure.xml",
+					"type": "string"
+				},
+				"value_type": {
+					"description": "Accepts inputs of 'string', 'bool', and 'number'",
+					"type": "string"
+				},
+				"default_value": {
+					"description": "Default value for argument, if defined in the measure.xml file",
+					"type": [
+						"string",
+						"number",
+						"boolean"
+					]
+				},
+				"value": {
+					"description": "Value to set argument to in analysis",
+					"type": [
+						"string",
+						"number",
+						"boolean"
+					]
+				},
+				"machine_name": {
+					"description": "????",
+					"type": "string"
+				},
+				"uuid": {
+					"description": "UUID for the measure from the measure.xml",
+					"type": "string"
+				},
+				"version_uuid": {
+					"description": "UUID for the measure version form the measure.xml",
+					"type": "string"
+				}
+			},
+			"required": [
+				"display_name",
+				"name",
+				"value",
+				"machine_name",
+				"uuid",
+				"version_uuid"
+			],
+			"additionalProperties": false
+		},
+		"Workflow Step": {
+			"description": "Indivigual measure definition",
+			"type": "object",
+			"properties": {
+				"name": {
+					"description": "Snake-cased machine readable measure name which must be unique",
+					"type": "string"
+				},
+				"display_name": {
+					"description": "User facing measure name whcih must also be unique",
+					"type": "string"
+				},
+				"measure_type": {
+					"description": "Accepts values of 'Ruby' 'EnergyPlus' and 'Reporting'",
+					"type": "string"
+				},
+				"measure_definition_class_name": {
+					"description": "Class name of measure.rb file",
+					"type": "string"
+				},
+				"measure_definition_directory": {
+					"description": "??",
+					"type": "string"
+				},
+				"measure_definition_directory_local": {
+					"description": "Local path to the measure directory",
+					"type": "string"
+				},
+				"measure_definition_display_name": {
+					"description": "?????",
+					"type": "string"
+				},
+				"measure_definition_name": {
+					"description": "?????",
+					"type": "string"
+				},
+				"measure_definition_name_xml": {
+					"description": "?????",
+					"type": "null"
+				},
+				"measure_definition_uuid": {
+					"description": "UUID of measure in measure.xml",
+					"type": "string"
+				},
+				"measure_definition_version_uuid": {
+					"description": "UUID of measure version in measure.xml",
+					"type": "string"
+				},
+				"arguments": {
+					"$ref": "#/definitions/Argument Array"
+				},
+				"variables": {
+					"$ref": "#/definitions/Variable Array"
+				},
+				"workflow_index": {
+					"description": "Index in workflow array, indexing from 0",
+					"type": "number"
+				},
+				"workflow_step_type": {
+					"description": "???????",
+					"type": "string"
+				},
+				"version_uuid": {
+					"description": "UUID of measure version from the measure.xml",
+					"type": "string"
+				},
+				"uuid": {
+					"description": "UUID of measure from the measure.xml",
+					"type": "string"
+				}
+			},
+			"required": [
+				"name",
+				"display_name",
+				"measure_type",
+				"measure_definition_class_name",
+				"measure_definition_directory",
+				"measure_definition_uuid",
+				"measure_definition_version_uuid",
+				"arguments",
+				"variables",
+				"workflow_index",
+				"workflow_step_type",
+				"version_uuid",
+				"uuid"
+			],
+			"additionalProperties": false
+		},
+		"Uncertainty Definition": {
+			"title": "uncertainty_description",
+			"description": "Set of attributes defining the variablity of the input",
+			"type": "object",
+			"properties": {
+				"type": {
+					"description": "Uncertainty type, accepting values of 'triangle', 'uniform', 'discrete', and 'normal'",
+					"type": "string",
+					"oneof": [
+						"triangle",
+						"uniform",
+						"normal",
+						"discrete"
+					]
+				},
+				"attributes": {
+					"$ref": "#/definitions/Distribution Definition"
+				}
+			},
+			"required": [
+				"type",
+				"attributes"
+			],
+			"additionalProperties": false
+		},
+		"Variable": {
+			"description": "Inidivigual variable instance",
+			"type": "object",
+			"properties": {
+				"argument": {
+					"$ref": "#/definitions/Argument"
+				},
+				"display_name": {
+					"description": "User-facing display name which must be unique",
+					"type": "string"
+				},
+				"display_name_short": {
+					"description": "Optional user-facing name under 20 charecters",
+					"type": "string"
+				},
+				"variable_type": {
+					"description": "Definition of variable type",
+					"type": "string",
+					"oneof": [
+						"variable",
+						"pivot"
+					]
+				},
+				"units": {
+					"description": "Haystack complient units with an empty string if not defined.",
+					"type": "null"
+				},
+				"minimum": {
+					"description": "????",
+					"type": "number"
+				},
+				"maximum": {
+					"description": "????",
+					"type": "number"
+				},
+				"relation_to_output": {
+					"description": "????",
+					"type": "null"
+				},
+				"static_value": {
+					"description": "Value to defalut to in the case of this variable not being perturbed in a datapoint",
+					"type": "number"
+				},
+				"uuid": {
+					"description": "Variable UUID to link against in the .osd file",
+					"type": "string"
+				},
+				"version_uuid": {
+					"description": "???",
+					"type": "string"
+				},
+				"variable": {
+					"description": "????",
+					"type": "boolean"
+				},
+				"uncertainty_description": {
+					"$ref": "#/definitions/Uncertainty Definition"
+				},
+				"workflow_index": {
+					"description": "???????",
+					"type": "number"
+				},
+				"machine_name": {
+					"description": "???????",
+					"type": "string"
+				}
+			},
+			"required": [
+				"argument",
+				"display_name",
+				"variable_type",
+				"units",
+				"static_value",
+				"uuid",
+				"version_uuid",
+				"uncertainty_description",
+				"machine_name"
+			],
+			"additionalProperties": false
+		},
+		"Problem": {
+			"title": "problem",
+			"description": "Defines procedure for running the analysis",
+			"type": "object",
+			"properties": {
+				"analysis_type": {
+					"description": "Type of analysis to be run, e.g. LHS or nsga2",
+					"type": "string",
+					"oneof": [
+						"morris",
+						"lhs",
+						"rgenound",
+						"nsga_nrel",
+						"spea",
+						"sequential_search",
+						"single_run",
+						"batch_run",
+						"doe",
+						"repeat_run",
+						"optim",
+						"baseline_purturbation",
+						"preflight"
+					]
+				},
+				"algorithm": {
+					"$ref": "#/definitions/Algorithm Attributes"
+				},
+				"workflow": {
+					"$ref": "#/definitions/Workflow"
+				},
+				"random_seed": {
+					"description": "Random seed to set server to for the execution of the OSA file",
+					"type": "number"
+				},
+				"name": {
+					"description": "??????",
+					"type": "string"
+				}
+			},
+			"required": [
+				"analysis_type",
+				"algorithm",
+				"workflow",
+				"random_seed"
+			],
+			"additionalProperties": false
+		},
+		"Output Array": {
+			"description": "Array of objects which define user-desired outputs from the analysis ",
+			"type": "array",
+			"items": {
+				"$ref": "#/definitions/Output"
+			}
+		},
+		"Workflow": {
+			"description": "Definintion of measures to be applied in the analysis",
+			"type": "array",
+			"items": {
+				"$ref": "#/definitions/Workflow Step"
+			}
+		},
+		"Seed Object": {
+			"title": "seed",
+			"description": "Seed osm or idf file for default use",
+			"type": "object",
+			"properties": {
+				"file_type": {
+					"description": "Accepted values of 'osm' and 'idf'",
+					"type": "string",
+					"oneonf": [
+						"osm",
+						"idf"
+					]
+				},
+				"path": {
+					"description": "Path to the seed file from the project directory",
+					"type": "string"
+				}
+			},
+			"required": [
+				"file_type"
+			],
+			"additionalProperties": false
+		},
+		"Weather File": {
+			"title": "weather_file",
+			"description": "Weather file for default use in the simulation",
+			"type": "object",
+			"properties": {
+				"file_type": {
+					"description": "Weather file type, e.g. TMY3",
+					"type": "string"
+				},
+				"path": {
+					"description": "Path to weather file from the project directory",
+					"type": "string"
+				}
+			},
+			"required": [
+				"file_type",
+				"path"
+			],
+			"additionalProperties": false
+		},
+		"Analysis": {
+			"title": "analysis",
+			"description": "Analysis object",
+			"type": "object",
+			"properties": {
+				"display_name": {
+					"description": "User facing string, spaces & capitals allowed",
+					"type": "string"
+				},
+				"name": {
+					"description": "snake_cassed machine name",
+					"type": "string"
+				},
+				"output_variables": {
+					"$ref": "#/definitions/Output Array"
+				},
+				"problem": {
+					"$ref": "#/definitions/Problem"
+				},
+				"seed": {
+					"$ref": "#/definitions/Seed Object"
+				},
+				"weather_file": {
+					"$ref": "#/definitions/Weather File"
+				},
+				"file_format_version": {
+					"description": "1.0",
+					"type": "number"
+				},
+				"_id": {
+					"description": "UUID of the OSA file",
+					"type": "string"
+				},
+				"uuid": {
+					"description": "UUID of the OSA file",
+					"type": "string"
+				},
+				"project_id": {
+					"description": "?????",
+					"type": "string"
+				}
+			},
+			"required": [
+				"output_variables",
+				"problem",
+				"seed",
+				"weather_file",
+				"_id",
+				"uuid",
+				"project_id"
+			],
+			"additionalProperties": false
+		},
+		"Argument Array": {
+			"description": "Array of fixed inputs for the masure",
+			"type": "array",
+			"items": {
+				"$ref": "#/definitions/Argument"
+			}
+		},
+		"Variable Array": {
+			"description": "Array of variable inputs for the measure",
+			"type": "array",
+			"items": {
+				"$ref": "#/definitions/Variable"
+			}
+		},
+		"Distribution Definition": {
+			"title": "attributes",
+			"description": "Array of attributes defining the distribution type properties",
+			"type": "array",
+			"items": {
+				"title": "Distribution Attributes",
+				"type": "object",
+				"properties": {
+					"name": {
+						"type": "string"
+					},
+					"value": {
+						"type": [
+							"array",
+							"string",
+							"number",
+							"boolean"
+						]
+					}
+				},
+				"required": [
+					"name",
+					"value"
+				],
+				"additionalProperties": false
+			}
+		}
+	}
+}