energyplus 0.1

data/lib/energyplus/EsoFile.rb

@@ -0,0 +1,129 @@
+######################################################################
+#  Copyright (c) 2008-2013, Alliance for Sustainable Energy.
+#  All rights reserved.
+#
+#  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.
+#
+#  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
+######################################################################
+
+module EnergyPlus
+
+  class DictionaryEntry
+    attr_reader :id, :key, :var_name, :units, :interval
+    def initialize(id,key,var_name,units,interval)
+      @id,@key,@var_name,@units,@interval = id,key,var_name,units,interval
+    end
+  end
+
+  class Variable
+  #	attr_reader :data
+    def initialize(dictionary_entry,data,timestamps)
+      @dictionary_entry = dictionary_entry
+      @data = data
+      @timestamps = timestamps
+    end
+
+    def name
+      return @dictionary_entry.var_name
+    end
+
+    def key
+      return @dictionary_entry.key
+    end
+
+    def id
+      return @dictionary_entry.id
+    end
+
+    def units
+      return @dictionary_entry.units
+    end
+
+    def interval
+      return @dictionary_entry.interval
+    end
+
+    def values
+      @data.map { |entry| entry[1] }
+    end
+
+    def hours
+      @timestamps.map { |entry| entry[5] }
+    end
+
+    def days
+      @timestamps.map { |entry| entry[1] }
+    end
+
+    def months
+      @timestamps.map { |entry| entry[2] }
+    end
+  end
+
+  class EpEsoFile
+    def initialize(path)
+      File.open(path) do |f|
+        @variables = nil
+        # first six lines are discarded
+        6.times {f.gets}
+        @text = f.read
+      end
+    end
+
+    def dictionary
+      return @text.match(/(.*?)(End\sof\sData\sDictionary)/m)[1]
+    end
+
+    def data
+      return @text.match(/(End\sof\sData\sDictionary)(.*?)(End\sof\sData)/m)[2]
+    end
+
+    def dictionary_entries
+      dictionary_entries = []
+      dictionary.split("\n").each do |entry|
+        interval = entry.match(/(!)(\w+)(\s*)/)[2].strip
+        fields = entry.match(/(.*?)(!)/)[1].split(',')
+        id = fields[0]
+        key,var_name = fields[2,3] if fields[1] =~ /2/
+        key,var_name = nil, fields[2] if fields[1] =~ /1/
+        units = var_name.match(/(.*?)(\[)(.*?)(\])/)[3]
+        var_name = $1.strip
+        dictionary_entries << DictionaryEntry.new(id,key,var_name,units,interval)
+      end
+      return dictionary_entries
+    end
+
+    def variables
+      unless @variables
+        @variables = []
+        text = data
+        dictionary_entries.each do |dictionary_entry|
+          if dictionary_entry.interval =~ /Hourly/
+            timestamps = text.scan(/^2,.*?,\s0\.00,60\.00,.*/).map { |entry| entry.split(',') }
+          elsif dictionary_entry.interval =~ /TimeStep/
+            timestamps = text.scan(/^2,.*/).reject { |entry| entry =~ /^2,.*?,\s0\.00,60\.00,.*/}.map { |entry| entry.split(',') }
+          elsif dictionary_entry.interval =~ /Daily/
+            timestamps = text.scan(/^3,/).map { |entry| entry.split(',') }
+          elsif dictionary_entry.interval =~ /Monthly/
+            timestamps = text.scan(/^4,/).map { |entry| entry.split(',') }
+          end
+          var_data = text.scan(Regexp.new("^#{dictionary_entry.id},.*")).map { |entry| entry.split(',') }
+          @variables << Variable.new(dictionary_entry,var_data,timestamps)
+        end
+      end
+      return @variables
+    end
+  end
+
+end #module

data/lib/energyplus/IdfObject.rb

