openstudio-analysis 0.4.3 → 0.4.4

data/LICENSE.txt

@@ -0,0 +1,65 @@
+Copyright (c) 2008-2013, Alliance for Sustainable Energy.
+All rights reserved.
+
+                                   NOTICE
+
+This computer software (Software) is code in development prepared by the 
+Alliance for Sustainable Energy, (hereinafter the "Contractor"), under 
+Contract DE-AC36-08GO28308 (Contract) with the Department of Energy (DOE).  
+The United States Government has been granted for itself and others acting 
+on its behalf a paid-up, non-exclusive, irrevocable, worldwide license in 
+the Software to reproduce, prepare derivative works, and perform publicly 
+and display publicly.  Beginning five (5) years after the date permission 
+to assert copyright is obtained from the DOE, and subject to any 
+subsequent five (5) year renewals, the United States Government is granted 
+for itself and others acting on its behalf a paid-up, non-exclusive, 
+irrevocable, worldwide license in the Software to reproduce, prepare 
+derivative works, distribute copies to the public, perform publicly and 
+display publicly, and to permit others to do so.  If the Contractor ceases 
+to make this computer software available, it may be obtained from DOE's 
+Office of Scientific and Technical Information's Energy Science and 
+Technology Software Center (ESTSC) at P.O. Box 1020, Oak Ridge, TN 37831-
+1020.
+
+                                 DISCLAIMER
+
+THIS SOFTWARE IS PROVIDED BY THE CONTRACTOR "AS IS" AND ANY EXPRESS OR 
+IMPLIED WARRANTIES, INCLUDING BUT NOT LIMITED TO, THE IMPLIED WARRANTIES 
+OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN 
+NO EVENT SHALL THE CONTRACTOR OR THE U.S. GOVERNMENT BE LIABLE FOR ANY 
+SPECIAL, INDIRECT OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER, 
+INCLUDING BUT NOT LIMITED TO CLAIMS ASSOCIATED WITH THE LOSS OF DATA OR 
+PROFITS, WHICH MAY RESULT FROM AN ACTION IN CONTRACT, NEGLIGENCE OR OTHER 
+TORTIOUS CLAIM THAT ARISES OUT OF OR IN CONNECTION WITH THE ACCESS, USE OR 
+PERFORMANCE OF THIS SOFTWARE.
+
+YOU AGREE TO INDEMNIFY DOE/NREL/ALLIANCE, AND ITS SUBSIDIARIES, 
+AFFILIATES, OFFICERS, AGENTS, AND EMPLOYEES AGAINST ANY CLAIM OR DEMAND, 
+INCLUDING REASONABLE ATTORNEYS' FEES, RELATED TO YOUR USE OF THESE DATA.
+
+DOE/NREL/Alliance is not obligated to provide the user with any support, 
+consulting, training or assistance of any kind with regard to the use of 
+these Data or to provide the user with any updates, revisions or new 
+versions of these Data.
+
+The names DOE/NREL/Alliance may not be used in any advertising or 
+publicity to endorse or promote any products or commercial entities unless 
+specific written permission is obtained from DOE/NREL/Alliance.
+
+
+                            OPEN SOURCE LICENSE
+
+This library is free software; you can redistribute it and/or
+modify it under the terms of the GNU Lesser General Public
+License as published by the Free Software Foundation; either
+version 2.1 of the License, or (at your option) any later version.
+
+This library is distributed in the hope that it will be useful,
+but WITHOUT ANY WARRANTY; without even the implied warranty of
+MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+Lesser General Public License for more details here.
+
+You should have received a copy of the GNU Lesser General Public
+License along with this library; if not, write to the Free Software
+Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
+

data/README.md

@@ -1,6 +1,6 @@
 # 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)
