openstudio-analysis 1.3.4 → 1.3.6

data/lib/openstudio/weather/epw.rb

@@ -1,178 +1,178 @@
-# *******************************************************************************
-# OpenStudio(R), Copyright (c) Alliance for Sustainable Energy, LLC.
-# See also https://openstudio.net/license
-# *******************************************************************************
-
-module OpenStudio
-  module Weather
-    class Epw
-      attr_accessor :filename
-      attr_reader :city
-      attr_reader :state
-      attr_reader :country
-      attr_accessor :data_type
-      attr_reader :wmo
-      attr_reader :lat
-      attr_reader :lon
-      attr_reader :gmt
-      attr_reader :elevation
-      attr_accessor :data_period
-
-      # access to all the weather data in array of arrays
-      attr_reader :header_data
-      attr_accessor :weather_data
-
-      def initialize(filename)
-        @filename = filename
-        @city = ''
-        @state = ''
-        @country = ''
-        @data_type = ''
-        @wmo = ''
-        @lat = ''
-        @lon = ''
-        @gmt = ''
-        @elevation = ''
-        @valid = false
-
-        @header_data = []
-        @weather_data = []
-        process_header
-      end
-
-      def self.load(filename)
-        raise "EPW file does not exist: #{filename}" unless File.exist?(filename)
-        f = OpenStudio::Weather::Epw.new(filename)
-      end
-
-      def to_kml(xml_builder_obj, url)
-        xml_builder_obj.Placemark do
-          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">'\
-                           "<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" +
-                                       # "<tr><td></td><td>E   3� 15'   N 36� 43'</td></tr>\n"+
-                                       # "<tr><td></td><td><b>25</b> m</td></tr>\n"+
-                                       "<tr><td></td><td>Time Zone GMT <b>#{@gmt}</b> hours</td></tr>\n" +
-                                       # "<tr><td></td><td>ASHRAE Std 169 Climate Zone <b>4A - Mixed - Humid</b></td></tr>\n"+
-                                       # "<tr><td></td><td>99% Heating DB=<b>3.1</b>, 1% Cooling DB=<b>33.2</b></td></tr>\n"+
-                                       # "<tr><td></td><td>HDD18 <b>1019</b>, CDD10 <b>2849</b></td></tr>\n"+
-                                       "<tr><td></td><td>URL #{url}</td></tr></table>")
-          end
-          xml_builder_obj.styleUrl '#weatherlocation'
-          xml_builder_obj.Point do
-            xml_builder_obj.altitudeMode 'absolute'
-            xml_builder_obj.coordinates "#{@lon},#{@lat},#{elevation}"
-          end
-        end
-      end
-
-      def valid?
-        return @valid
-      end
-
-      def save_as(filename)
-        File.delete filename if File.exist? filename
-        FileUtils.mkdir_p(File.dirname(filename)) unless Dir.exist?(File.dirname(filename))
-
-        CSV.open(filename, 'wb') do |csv|
-          @header_data.each { |r| csv << r }
-          csv << [
-            'DATA PERIODS', @data_period[:count], @data_period[:records_per_hour], @data_period[:name],
-            @data_period[:start_day_of_week], @data_period[:start_date], @data_period[:end_date]
-          ]
-          @weather_data.each { |r| csv << r }
-        end
-
-        true
-      end
-
-      # Append the weather data (after data periods) to the end of the weather file. This allows
-      # for the creation of multiyear weather files. Note that the date/order is not checked. It assumes
-      # that the data are being added at the end is the more recent data
-      #
-      # @param filename [String] Path to the file that will be appended
-      def append_weather_data(filename)
-        to_append = OpenStudio::Weather::Epw.load(filename)
-
-        prev_length = @weather_data.size
-        @weather_data += to_append.weather_data
-
-        prev_length + to_append.weather_data.size == @weather_data.size
-      end
-
-      def metadata_to_hash
-        {
-          city: @city,
-          state: @state,
-          country: @country,
-          data_type: @data_type,
-          wmo: @wmo,
-          latitude: @lat,
-          longitude: @lon,
-          elevation: @elevation
-        }
-      end
-
-      private
-
-      # initialize
-      def process_header
-        header_section = true
-        row_count = 0
-
-        CSV.foreach(@filename) do |row|
-          row_count += 1
-
-          if header_section
-            if row[0] =~ /data.periods/i
-              @data_period = {
-                count: row[1].to_i,
-                records_per_hour: row[2].to_i,
-                name: row[3],
-                start_day_of_week: row[4],
-                start_date: row[5],
-                end_date: row[6]
-              }
-
-              header_section = false
-
-              next
-            else
-              @header_data << row
-            end
-          else
-            @weather_data << row
-          end
-
-          # process only header row
-          # LOCATION,Adak Nas,AK,USA,TMY3,704540,51.88,-176.65,-10.0,5.0
-          if row_count == 1
-            @valid = true
-
-            @city = row[1].tr('/', '-')
-            @state = row[2]
-            @country = row[3]
-            @data_type = row[4]
-            if @data_type =~ /TMY3/i
-              @data_type = 'TMY3'
-            elsif @data_type =~ /TMY2/i
-              @data_type = 'TMY2'
-            elsif @data_type =~ /TMY/i
-              @data_type = 'TMY'
-            end
-            @wmo = row[5]
-            @wmo.nil? ? @wmo = 'wmoundefined' : @wmo = @wmo.to_i
-            @lat = row[6].to_f
-            @lon = row[7].to_f
-            @gmt = row[8].to_f
-            @elevation = row[9].to_f
-          end
-        end
-      end
-    end
-  end
-end
+# *******************************************************************************
+# OpenStudio(R), Copyright (c) Alliance for Sustainable Energy, LLC.
+# See also https://openstudio.net/license
+# *******************************************************************************
+
+module OpenStudio
+  module Weather
+    class Epw
+      attr_accessor :filename
+      attr_reader :city
+      attr_reader :state
+      attr_reader :country
+      attr_accessor :data_type
+      attr_reader :wmo
+      attr_reader :lat
+      attr_reader :lon
+      attr_reader :gmt
+      attr_reader :elevation
+      attr_accessor :data_period
+
+      # access to all the weather data in array of arrays
+      attr_reader :header_data
+      attr_accessor :weather_data
+
+      def initialize(filename)
+        @filename = filename
+        @city = ''
+        @state = ''
+        @country = ''
+        @data_type = ''
+        @wmo = ''
+        @lat = ''
+        @lon = ''
+        @gmt = ''
+        @elevation = ''
+        @valid = false
+
+        @header_data = []
+        @weather_data = []
+        process_header
+      end
+
+      def self.load(filename)
+        raise "EPW file does not exist: #{filename}" unless File.exist?(filename)
+        f = OpenStudio::Weather::Epw.new(filename)
+      end
+
+      def to_kml(xml_builder_obj, url)
+        xml_builder_obj.Placemark do
+          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">'\
+                           "<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" +
+                                       # "<tr><td></td><td>E   3� 15'   N 36� 43'</td></tr>\n"+
+                                       # "<tr><td></td><td><b>25</b> m</td></tr>\n"+
+                                       "<tr><td></td><td>Time Zone GMT <b>#{@gmt}</b> hours</td></tr>\n" +
+                                       # "<tr><td></td><td>ASHRAE Std 169 Climate Zone <b>4A - Mixed - Humid</b></td></tr>\n"+
+                                       # "<tr><td></td><td>99% Heating DB=<b>3.1</b>, 1% Cooling DB=<b>33.2</b></td></tr>\n"+
+                                       # "<tr><td></td><td>HDD18 <b>1019</b>, CDD10 <b>2849</b></td></tr>\n"+
+                                       "<tr><td></td><td>URL #{url}</td></tr></table>")
+          end
+          xml_builder_obj.styleUrl '#weatherlocation'
+          xml_builder_obj.Point do
+            xml_builder_obj.altitudeMode 'absolute'
+            xml_builder_obj.coordinates "#{@lon},#{@lat},#{elevation}"
+          end
+        end
+      end
+
+      def valid?
+        return @valid
+      end
+
+      def save_as(filename)
+        File.delete filename if File.exist? filename
+        FileUtils.mkdir_p(File.dirname(filename)) unless Dir.exist?(File.dirname(filename))
+
+        CSV.open(filename, 'wb') do |csv|
+          @header_data.each { |r| csv << r }
+          csv << [
+            'DATA PERIODS', @data_period[:count], @data_period[:records_per_hour], @data_period[:name],
+            @data_period[:start_day_of_week], @data_period[:start_date], @data_period[:end_date]
+          ]
+          @weather_data.each { |r| csv << r }
+        end
+
+        true
+      end
+
+      # Append the weather data (after data periods) to the end of the weather file. This allows
+      # for the creation of multiyear weather files. Note that the date/order is not checked. It assumes
+      # that the data are being added at the end is the more recent data
+      #
+      # @param filename [String] Path to the file that will be appended
+      def append_weather_data(filename)
+        to_append = OpenStudio::Weather::Epw.load(filename)
+
+        prev_length = @weather_data.size
+        @weather_data += to_append.weather_data
+
+        prev_length + to_append.weather_data.size == @weather_data.size
+      end
+
+      def metadata_to_hash
+        {
+          city: @city,
+          state: @state,
+          country: @country,
+          data_type: @data_type,
+          wmo: @wmo,
+          latitude: @lat,
+          longitude: @lon,
+          elevation: @elevation
+        }
+      end
+
+      private
+
+      # initialize
+      def process_header
+        header_section = true
+        row_count = 0
+
+        CSV.foreach(@filename) do |row|
+          row_count += 1
+
+          if header_section
+            if row[0] =~ /data.periods/i
+              @data_period = {
+                count: row[1].to_i,
+                records_per_hour: row[2].to_i,
+                name: row[3],
+                start_day_of_week: row[4],
+                start_date: row[5],
+                end_date: row[6]
+              }
+
+              header_section = false
+
+              next
+            else
+              @header_data << row
+            end
+          else
+            @weather_data << row
+          end
+
+          # process only header row
+          # LOCATION,Adak Nas,AK,USA,TMY3,704540,51.88,-176.65,-10.0,5.0
+          if row_count == 1
+            @valid = true
+
+            @city = row[1].tr('/', '-')
+            @state = row[2]
+            @country = row[3]
+            @data_type = row[4]
+            if @data_type =~ /TMY3/i
+              @data_type = 'TMY3'
+            elsif @data_type =~ /TMY2/i
+              @data_type = 'TMY2'
+            elsif @data_type =~ /TMY/i
+              @data_type = 'TMY'
+            end
+            @wmo = row[5]
+            @wmo.nil? ? @wmo = 'wmoundefined' : @wmo = @wmo.to_i
+            @lat = row[6].to_f
+            @lon = row[7].to_f
+            @gmt = row[8].to_f
+            @elevation = row[9].to_f
+          end
+        end
+      end
+    end
+  end
+end