@@ -0,0 +1,55 @@
+######################################################################
+#  Copyright (c) 2008-2013, Alliance for Sustainable Energy.
+#  All rights reserved.
+#
+#  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.
+#
+#  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
+######################################################################
+
+module EnergyPlus
+
+  class IdfObject
+    attr_accessor :type, :fields, :comment
+
+    def initialize(object_type, object_fields, object_comment)
+      @type = object_type
+      @fields = object_fields
+      @comment = object_comment
+    end
+
+    def fieldValue(fieldIdx)
+      fieldValue = @fields[fieldIdx].split(',')
+      fieldValue = fieldValue[0].split(';')[0].gsub(" ", "")
+
+      return fieldValue.to_f
+
+    end
+
+    def fieldString(fieldIdx)
+      fieldString = @fields[fieldIdx].split(',')
+      fieldString = fieldString[0].split(';')[0].gsub(" ", "")
+
+      return fieldString
+    end
+
+
+    def to_s
+      string = ''
+      string << @comment + "\n" if @comment
+      string << @type + "\n"
+      @fields.each { |field| string << field + "\n" }
+      string << "\n"
+    end
+  end
+end #module

data/lib/energyplus/KmlFile.rb

@@ -0,0 +1,168 @@
+######################################################################
+#  Copyright (c) 2008-2013, Alliance for Sustainable Energy.
+#  All rights reserved.
+#
+#  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.
+#
+#  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
+######################################################################
+
+
+module EnergyPlus
+
+  require 'pathname'
+  require 'csv'
+  require 'builder'
+
+  class KmlFile
+    attr_accessor :data
+
+    def initialize(path)
+      @path = path
+      @data = []
+
+      @region_lu = Hash.new("regions")
+      @region_lu["1_africa_wmo_region_1"] = "Africa, WMO Region 1"
+      @region_lu["2_asia_wmo_region_2"] = "Asia, WMO Region 2"
+      @region_lu["3_south_america_wmo_region_3"] = "South America, WMO Region 3"
+      @region_lu["4_north_and_central_america_wmo_region_4"] = "North and Central America, WMO Region 4"
+      @region_lu["5_southwest_pacific_wmo_region_5"] = "Southwest Pacific Ocean, WMO Region 5"
+      @region_lu["6_europe_wmo_region_6"] = "Europe, WMO Region 6"
+
+    end
+
+    def savefile
+      kmlfile = File.new(@path, 'w')
+      kmlxml = Builder::XmlMarkup.new(:target => kmlfile, :indent=>2)
+
+      #setup the xml/kml file
+      kmlxml.instruct! :xml, :version=>"1.0", :encoding=>"UTF-8"
+      kmlxml.kml("xmlns" => "http://www.opengis.net/kml/2.2") {
+        kmlxml.Document {
+          kmlxml.name "EnergyPlus Weather Data"
+          kmlxml.visibility "0"
+          kmlxml.description {
+            kmlxml.cdata!("<img src=\"kml/ep_header6.png\" width=280><p>Weather data for use with EnergyPlus building energy simulation software (http://www.energyplus.gov).<p>Locations are organized by World Meteorological Organization (WMO) region, country, and state/province. Download individual weather data files through links in each location description.")
+          }
+          kmlxml.LookAt {
+            kmlxml.longitude "-105"
+            kmlxml.latitude "15"
+            kmlxml.altitude "0"
+            kmlxml.range "15000000"
+            kmlxml.tilt "6.880472140100155e-015"
+            kmlxml.heading "4.971764876159099e-015"
+            kmlxml.altitudeMode "relativeToGround"
+          }
+          kmlxml.Style("id" => "weatherlocation_normal") {
+            kmlxml.IconStyle {
+              kmlxml.scale "0.6"
+              kmlxml.Icon {
+                kmlxml.href "kml/E+_logo.png"
+              }
+            }
+            kmlxml.BalloonStyle {
+              kmlxml.text {
+                kmlxml.cdata!("<b><font color=\"#CC0000\" size=\"+3\">$[name]</font></b><br/><font>$[description]</font>")
+              }
+              kmlxml.bgColor "ffffffbb"
+            }
+          }
+          kmlxml.StyleMap("id" => "weatherlocation") {
+            kmlxml.Pair {
+              kmlxml.key "normal"
+              kmlxml.styleUrl "#weatherlocation_normal"
+            }
+            kmlxml.Pair {
+              kmlxml.key "highlight"
+              kmlxml.styleUrl "#weatherlocation_hiliteicon"
+            }
+          }
+          kmlxml.Style("id" => "weatherlocation_hiliteicon") {
+            kmlxml.IconStyle {
+              kmlxml.scale "0.9"
+              kmlxml.Icon {
+                kmlxml.href "kml/E+_logo.png"
+              }
+              kmlxml.hotSpot {
+                kmlxml.x "0.5"
+                kmlxml.y "0.5"
+                kmlxml.xunits "fraction"
+                kmlxml.yunits "fraction"
+              }
+              kmlxml.BalloonStyle {
+                kmlxml.text {
+                  kmlxml.cdata!("<b><font color=\"#CC0000\" size=\"+3\">$[name]</font></b> <br/><font>$[description]</font>")
+                }
+                kmlxml.bgColor "ffffffbb"
+              }
+            }
+          }
+
+          #write out each location
+          #the data is stored in a custom format that is two layers dep using the DataHash.rb
+          #file that Nicholas Long wrote
+
+          @data.each do |region|
+            kmlxml.Folder {
+              kmlxml.name @region_lu[region.name]
+              kmlxml.visibility "0"
+              kmlxml.description {
+            kmlxml.cdata!("<img src=\"kml/ep_header7.png\" align=right>")
+        }
+
+        region.data.each do |country|
+          kmlxml.Folder {
+            kmlxml.name country.name
+            kmlxml.visibility "0"
+            country.data.each do |state|
+              if state != "" && state != "-" then
+                kmlxml.Folder {
+                  kmlxml.name state.name
+                  kmlxml.visibility "0"
+                  state.data.each do |weather|
+                    weather.toKml(kmlxml)
+                  end
+                }
+              else
+                state.data.each do |weather|
+            weather.toKml(kmlxml)
+                end
+              end
+            end
+          }
+        end
+      }
+    end
+
+
+    @data.each do |reg|
+      puts reg.name
+      reg.data.each do |reg_data|
+        puts "   #{reg_data.name}"
+        reg_data.data.each do |reg_data_2|
+          puts "      #{reg_data_2.name}"
+          reg_data_2.data.each do |reg_data_3|
+            puts "         #{reg_data_3.path}"
+          end
+        end
+      end
+
+    end
+        }
+      }
+
+    end
+
+
+  end
+end #module

