bcl 0.1.4

data/lib/bcl.rb

@@ -0,0 +1,6 @@
+require 'bcl/ComponentSpreadsheet'
+require 'bcl/ComponentXml'
+require 'bcl/GatherComponents'
+require 'bcl/TarBall'
+require 'bcl/MasterTaxonomy'
+require 'bcl/MongoToComponent'

data/lib/bcl/ComponentSpreadsheet.rb

@@ -0,0 +1,292 @@
+######################################################################
+#  Copyright (c) 2008-2010, 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
+######################################################################
+
+# Converts a custom Excel spreadsheet format to BCL components for upload
+# Format of the Excel spreadsheet is documented in /doc/ComponentSpreadsheet.docx
+
+require 'rubygems'
+
+require 'pathname'
+require 'fileutils'
+require 'uuid' # gem install uuid
+
+require 'bcl/ComponentXml'
+require 'bcl/GatherComponents'
+require 'bcl/MasterTaxonomy'
+
+$have_win32ole = false
+begin
+  # apparently this is not a gem
+  require 'win32ole'
+  mod = WIN32OLE
+  $have_win32ole = true
+rescue NameError
+  # do not have win32ole
+end
+
+module BCL
+
+WorksheetStruct = Struct.new(:name, :components)
+HeaderStruct = Struct.new(:name, :children)
+ComponentStruct = Struct.new(:row, :name, :uid, :version_id, :headers, :values)
+
+class ComponentSpreadsheet
+
+  public 
+  
+# WINDOWS ONLY SECTION BECAUSE THIS USES WIN32OLE
+if $have_win32ole
+
+  #initialize with Excel spreadsheet to read
+  def initialize(xlsx_path,worksheet_names = "all")
+    
+    @xlsx_path = Pathname.new(xlsx_path).realpath.to_s
+    @worksheets = []
+    
+    begin
+    
+      excel = WIN32OLE::new('Excel.Application')
+  
+      xlsx = excel.Workbooks.Open(@xlsx_path)
+      
+      #by default, operate on all worksheets
+      if worksheet_names == "all"
+        xlsx.Worksheets.each do |xlsx_worksheet|
+          parse_xlsx_worksheet(xlsx_worksheet)
+        end
+      else #if specific worksheets are specified, operate on them
+        worksheet_names.each do |worksheet_name|         
+          parse_xlsx_worksheet(xlsx.Worksheets(worksheet_name))
+        end   
+      end
+
+      xlsx.saved = true
+      xlsx.Save
+    
+    ensure
+    
+      excel.Quit
+      WIN32OLE.ole_free(excel)
+      excel.ole_free
+      xlsx=nil
+      excel=nil
+      GC.start
+      
+    end
+    
+  end
+  
+else # if $have_win32ole
+
+  # parse the master taxonomy document
+  def initialize(xlsx_path)
+    puts "ComponentSpreadsheet class requires 'win32ole' to parse the component spreadsheet."
+    puts "ComponentSpreadsheet may also be stored and loaded from JSON if your platform does not support win32ole."
+  end
+  
+end # if $have_win32ole
+
+  def save(save_path)
+  
+    # load master taxonomy to validate components
+    taxonomy = BCL::MasterTaxonomy.new
+    
+    FileUtils.rm_rf(save_path) if File.exists?(save_path) and File.directory?(save_path)
+  
+    @worksheets.each do |worksheet|
+      worksheet.components.each do |component|
+        
+        component_xml = Component.new(save_path)
+        component_xml.name = component.name
+        component_xml.uid = component.uid
+        component_xml.comp_version_id = component.version_id
+        
+        # this tag is how we know where this goes in the taxonomy
+        component_xml.add_tag(worksheet.name)
+        
+        values = component.values[0]
+        component.headers.each do |header|
+        
+          if /description/i.match(header.name)
+          
+            name = values.delete_at(0)
+            uid = values.delete_at(0)
+            version_id = values.delete_at(0)
+            description = values.delete_at(0)
+            fidelity_level = values.delete_at(0).to_int
+            # name, uid, and version_id already processed
+            component_xml.description = description
+            component_xml.fidelity_level = fidelity_level
+          
+          elsif /provenance/i.match(header.name)
+          
+            author = values.delete_at(0)
+            datetime = values.delete_at(0)
+            comment = values.delete_at(0)
+            component_xml.add_provenance(author.to_s, datetime.to_s, comment.to_s)
+            
+          elsif /tag/i.match(header.name)
+          
+            value = values.delete_at(0)
+            component_xml.add_tag(value)
+          
+          elsif /attribute/i.match(header.name)
+            
+            value = values.delete_at(0)
+            name = header.children[0]
+            units = ""
+            if match_data = /(.*)\((.*)\)/.match(name)
+              name = match_data[1].strip
+              units = match_data[2].strip
+            end
+            component_xml.add_attribute(name, value, units)
+
+          elsif /source/i.match(header.name)
+          
+            manufacturer = values.delete_at(0)
+            model = values.delete_at(0)
+            serial_no = values.delete_at(0)
+            year = values.delete_at(0)
+            url = values.delete_at(0)
+            component_xml.source_manufacturer = manufacturer
+            component_xml.source_model = model
+            component_xml.source_serial_no = serial_no
+            component_xml.source_year = year
+            component_xml.source_url = url
+            
+          elsif /file/i.match(header.name)
+          
+            software_program = values.delete_at(0)
+            version = values.delete_at(0)
+            filename = values.delete_at(0)
+            filetype = values.delete_at(0)
+            filepath = values.delete_at(0)
+            component_xml.add_file(software_program, version, filepath, filename, filetype)
+            
+          else
+            raise "Unknown section #{header.name}"
+           
+          end
+
+        end
+        
+        taxonomy.check_component(component_xml)
+        
+        component_xml.save_tar_gz(false)
+        
+      end
+      
+    end
+    
+    BCL.gather_components(save_path)
+    
+  end
+  
+  private
+  
+  def parse_xlsx_worksheet(xlsx_worksheet)
+    
+    worksheet = WorksheetStruct.new
+    worksheet.name = xlsx_worksheet.Range("A1").Value
+    worksheet.components = []
+    puts "[ComponentSpreadsheet] Starting parsing components of type #{worksheet.name}"
+    
+    # find number of rows, first column should be name, should not be empty
+    num_rows = 1
+    while true do 
+      test = xlsx_worksheet.Range("A#{num_rows}").Value
+      if test.nil? or test.empty?
+        num_rows -= 1
+        break
+      end
+      num_rows += 1
+    end
+    
+    # scan number of columns
+    headers = []
+    header = nil
+    max_col = nil
+    xlsx_worksheet.Columns.each do |col| 
+      value1 = col.Rows("1").Value
+      value2 = col.Rows("2").Value
+      
+      if not value1.nil? and not value1.empty?
+        if not header.nil?
+          headers << header
+        end
+        header = HeaderStruct.new
+        header.name = value1
+        header.children = []
+      end
+      
+      if not value2.nil? and not value2.empty?
+        if not header.nil?
+          header.children << value2
+        end
+      end
+      
+      if (value1.nil? or value1.empty?) and (value2.nil? or value2.empty?)
+        break
+      end
+      
+      matchdata = /^\$(.+):/.match(col.Address)
+      max_col = matchdata[1]
+    end
+    
+    if not header.nil?
+      headers << header
+    end
+    
+    if not headers.empty?
+      headers[0].name = "description"
+    end
+    
+    components = []
+    for i in 3..num_rows do
+      component = ComponentStruct.new
+      component.row = i
+      
+      # get name
+      component.name = xlsx_worksheet.Range("A#{i}").value
+      
+      # get uid, if empty set it
+      component.uid = xlsx_worksheet.Range("B#{i}").value
+      if component.uid.nil? or component.uid.empty?
+        component.uid = UUID.new.generate
+        xlsx_worksheet.Range("B#{i}").value = component.uid      
+      end
+      
+      # always write new version id
+      component.version_id = UUID.new.generate
+      xlsx_worksheet.Range("C#{i}").value = component.version_id
+      
+      component.headers = headers
+      component.values = xlsx_worksheet.Range("A#{i}:#{max_col}#{i}").value
+      worksheet.components << component
+    end
+    
+    @worksheets << worksheet
+    
+    puts "[ComponentSpreadsheet] Finished parsing components of type #{worksheet.name}"
+    
+  end
+  
+end
+
+end # module BCL