data/lib/openstudio-analysis.rb

@@ -1,47 +1,47 @@
-# *******************************************************************************
-# OpenStudio(R), Copyright (c) Alliance for Sustainable Energy, LLC.
-# See also https://openstudio.net/license
-# *******************************************************************************
-
-# Ruby libraries to include
-require 'json'
-require 'securerandom'
-require 'logger'
-require 'pathname'
-require 'csv'
-
-# gems to always include
-require 'faraday'
-require 'roo'
-require 'erb'
-require 'zip'
-require 'semantic'
-require 'semantic/core_ext'
-
-require 'bcl'
-
-# core
-require 'openstudio/analysis/server_api'
-require 'openstudio/analysis/version'
-
-# analysis classes
-require 'openstudio/analysis'
-require 'openstudio/analysis/support_files'
-require 'openstudio/analysis/formulation'
-require 'openstudio/analysis/workflow'
-require 'openstudio/analysis/workflow_step'
-require 'openstudio/analysis/algorithm_attributes'
-require 'openstudio/analysis/server_scripts'
-
-# translators
-require 'openstudio/analysis/translator/excel'
-require 'openstudio/analysis/translator/datapoints'
-require 'openstudio/analysis/translator/workflow'
-
-# helpers / core_ext
-require 'openstudio/helpers/string'
-require 'openstudio/helpers/hash'
-require 'openstudio/helpers/utils'
-
-# weather file parsing
-require 'openstudio/weather/epw'
+# *******************************************************************************
+# OpenStudio(R), Copyright (c) Alliance for Sustainable Energy, LLC.
+# See also https://openstudio.net/license
+# *******************************************************************************
+
+# Ruby libraries to include
+require 'json'
+require 'securerandom'
+require 'logger'
+require 'pathname'
+require 'csv'
+
+# gems to always include
+require 'faraday'
+require 'roo'
+require 'erb'
+require 'zip'
+require 'semantic'
+require 'semantic/core_ext'
+
+require 'bcl'
+
+# core
+require 'openstudio/analysis/server_api'
+require 'openstudio/analysis/version'
+
+# analysis classes
+require 'openstudio/analysis'
+require 'openstudio/analysis/support_files'
+require 'openstudio/analysis/formulation'
+require 'openstudio/analysis/workflow'
+require 'openstudio/analysis/workflow_step'
+require 'openstudio/analysis/algorithm_attributes'
+require 'openstudio/analysis/server_scripts'
+
+# translators
+require 'openstudio/analysis/translator/excel'
+require 'openstudio/analysis/translator/datapoints'
+require 'openstudio/analysis/translator/workflow'
+
+# helpers / core_ext
+require 'openstudio/helpers/string'
+require 'openstudio/helpers/hash'
+require 'openstudio/helpers/utils'
+
+# weather file parsing
+require 'openstudio/weather/epw'