data/lib/energyplus/ResultsLog.rb

@@ -0,0 +1,99 @@
+######################################################################
+#  Copyright (c) 2008-2013, Alliance for Sustainable Energy.
+#  All rights reserved.
+#
+#  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.
+#
+#  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
+######################################################################
+
+module EnergyPlus
+
+  require 'pathname'
+
+  class ResultsLog
+    def initialize(path)
+      @path = Pathname.new(path)
+      @entries = []
+      @initialized = false
+      @valid = false
+    end
+
+    def find_entries(*search_terms)
+      init if not @initialized
+      entries = @entries.select do |entry|
+        found = true
+        search_terms.each do |search_term|
+          if not entry[:description] =~ Regexp.new(search_term)
+            found = false
+          end
+        end
+        found
+      end
+      return entries
+    end
+
+    def find_entry(*search_terms)
+      return find_entries(*search_terms).first
+    end
+
+    def entries
+      init if not @initialized
+      return @entries
+    end
+
+    def valid?
+      init if not @initialized
+      return @valid
+    end
+
+    private
+
+    def init
+      @initialized = true
+
+      if @path.exist?
+        File.open(@path) do |f|
+          text = f.read
+          @entries = parse_entries(text)
+        end
+      end
+
+      total_site_energy = find_entry('Total Energy','Total Site Energy')
+      if not total_site_energy.nil?
+        if total_site_energy[:value].to_f > 0
+          @valid = true
+        end
+      end
+    end
+
+    def parse_entries(text)
+      entries = []
+      lines = text.split("\n")
+      lines.each do |line|
+        entry = Hash.new
+        begin
+          entry[:units] = line.match(/\[(.*?)\]/)[1]
+        rescue
+          entry[:units] = ''
+        end
+        entry[:description] = line.match(/(.*?),/)[1].sub(/\[.*?\]/,'').strip
+        entry[:value] = line.match(/,(.*)/)[1]
+        entries << entry
+      end
+      return entries
+    end
+
+  end
+
+end #module