+[![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) [![Coverage Status](https://coveralls.io/repos/NREL/OpenStudio-analysis-gem/badge.svg?branch=develop)](https://coveralls.io/r/NREL/OpenStudio-analysis-gem?branch=develop)
 
 The OpenStudio Analysis Gem is used to communicate files to the OpenStudio Distributed Analysis.
 

data/lib/openstudio/analysis/formulation.rb

@@ -107,14 +107,23 @@ module OpenStudio
           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
+        # Check if the name is already been added. Note that if the name is added again, it will not update any of
+        # the fields
+        exist = @outputs.select { |o| o[:name] == output_hash[:name] }
+        if exist.empty?
+          # if the variable is an objective_function, then increment and
+          # assign and objective function index
+          if output_hash[:objective_function]
+            values = @outputs.select { |o| o[:objective_function] }
+            output_hash[:objective_function_index] = values.size # size is already +1
+          else
+            output_hash[:objective_function] = false
+          end
+
+          @outputs << output_hash
         end
 
-        @outputs << output_hash
+        @outputs
       end
 
       # return the machine name of the analysis
@@ -372,8 +381,6 @@ module OpenStudio
               if File.directory?(file)
                 if File.basename(file) == 'resources' || File.basename(file) == 'lib'
                   add_directory_to_zip(zf, file, "#{measure.measure_definition_directory}/#{File.basename(file)}")
-                else
-                  # puts "Skipping Directory #{File.basename(file)}"
                 end
               else
                 # puts "Adding File #{file}"

data/lib/openstudio/analysis/server_api.rb

@@ -14,7 +14,7 @@ module OpenStudio
 
         fail 'no host defined for server api class' if @hostname.nil?
 
-        # todo: add support for the proxy
+        # TODO: add support for the proxy
 
         # create connection with basic capabilities
         @conn = Faraday.new(url: @hostname) do |faraday|
@@ -575,8 +575,6 @@ module OpenStudio
 
         if response.status == 200
           puts "Killed analysis #{analysis_id}"
-        else
-          # raise "Could not kill the analysis with response of #{response.inspect}"
         end
       end
 
@@ -703,7 +701,7 @@ module OpenStudio
       end
 
       # creates a new analysis and runs rgenoud optimization - number of generations isn't used right now
-      def run_rgenoud(formulation_filename, analysis_zip_filename, _number_of_generations)
+      def run_rgenoud(formulation_filename, analysis_zip_filename)
         project_options = {}
         project_id = new_project(project_options)
 
@@ -790,9 +788,9 @@ module OpenStudio
         }
         start_analysis(analysis_id, run_options)
 
-        # If the analysis is LHS, then go ahead and run batch run because there is
+        # If the analysis is a staged analysis, then go ahead and run batch run because there is
         # no explicit way to tell the system to do it
-        if analysis_type == 'lhs' || analysis_type == 'preflight' || analysis_type == 'single_run' || analysis_type == 'doe'
+        if %w(lhs preflight single_run repeat_run doe).include? analysis_type
           run_options = {
             analysis_action: 'start',
             without_delay: false,

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

@@ -54,7 +54,7 @@ module OpenStudio
           @worker_finals = []
           @export_path = './export'
           @measure_paths = []
-          @number_of_samples = 0 # todo: remove this
+          @number_of_samples = 0 # TODO: remove this
           @problem = {}
           @algorithm = {}
           @outputs = {}

data/lib/openstudio/analysis/version.rb

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

data/openstudio-analysis.gemspec

@@ -0,0 +1,33 @@
+lib = File.expand_path('../lib/', __FILE__)
+$LOAD_PATH.unshift lib unless $LOAD_PATH.include?(lib)
+
+require 'openstudio/analysis/version'
+
+Gem::Specification.new do |s|
+  s.name = 'openstudio-analysis'
+  s.version = OpenStudio::Analysis::VERSION
+  s.platform = Gem::Platform::RUBY
+  s.authors = ['Nicholas Long']
+  s.email = ['Nicholas.Long@nrel.gov']
+  s.homepage = 'http://openstudio.nrel.gov'
+  s.summary = 'Create JSON, ZIP to communicate with OpenStudio Distributed Analysis in the Cloud'
+  s.description = 'Basic classes for generating the files needed for OpenStudio-Server'
+  s.license = 'LGPL'
+
+  s.required_ruby_version = '>= 1.9.3'
+  s.required_rubygems_version = '>= 1.3.6'
+
+  s.files         = `git ls-files -z`.split("\x0")
+  s.executables   = s.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  s.test_files    = s.files.grep(%r{^(test|spec|features)/})
+  s.require_paths = ['lib']
+
+  s.add_dependency 'faraday', '~> 0.8'
+  s.add_dependency 'roo', '~> 1.12'
+  s.add_dependency 'rubyzip', '~> 1.0' # don't update because of jruby
+  s.add_dependency 'semantic', '~> 1.4'
+  s.add_dependency 'bcl', '~> 0.5.5'
+
+  s.add_development_dependency 'bundler', '~> 1.7'
+  s.add_development_dependency 'rake', '~> 10.0'
+end

data/rubocop-todo.yml

@@ -0,0 +1,246 @@
+# This configuration was generated by `rubocop --auto-gen-config`
+# on 2014-04-29 00:01:18 -0600 using RuboCop version 0.20.1.
+# The point is for the user to remove these configuration records
+# one by one as the offenses are removed from the code base.
+# Note that changes in the inspected code, or installation of new
+# versions of RuboCop, may require this file to be generated again.
+
+# Offense count: 3
+AccessorMethodName:
+  Enabled: false
+
+# Offense count: 7
+# Cop supports --auto-correct.
+AndOr:
+  Enabled: false
+
+# Offense count: 6
+BlockNesting:
+  Max: 6
+
+# Offense count: 1
+# Cop supports --auto-correct.
+# Configuration parameters: EnforcedStyle, SupportedStyles.
+BracesAroundHashParameters:
+  Enabled: false
+
+# Offense count: 4
+# Configuration parameters: IndentWhenRelativeTo, SupportedStyles, IndentOneStep.
+CaseIndentation:
+  Enabled: false
+
+# Offense count: 3
+# Configuration parameters: CountComments.
+ClassLength:
+  Max: 569
+
+# Offense count: 1
+# Cop supports --auto-correct.
+# Configuration parameters: PreferredMethods.
+CollectionMethods:
+  Enabled: false
+
+# Offense count: 7
+# Cop supports --auto-correct.
+ColonMethodCall:
+  Enabled: false
+
+# Offense count: 4
+# Configuration parameters: Keywords.
+CommentAnnotation:
+  Enabled: false
+
+# Offense count: 6
+CyclomaticComplexity:
+  Max: 46
+
+# Offense count: 6
+# Cop supports --auto-correct.
+DefWithParentheses:
+  Enabled: false
+
+# Offense count: 12
+# Cop supports --auto-correct.
+DeprecatedClassMethods:
+  Enabled: false
+
+# Offense count: 4
+Documentation:
+  Enabled: false
+
+# Offense count: 4
+# Configuration parameters: EnforcedStyle, SupportedStyles.
+DotPosition:
+  Enabled: false
+
+# Offense count: 4
+# Cop supports --auto-correct.
+EmptyLines:
+  Enabled: false
+
+# Offense count: 7
+# Cop supports --auto-correct.
+EmptyLinesAroundBody:
+  Enabled: false
+
+# Offense count: 1
+EndOfLine:
+  Enabled: false
+
+# Offense count: 3
+Eval:
+  Enabled: false
+
+# Offense count: 1
+# Configuration parameters: Exclude.
+FileName:
+  Enabled: false
+
+# Offense count: 3
+# Configuration parameters: EnforcedStyle, SupportedStyles.
+FormatString:
+  Enabled: false
+
+# Offense count: 92
+# Cop supports --auto-correct.
+# Configuration parameters: EnforcedStyle, SupportedStyles.
+HashSyntax:
+  Enabled: false
+
+# Offense count: 1
+# Configuration parameters: MaxLineLength.
+IfUnlessModifier:
+  Enabled: false
+
+# Offense count: 1
+# Cop supports --auto-correct.
+IndentationConsistency:
+  Enabled: false
+
+# Offense count: 1
+# Cop supports --auto-correct.
+IndentationWidth:
+  Enabled: false
+
+# Offense count: 95
+# Cop supports --auto-correct.
+LeadingCommentSpace:
+  Enabled: false
+
+# Offense count: 283
+LineLength:
+  Max: 399
+
+# Offense count: 9
+# Cop supports --auto-correct.
+MethodCallParentheses:
+  Enabled: false
+
+# Offense count: 17
+# Configuration parameters: CountComments.
+MethodLength:
+  Max: 246
+
+# Offense count: 1
+MultilineTernaryOperator:
+  Enabled: false
+
+# Offense count: 24
+# Cop supports --auto-correct.
+NegatedIf:
+  Enabled: false
+
+# Offense count: 1
+# Cop supports --auto-correct.
+NonNilCheck:
+  Enabled: false
+
+# Offense count: 20
+# Cop supports --auto-correct.
+Not:
+  Enabled: false
+
+# Offense count: 1
+# Configuration parameters: SupportedStyles.
+RaiseArgs:
+  EnforcedStyle: compact
+
+# Offense count: 3
+# Cop supports --auto-correct.
+# Configuration parameters: AllowMultipleReturnValues.
+RedundantReturn:
+  Enabled: false
+
+# Offense count: 2
+# Cop supports --auto-correct.
+RedundantSelf:
+  Enabled: false
+
+# Offense count: 1
+# Configuration parameters: MaxSlashes.
+RegexpLiteral:
+  Enabled: false
+
+# Offense count: 1
+RescueException:
+  Enabled: false
+
+# Offense count: 2
+SelfAssignment:
+  Enabled: false
+
+# Offense count: 40
+# Cop supports --auto-correct.
+# Configuration parameters: EnforcedStyle, SupportedStyles.
+SignalException:
+  Enabled: false
+
+# Offense count: 34
+# Cop supports --auto-correct.
+SpaceAfterComma:
+  Enabled: false
+
+# Offense count: 3
+# Cop supports --auto-correct.
+SpaceAroundOperators:
+  Enabled: false
+
+# Offense count: 32
+# Cop supports --auto-correct.
+# Configuration parameters: EnforcedStyle, EnforcedStyleForEmptyBraces, SupportedStyles.
+SpaceInsideHashLiteralBraces:
+  Enabled: false
+
+# Offense count: 10
+# Cop supports --auto-correct.
+StringConversionInInterpolation:
+  Enabled: false
+
+# Offense count: 264
+# Cop supports --auto-correct.
+# Configuration parameters: EnforcedStyle, SupportedStyles.
+StringLiterals:
+  Enabled: false
+
+# Offense count: 1
+Tab:
+  Enabled: false
+
+# Offense count: 3
+# Cop supports --auto-correct.
+TrailingBlankLines:
+  Enabled: false
+
+# Offense count: 69
+# Cop supports --auto-correct.
+TrailingWhitespace:
+  Enabled: false
+
+# Offense count: 7
+UselessAssignment:
+  Enabled: false
+
+# Offense count: 7
+# Configuration parameters: EnforcedStyle, SupportedStyles.
+VariableName:
+  Enabled: false