data/openstudio-analysis.gemspec

@@ -1,38 +1,38 @@
-lib = File.expand_path('lib', __dir__)
-$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 = 'BSD'
-
-  s.files = `git ls-files -z`.split("\x0").reject do |f|
-    f.match(%r{^(test|spec|features)/})
-  end
-  s.bindir = 'exe'
-  s.executables = s.files.grep(%r{^exe/}) { |f| File.basename(f) }
-  s.require_paths = ['lib']
-
-  s.required_ruby_version = '~> 2.7.0'
-
-  s.add_dependency 'bcl', '~> 0.7.0'
-  s.add_dependency 'dencity', '~> 0.1.0'
-  s.add_dependency 'faraday', '~> 1.0.1'
-  s.add_dependency 'roo', '~> 2.8.3'
-  s.add_dependency 'rubyzip', '~> 2.3.0'
-  s.add_dependency 'semantic', '~> 1.4'
-
-  s.add_development_dependency 'json-schema', '~> 2.8.0'
-  s.add_development_dependency 'rake', '~> 13.0'
-  s.add_development_dependency 'rspec', '~> 3.9'
-  s.add_development_dependency 'rubocop', '~> 0.54.0'
-  s.add_development_dependency 'rubocop-checkstyle_formatter', '~> 0.4.0'
-end
+lib = File.expand_path('lib', __dir__)
+$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 = 'BSD'
+
+  s.files = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  s.bindir = 'exe'
+  s.executables = s.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  s.require_paths = ['lib']
+
+  s.required_ruby_version = '~> 2.7.0'
+
+  s.add_dependency 'bcl', '~> 0.7.1'
+  s.add_dependency 'dencity', '~> 0.1.0'
+  s.add_dependency 'faraday', '~> 1.0.1'
+  s.add_dependency 'roo', '~> 2.8.3'
+  s.add_dependency 'rubyzip', '~> 2.3.0'
+  s.add_dependency 'semantic', '~> 1.4'
+
+  s.add_development_dependency 'json-schema', '~> 2.8.0'
+  s.add_development_dependency 'rake', '~> 13.0'
+  s.add_development_dependency 'rspec', '~> 3.9'
+  s.add_development_dependency 'rubocop', '~> 1.15.0'
+  s.add_development_dependency 'rubocop-checkstyle_formatter', '~> 0.4.0'
+end