data/lib/bcl/ComponentXml.rb

@@ -0,0 +1,451 @@
+######################################################################
+#  Copyright (c) 2008-2010, 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
+######################################################################
+
+# Provides programmatic access to the component.xsd schema needed for
+# generating the component information that will be uploaded to 
+# the Building Component Library.
+
+require 'rubygems'
+
+require 'pathname'
+require 'csv'
+require 'builder'  #gem install builder (creates xml files)
+require 'uuid' # gem install uuid
+require 'fileutils'
+
+require 'bcl/TarBall'
+
+module BCL
+
+SCHEMA_LOCATION = "component.xsd"
+
+ProvStruct = Struct.new(:author, :datetime, :comment)
+TagsStruct = Struct.new(:descriptor)
+AttrStruct = Struct.new(:name, :value, :datatype, :units)
+FileStruct = Struct.new(:version_software_program, :version_id, :fqp_file, :filename, :filetype)
+#cost_type is an enumeration (not enforced) of installation, material, operations and maintenance,
+#variable operations and maintenance, salvage
+CostStruct = Struct.new(:cost_name, :cost_type, :category, :value, :interval, 
+			 :interval_units, :year, :location, :units, :currency, :source,
+			 :reference_component_name, :reference_component_id)
+ObjectStruct = Struct.new(:obj_type, :obj_instance)
+			 
+class Component
+  attr_accessor :name  
+  attr_accessor :uid
+  attr_accessor :comp_version_id
+  attr_accessor :description
+  attr_accessor :comment
+  attr_accessor :fidelity_level
+  attr_accessor :source_manufacturer
+  attr_accessor :source_model
+  attr_accessor :source_serial_no
+  attr_accessor :source_year
+  attr_accessor :source_url
+  attr_accessor :tags
+  attr_accessor :provenance
+  attr_accessor :attributes
+  attr_accessor :files
+  attr_accessor :costs
+  attr_accessor :objects
+  
+  public 
+  
+  #the save path is where the component will be saved
+  def initialize(save_path)
+    @name = ""  #this is also a unique identifier to the component... 
+    @uid = UUID.new.generate
+    @comp_version_id = UUID.new.generate
+    @description = ""
+    @comment = ""
+    @fidelity_level = 0 #restricted to level_1 to level_5 
+    @source_manufacturer = ""
+    @source_model = ""
+    @source_serial_no = ""
+    @source_year = ""
+    @source_url = ""
+    
+    #these items have multiple instances
+    @provenance = []
+    @tags = []
+    @attributes = []
+    @files = []
+    @costs = []
+    @objects = [] #container for saving the idf/osm snippets
+    
+    @path = save_path
+    
+    #puts "[ComponentXml] " + @path
+    #need to hit a webservice to validate which tags and attributes are 
+    #available (including units?)
+    
+    #todo: validate against master taxonomy
+  end
+  
+  def open_component(filename)
+    read_component_xml(filename)
+  end
+  
+  # savefile, save the component xml along with
+  # the files that have been added to the object
+  def save_tar_gz(delete_files = true)
+    current_d = Dir.pwd
+    paths = []
+    
+    save_component_xml
+   
+    paths << "./component.xml"
+    
+    #copy over the files to the directory
+    @files.each do |file|  
+      src_path = Pathname.new(file.fqp_file)
+      dest_path = Pathname.new("#{resolve_path}/#{file.filename}")
+      if File.exists?(src_path)
+        if src_path == dest_path
+          #do nothing, file is already where it needs to be
+        else
+          #move the file where it needs to go
+          FileUtils.cp(src_path, dest_path)      
+        end
+      else
+        puts "#{src_path} -> File does not exist"
+      end
+      paths << "./#{file.filename}"
+    end
+    
+    #take all the files and tar.gz them -- name the file the same as
+    #the directory
+    
+    Dir.chdir("#{resolve_path}")
+    destination = "#{@name.gsub(" ","_").gsub("/","_").gsub("-","_").gsub("___","_").gsub("__","_").gsub("in.","in").gsub(",","").strip}.tar.gz"
+    
+    File.delete(destination) if File.exists?(destination)
+    
+    BCL.tarball(destination, paths)
+      
+    Dir.chdir(current_d)
+
+    if (delete_files)
+      @files.each do |file|
+        if File.exists?(File.dirname(file.fqp_file))
+          puts "[ComponentXml] Deleting: #{File.dirname(file.fqp_file)}"
+          FileUtils.rm_rf(File.dirname(file.fqp_file)) 
+        end
+      end
+    end
+    
+    #puts "[ComponentXml] " + Dir.pwd
+  end
+  
+  def add_provenance(author, datetime, comment)
+    prov = ProvStruct.new
+    prov.author = author
+    prov.datetime = datetime
+    prov.comment = comment
+    
+    @provenance << prov
+  end
+  
+  def add_tag(tag_name)
+    tag = TagsStruct.new
+    tag.descriptor = tag_name
+    
+    @tags << tag
+  end
+  
+  def add_attribute(name, value, units)
+    attr = AttrStruct.new
+    attr.name = name
+    attr.value = value
+    
+    if value.is_a? Fixnum
+      attr.datatype = "int"
+    elsif value.is_a? Float
+      attr.datatype = "float"
+    else
+      attr.datatype = "string"
+    end
+    
+    attr.units = units
+
+    @attributes << attr  
+  end
+  
+  def add_file(version_sp, version_id, fqp_file, filename, filetype)
+    fs = FileStruct.new
+    fs.version_software_program = version_sp
+    fs.version_id = version_id
+    fs.fqp_file = fqp_file
+    fs.filename = filename
+    fs.filetype = filetype
+    
+    @files << fs
+  end
+  
+
+  def add_cost(cost_name, cost_type, category, value, units, interval, interval_units, year, location, currency, 
+  	       source, reference_component_name, reference_component_id)
+    cs = CostStruct.new
+    cs.cost_name = cost_name
+    cs.cost_type = cost_type
+    cs.category = category
+    cs.value = value
+    cs.interval = interval
+    cs.interval_units = interval_units
+    cs.year = year
+    cs.location = location
+    cs.units = units
+    cs.currency = currency
+    cs.source = source
+    cs.reference_component_name = reference_component_name
+    cs.reference_component_id = reference_component_id
+    
+    @costs << cs
+  end
+  
+  def add_object(object_type, object_instance)
+    ob = ObjectStruct.new
+    ob.obj_type = object_type
+    ob.obj_instance = object_instance
+    
+    @objects << ob
+  end
+  
+  def resolve_path
+    FileUtils.mkdir_p(@path) unless File.directory?(@path)
+    new_path = "#{@path}/#{name.gsub(" ","_").gsub("/","_").gsub("-","_").gsub("___","_").gsub("__","_").gsub("in.","in").gsub(",","").strip}"
+    FileUtils.mkdir_p(new_path) unless File.directory?(new_path)
+    result = new_path
+  end
+  
+  def osm_resolve_path
+    FileUtils.mkdir_p(@path) unless File.directory?(@path)
+    new_path = "#{@path}/osm_#{name.gsub(" ","_").gsub("/","_").gsub("-","_").gsub("___","_").gsub("__","_").gsub("in.","in").gsub(",","").strip}"
+    FileUtils.mkdir_p(new_path) unless File.directory?(new_path)
+    result = new_path
+  end
+  
+  def osc_resolve_path
+    FileUtils.mkdir_p(@path) unless File.directory?(@path)
+    new_path = "#{@path}/osc_#{name.gsub(" ","_").gsub("/","_").gsub("-","_").gsub("___","_").gsub("__","_").gsub("in.","in").gsub(",","").strip}"
+    FileUtils.mkdir_p(new_path) unless File.directory?(new_path)
+    result = new_path
+  end
+  
+  def resolve_component_path(component_type)
+    FileUtils.mkdir_p(@path) unless File.directory?(@path)
+    new_path = @path + '/OpenStudio'
+    FileUtils.mkdir_p(new_path) unless File.directory?(new_path)
+    new_path = new_path + "/#{component_type}"
+    FileUtils.mkdir_p(new_path) unless File.directory?(new_path)
+    return new_path
+  end
+  
+  def tmp_resolve_path
+    FileUtils.mkdir_p(@path) unless File.directory?(@path)
+    new_path = "#{@path}/tmp_#{name.gsub(" ","_").gsub("/","_").gsub("-","_").gsub("___","_").gsub("__","_").gsub("in.","in").gsub(",","").strip}"
+    FileUtils.mkdir_p(new_path) unless File.directory?(new_path)
+    result = new_path
+  end
+  
+  
+  def create_os_component(osobj)
+    osobj.getCostLineItems.each do |os|
+      @costs.each do |cost|
+        #figure out costs for constructions
+        os.setMaterialCost(cost.value.to_f) if cost.category == "material"
+        if cost.category == "installation"
+          os.setInstallationCost(cost.value.to_f)
+          os.setExpectedLife(cost.interval.to_i)
+        end
+        os.setFixedOM(cost.value.to_f) if cost.category == "operations and maintenance"
+        os.setVariableOM(cost.value.to_f) if cost.category == "variable operations and maintenance"
+        os.setSalvageCost(cost.value.to_f) if cost.category == "salvage"
+      end
+    end
+    newcomp = osobj.createComponent
+    
+    cd = newcomp.componentData
+    cd.setDescription(@description)
+    cd.setFidelityLevel(@fidelity_level)
+    
+    at = newcomp.componentData.componentDataAttributes
+    @attributes.each do |attrib|
+      if (attrib.value.to_s != "") and (attrib.name.to_s != "")
+        if attrib.units != ""
+          at.addAttribute(tc(attrib.name), attrib.value, attrib.units)
+        else
+          at.addAttribute(tc(attrib.name), attrib.value)
+        end
+      end
+    end
+    
+    tg = newcomp.componentData.componentDataTags
+    comp_tag = ""
+    @tags.each do |tag|
+      tg.addTag(tc(tag.descriptor))
+      if (tag.descriptor != "energyplus") and (tag.descriptor != "construction")
+        #create a map of component tags to directories
+        comp_tag = tag.descriptor
+        if comp_tag == "interior wall"
+          comp_tag = "interiorwalls"
+        elsif comp_tag == "exterior wall"
+          comp_tag = "exteriorwalls"
+        elsif comp_tag == "exterior slab"
+          comp_tag = "exteriorslabs"
+        elsif comp_tag == "exposed floor"
+          comp_tag = "exposedfloors"
+        elsif comp_tag == "attic floor"
+          comp_tag = "atticfloors"     
+        elsif comp_tag == "roof"
+          comp_tag = "roofs"
+        elsif comp_tag == "door"
+          comp_tag = "doors"
+        elsif comp_tag == "skylight"
+          comp_tag = "skylights"
+        elsif comp_tag == "window"
+          comp_tag = "windows"
+        end
+        puts comp_tag
+      end
+    end
+    
+    return newcomp
+  end
+  
+  def save_component_xml(dir_path = resolve_path)
+    xmlfile = File.new(dir_path + '/component.xml', 'w')
+    comp_xml = Builder::XmlMarkup.new(:target => xmlfile, :indent=>2)
+
+    #setup the xml file
+    comp_xml.instruct! :xml, :version=>"1.0", :encoding=>"UTF-8"
+    comp_xml.component("xmlns:xsi"=>"http://www.w3.org/2001/XMLSchema-instance", 
+    		       "xsi:noNamespaceSchemaLocation"=>"#{SCHEMA_LOCATION}") {
+      comp_xml.name @name
+      comp_xml.uid @uid
+      comp_xml.version_id @comp_version_id
+      comp_xml.description @description if @description != "" 
+      comp_xml.comment @comment if @comment != ""
+      comp_xml.fidelity_level @fidelity_level
+        
+      comp_xml.provenances {
+        @provenance.each do |prov|
+          comp_xml.provenance {
+            comp_xml.author prov.author
+            comp_xml.datetime prov.datetime
+            comp_xml.comment prov.comment
+          }
+        end
+      }
+      
+      comp_xml.tags {
+        @tags.each do |tag|
+          comp_xml.tag tag.descriptor
+        end
+      }
+      
+      comp_xml.attributes {
+        @attributes.each do |attrib|
+          if (attrib.value.to_s != "") and (attrib.name.to_s != "") then
+            comp_xml.attribute {
+              comp_xml.name attrib.name
+              comp_xml.value attrib.value
+              comp_xml.datatype attrib.datatype
+              comp_xml.units attrib.units if attrib.units != ""
+            }
+          end
+        end
+      }
+      
+      comp_xml.source {
+        comp_xml.manufacturer @source_manufacturer if @source_manufacturer != ""
+        comp_xml.model @source_model if @source_model != ""
+        comp_xml.serial_no @source_serial_no if @source_serial_no != ""
+        comp_xml.year @source_year if @source_year != ""
+        comp_xml.url @source_url if @source_url != ""
+      }
+      
+      if not @files.nil?
+        comp_xml.files {
+          @files.each do |file|
+            comp_xml.file {
+              comp_xml.version {
+              comp_xml.software_program file.version_software_program
+              comp_xml.identifier file.version_id
+            }
+	  
+            comp_xml.filename file.filename
+            comp_xml.filetype file.filetype
+	        }
+        end
+        }
+      end
+      
+      #check if we should write out costs, don't write if all values are 0 or nil
+      #DLM: schema always expects costs
+      write_costs = true
+      #if not @costs.nil?
+      #  @costs.each do |cost|
+      #    if (cost.value.nil?) && (not cost.value == 0)
+      #      write_costs = true
+      #      break
+      #    end
+      #  end
+      #end
+      
+      if write_costs
+        comp_xml.costs {
+          @costs.each do |cost|
+            comp_xml.cost {
+              comp_xml.instance_name cost.cost_name
+              comp_xml.cost_type cost.cost_type
+              comp_xml.category cost.category
+              comp_xml.value cost.value
+              comp_xml.units cost.units if cost.units != ""
+              comp_xml.interval cost.interval if cost.interval != ""
+              comp_xml.interval_units cost.interval_units if cost.interval_units != ""
+              comp_xml.year cost.year if cost.year != ""
+              comp_xml.currency cost.currency if cost.currency != ""
+              comp_xml.source cost.source if cost.source != ""
+              comp_xml.reference_component_name cost.reference_component_name if cost.reference_component_name != ""
+              comp_xml.reference_component_id cost.reference_component_id if cost.reference_component_id != ""
+            }
+          end
+        }
+      end
+      
+    }
+    
+    xmlfile.close
+  end  
+    
+  private
+  
+  #return the title case of the string
+  def tc(input)
+    val = input.gsub(/\b\w/){$&.upcase}
+    if val.downcase == "energyplus"
+      val = "EnergyPlus"
+    end
+    return val
+  end
+  
+end
+
+end # module BCL