data/update_license.rb

@@ -1,60 +1,60 @@
-#!/usr/bin/env ruby
-
-ruby_regex = /^#.\*{79}.*#.\*{79}$/m
-erb_regex = /^<%.*#.\*{79}.*#.\*{79}.%>$/m
-js_regex = /^\/\* @preserve.*Copyright.*#.\*\//m
-
-ruby_header_text = <<EOT
-# *******************************************************************************
-# OpenStudio(R), Copyright (c) Alliance for Sustainable Energy, LLC.
-# See also https://openstudio.net/license
-# *******************************************************************************
-EOT
-ruby_header_text.strip!
-
-erb_header_text = <<EOT
-<%
-  # *******************************************************************************
-  # OpenStudio(R), Copyright (c) Alliance for Sustainable Energy, LLC.
-  # See also https://openstudio.net/license
-  # *******************************************************************************
-%>
-EOT
-erb_header_text.strip!
-
-js_header_text = <<EOT
-/* @preserve
- * OpenStudio(R), Copyright (c) Alliance for Sustainable Energy, LLC. reserved.
- * See also https://openstudio.net/license
-*/
-EOT
-js_header_text.strip!
-
-paths = [
-  { glob: 'lib/**/*.rb', license: ruby_header_text, regex: ruby_regex },
-  { glob: 'spec/openstudio/**/*.rb', license: ruby_header_text, regex: ruby_regex },
-  { glob: 'spec/integration/**/*.rb', license: ruby_header_text, regex: ruby_regex },
-
-  # single files
-  { glob: 'Rakefile', license: ruby_header_text, regex: ruby_regex },
-  { glob: 'spec/spec_helper.rb', license: ruby_header_text, regex: ruby_regex }
-]
-
-paths.each do |path|
-  Dir[path[:glob]].each do |file|
-    puts "Updating license in file #{file}"
-
-    f = File.read(file)
-    if f =~ path[:regex]
-      puts '  License found -- updating'
-      File.open(file, 'w') { |write| write << f.gsub(path[:regex], path[:license]) }
-    else
-      puts '  No license found -- adding'
-      if f =~ /#!/
-        puts '  CANNOT add license to file automatically, add it manually and it will update automatically in the future'
-        next
-      end
-      File.open(file, 'w') { |write| write << f.insert(0, path[:license] + "\n\n") }
-    end
-  end
-end
+#!/usr/bin/env ruby
+
+ruby_regex = /^#.\*{79}.*#.\*{79}$/m
+erb_regex = /^<%.*#.\*{79}.*#.\*{79}.%>$/m
+js_regex = /^\/\* @preserve.*Copyright.*#.\*\//m
+
+ruby_header_text = <<EOT
+# *******************************************************************************
+# OpenStudio(R), Copyright (c) Alliance for Sustainable Energy, LLC.
+# See also https://openstudio.net/license
+# *******************************************************************************
+EOT
+ruby_header_text.strip!
+
+erb_header_text = <<EOT
+<%
+  # *******************************************************************************
+  # OpenStudio(R), Copyright (c) Alliance for Sustainable Energy, LLC.
+  # See also https://openstudio.net/license
+  # *******************************************************************************
+%>
+EOT
+erb_header_text.strip!
+
+js_header_text = <<EOT
+/* @preserve
+ * OpenStudio(R), Copyright (c) Alliance for Sustainable Energy, LLC. reserved.
+ * See also https://openstudio.net/license
+*/
+EOT
+js_header_text.strip!
+
+paths = [
+  { glob: 'lib/**/*.rb', license: ruby_header_text, regex: ruby_regex },
+  { glob: 'spec/openstudio/**/*.rb', license: ruby_header_text, regex: ruby_regex },
+  { glob: 'spec/integration/**/*.rb', license: ruby_header_text, regex: ruby_regex },
+
+  # single files
+  { glob: 'Rakefile', license: ruby_header_text, regex: ruby_regex },
+  { glob: 'spec/spec_helper.rb', license: ruby_header_text, regex: ruby_regex }
+]
+
+paths.each do |path|
+  Dir[path[:glob]].each do |file|
+    puts "Updating license in file #{file}"
+
+    f = File.read(file)
+    if f =~ path[:regex]
+      puts '  License found -- updating'
+      File.open(file, 'w') { |write| write << f.gsub(path[:regex], path[:license]) }
+    else
+      puts '  No license found -- adding'
+      if f =~ /#!/
+        puts '  CANNOT add license to file automatically, add it manually and it will update automatically in the future'
+        next
+      end
+      File.open(file, 'w') { |write| write << f.insert(0, path[:license] + "\n\n") }
+    end
+  end
+end