earth 0.11.10 → 0.11.11

data/lib/earth/industry/industry.rb

@@ -1,6 +1,6 @@
 require 'earth/locality'
 class Industry < ActiveRecord::Base
-  set_primary_key :naics_code
+  self.primary_key = "naics_code"
   
   has_many :merchant_category_industries, :foreign_key => 'naics_code'
   

data/lib/earth/industry/industry_product.rb

@@ -1,6 +1,6 @@
 require 'earth/locality'
 class IndustryProduct < ActiveRecord::Base
-  set_primary_key :naics_product_code
+  self.primary_key = "naics_product_code"
   
   has_many :product_line_industry_products, :foreign_key => 'naics_product_code'
   
@@ -11,4 +11,4 @@ class IndustryProduct < ActiveRecord::Base
   col :value, :type => :float
   col :value_units
   col :naics_code
-end
+end

data/lib/earth/industry/industry_product_line.rb

@@ -1,6 +1,6 @@
 require 'earth/locality'
 class IndustryProductLine < ActiveRecord::Base
-  set_primary_key :row_hash
+  self.primary_key = "row_hash"
   
   belongs_to :industry,     :foreign_key => 'naics_code'
   belongs_to :product_line, :foreign_key => 'ps_code'
@@ -9,4 +9,4 @@ class IndustryProductLine < ActiveRecord::Base
   col :naics_code
   col :ratio, :type => :float
   col :ps_code
-end
+end

data/lib/earth/industry/industry_sector.rb

@@ -1,6 +1,6 @@
 require 'earth/locality'
 class IndustrySector < ActiveRecord::Base
-  set_primary_key :row_hash
+  self.primary_key = "row_hash"
   
   belongs_to :industry,  :foreign_key => 'naics_code'
   belongs_to :sector,    :foreign_key => 'io_code'
@@ -9,4 +9,4 @@ class IndustrySector < ActiveRecord::Base
   col :naics_code
   col :ratio, :type => :float
   col :io_code
-end
+end

data/lib/earth/industry/mecs_energy.rb

@@ -1,38 +1,49 @@
 require 'earth/locality'
 
 class MecsEnergy < ActiveRecord::Base
-  set_primary_key :name
+  self.primary_key = "name"
   
   col :name
-  col :census_region
+  col :census_region_number, :type => :integer
   col :naics_code
-  col :total, :type => :float
-  col :net_electricity, :type => :float
+  col :energy, :type => :float
+  col :energy_units
+  col :electricity, :type => :float
+  col :electricity_units
   col :residual_fuel_oil, :type => :float
+  col :residual_fuel_oil_units
   col :distillate_fuel_oil, :type => :float
+  col :distillate_fuel_oil_units
   col :natural_gas, :type => :float
+  col :natural_gas_units
   col :lpg_and_ngl, :type => :float
+  col :lpg_and_ngl_units
   col :coal, :type => :float
+  col :coal_units
   col :coke_and_breeze, :type => :float
-  col :other, :type => :float
-
-  FUELS = [:net_electricity, :residual_fuel_oil, :distillate_fuel_oil,
-           :natural_gas, :lpg_and_ngl, :coal, :coke_and_breeze, :other]
-
-  def self.find_by_naics_code_and_census_region(code, census_region)
+  col :coke_and_breeze_units
+  col :other_fuel, :type => :float
+  col :other_fuel_units
+  
+  FUELS = [:electricity, :residual_fuel_oil, :distillate_fuel_oil,
+           :natural_gas, :lpg_and_ngl, :coal, :coke_and_breeze, :other_fuel]
+  
+  # Find the first record whose census_region_number matches number and whose naics_code matches code.
+  # If no record found chop off the last character of code and try again, and so on.
+  def self.find_by_naics_code_and_census_region_number(code, number)
     if code.blank?
-      record = nil 
+      record = nil
     else
       code = Industry.format_naics_code code
-      record = where('census_region = ? AND naics_code LIKE ?', census_region, "#{code}%").first
-      record ||= find_by_naics_code_and_census_region(code[0..-2], census_region)
+      record = where('census_region_number = ? AND naics_code = ?', number, code).first
+      record ||= find_by_naics_code_and_census_region_number(code[0..-2], number)
     end
     record
   end
-
+  
   def fuel_ratios
     FUELS.inject({}) do |ratios, fuel|
-      ratios[fuel] = send(fuel).to_f / total.to_f
+      ratios[fuel] = send("#{fuel}").to_f / energy.to_f
       ratios
     end
   end

data/lib/earth/industry/mecs_energy/data_miner.rb

@@ -1,51 +1,67 @@
 require 'earth/eia'
 require 'earth/locality'
+
 MecsEnergy.class_eval do
   const_set(:CENSUS_REGIONS, {
     'Total US' =>  {
-      :crop => (15..93),
+      :crop => (15..94),
       :code => nil
     },
     'Northeast' => {
-      :crop => (99..177),
+      :crop => (99..178),
       :code => 1
     },
     'Midwest' => {
-      :crop => (184..262),
+      :crop => (183..262),
       :code => 2
     },
     'South' =>  {
-      :crop => (267..345),
+      :crop => (267..346),
       :code => 3
     },
     'West' => {
-      :crop => (351..429),
+      :crop => (351..430),
       :code => 4
     }
   })
-
+  
   data_miner do
     MecsEnergy::CENSUS_REGIONS.each do |region, data|
       import("MECS table 3.2 #{region}",
         :url => "http://205.254.135.24/emeu/mecs/mecs2006/excel/Table3_2.xls",
-        :crop => data[:crop], :headers => false, :skip => 1) do
-        key 'name', :synthesize => Proc.new { |row| "#{Industry.format_naics_code(row[0])}-#{data[:code]}" }
-        store 'naics_code', :field_number => 0
-        store :total, :field_number => 2
-        store :net_electricity, :field_number => 4
-        store :residual_fuel_oil, :field_number => 5
-        store :distillate_fuel_oil, :field_number => 6
-        store :natural_gas, :field_number => 8
-        store :lpg_and_ngl, :field_number => 10
-        store :coal, :field_number => 12
-        store :coke_and_breeze, :field_number => 13
-        store :other, :field_number => 14
-        store 'census_region', :static => data[:code]
+        :crop => data[:crop],
+        :headers => ["NAICS Code", "Subsector and Industry", "Total", "BLANK", "Net Electricity", "BLANK", "Residual Fuel Oil", "Distillate Fuel Oil", "Natural Gas", "BLANK", "LPG and NGL", "BLANK", "Coal", "Coke and Breeze", "Other"]) do
+        key :name, :synthesize => Proc.new { |row| "#{Industry.format_naics_code(row['NAICS Code'])}-#{data[:code]}" }
+        store :census_region_number, :static => data[:code]
+        store :naics_code, :field_name => 'NAICS Code'
+        store :energy, :units => :megajoules, :synthesize => Proc.new { |row|
+          Earth::EIA.convert_value(row['Total'], :from => :trillion_btus, :to => :megajoules)
+        }
+        store :electricity, :units => :megajoules, :synthesize => Proc.new { |row|
+          Earth::EIA.convert_value(row['Net Electricity'], :from => :trillion_btus, :to => :megajoules)
+        }
+        store :residual_fuel_oil, :units => :megajoules, :synthesize => Proc.new { |row|
+          Earth::EIA.convert_value(row['Residual Fuel Oil'], :from => :trillion_btus, :to => :megajoules)
+        }
+        store :distillate_fuel_oil, :units => :megajoules, :synthesize => Proc.new { |row|
+          Earth::EIA.convert_value(row['Distillate Fuel Oil'], :from => :trillion_btus, :to => :megajoules)
+        }
+        store :natural_gas, :units => :megajoules, :synthesize => Proc.new { |row|
+          Earth::EIA.convert_value(row['Natural Gas'], :from => :trillion_btus, :to => :megajoules)
+        }
+        store :lpg_and_ngl, :units => :megajoules, :synthesize => Proc.new { |row|
+          Earth::EIA.convert_value(row['LPG and NGL'], :from => :trillion_btus, :to => :megajoules)
+        }
+        store :coal, :units => :megajoules, :synthesize => Proc.new { |row|
+          Earth::EIA.convert_value(row['Coal'], :from => :trillion_btus, :to => :megajoules)
+        }
+        store :coke_and_breeze, :units => :megajoules, :synthesize => Proc.new { |row|
+          Earth::EIA.convert_value(row['Coke and Breeze'], :from => :trillion_btus, :to => :megajoules)
+        }
+        store :other_fuel, :units => :megajoules, :synthesize => Proc.new { |row|
+          Earth::EIA.convert_value(row['Other'], :from => :trillion_btus, :to => :megajoules)
+        }
       end
     end
-
-    process :normalize_fuels do
-      Earth::EIA.normalize(MecsEnergy, MecsEnergy::FUELS)
-    end
   end
 end

data/lib/earth/industry/mecs_ratio.rb

@@ -2,22 +2,25 @@ require 'earth/locality'
 require 'earth/industry/industry'
 
 class MecsRatio < ActiveRecord::Base
-  set_primary_key :name
-
+  self.primary_key = "name"
+  
+  belongs_to :industry
+  
   col :name
-  col :census_region
+  col :census_region_number, :type => :integer
   col :naics_code
-  col :consumption_per_dollar_of_shipments, :type => :float
+  col :energy_per_dollar_of_shipments, :type => :float
+  col :energy_per_dollar_of_shipments_units
   
-  belongs_to :industry
-
-  def self.find_by_naics_code_and_census_region(code, census_region)
+  # Find the first MecsRatio whose census_region_number matches number and whose naics_code matches code.
+  # If none found, chop off the last character of code and try again, and so on.
+  def self.find_by_naics_code_and_census_region_number(code, number)
     if code.blank?
-      record = nil 
+      record = nil
     else
       code = Industry.format_naics_code code
-      record = where('census_region = ? AND naics_code LIKE ?', census_region, "#{code}%").first
-      record ||= find_by_naics_code_and_census_region(code[0..-2], census_region)
+      record = where('census_region_number = ? AND naics_code = ?', number, code).first
+      record ||= find_by_naics_code_and_census_region_number(code[0..-2], number)
     end
     record
   end

data/lib/earth/industry/mecs_ratio/data_miner.rb

@@ -1,25 +1,26 @@
 require 'earth/eia'
 require 'earth/locality/data_miner'
+
 MecsRatio.class_eval do
   const_set(:CENSUS_REGIONS, {
     'Total US' =>  {
-      :crop => (16..94),
+      :crop => (16..95),
       :code => nil
     },
     'Northeast' => {
-      :crop => (100..178),
+      :crop => (100..179),
       :code => 1
     },
     'Midwest' => {
-      :crop => (184..262),
+      :crop => (184..263),
       :code => 2
     },
     'South' =>  {
-      :crop => (268..346),
+      :crop => (268..347),
       :code => 3
     },
     'West' => {
-      :crop => (352..430),
+      :crop => (352..431),
       :code => 4
     }
   })
@@ -28,16 +29,15 @@ MecsRatio.class_eval do
     MecsRatio::CENSUS_REGIONS.each do |region, data|
       import( "MECS table 6.1 #{region}",
         :url => "http://205.254.135.24/emeu/mecs/mecs2006/excel/Table6_1.xls",
-        :crop => data[:crop]) do
-        key 'name', :synthesize => Proc.new { |row| "#{Industry.format_naics_code(row[0])}-#{data[:code]}" }
-        store 'naics_code', :synthesize => Proc.new { |row| Industry.format_naics_code row[0] }
-        store 'consumption_per_dollar_of_shipments', :field_number => 4
-        store 'census_region', :static => data[:code]
+        :crop => data[:crop],
+        :headers => ["NAICS Code", "Subsector and Industry", "Consumption per Employee", "Consumption per Dollar of Value Added", "Consumption per Dollar of Value of Shipments"]) do
+        key :name, :synthesize => Proc.new { |row| "#{Industry.format_naics_code(row["NAICS Code"])}-#{data[:code]}" }
+        store :census_region_number, :static => data[:code]
+        store :naics_code, :synthesize => Proc.new { |row| Industry.format_naics_code row["NAICS Code"] }
+        store :energy_per_dollar_of_shipments, :units => :megajoules, :synthesize => Proc.new { |row|
+          Earth::EIA.convert_value(row['Consumption per Dollar of Value of Shipments'], :from => :kbtus, :to => :megajoules)
+        }
       end
     end
-
-    process :normalize_fuels do
-      Earth::EIA.normalize(MecsRatio, [:consumption_per_dollar_of_shipments])
-    end
   end
 end

data/lib/earth/industry/merchant.rb

@@ -1,9 +1,9 @@
 class Merchant < ActiveRecord::Base
-  set_primary_key :id
+  self.primary_key = "id"
   
   belongs_to :merchant_category, :foreign_key => 'mcc'
 
   col :id
   col :name
   col :mcc
-end
+end

data/lib/earth/industry/merchant_category.rb

@@ -1,5 +1,5 @@
 class MerchantCategory < ActiveRecord::Base
-  set_primary_key :mcc
+  self.primary_key = "mcc"
 
   has_many :merchant_category_industries, :foreign_key => 'mcc'
   has_many :industries, :through => :merchant_category_industries
@@ -10,4 +10,4 @@ class MerchantCategory < ActiveRecord::Base
 
   col :mcc
   col :description
-end
+end

data/lib/earth/industry/merchant_category_industry.rb

@@ -1,5 +1,5 @@
 class MerchantCategoryIndustry < ActiveRecord::Base
-  set_primary_key :row_hash
+  self.primary_key = "row_hash"
   
   belongs_to :merchant_category, :foreign_key => 'mcc'
   belongs_to :industry,          :foreign_key => 'naics_code'
@@ -8,4 +8,4 @@ class MerchantCategoryIndustry < ActiveRecord::Base
   col :mcc
   col :ratio, :type => :float
   col :naics_code
-end
+end

data/lib/earth/industry/product_line.rb

@@ -1,5 +1,5 @@
 class ProductLine < ActiveRecord::Base
-  set_primary_key :ps_code
+  self.primary_key = "ps_code"
   
   has_many :industry_product_lines,         :foreign_key => 'ps_code'
   
@@ -10,4 +10,4 @@ class ProductLine < ActiveRecord::Base
   col :description, :type => :text
   col :broadline # FIXME TODO do we need this?
   col :parent    # FIXME TODO do we need this?
-end
+end

data/lib/earth/industry/product_line_industry_product.rb

@@ -1,5 +1,5 @@
 class ProductLineIndustryProduct < ActiveRecord::Base
-  set_primary_key :row_hash
+  self.primary_key = "row_hash"
   
   belongs_to :product_line,     :foreign_key => 'ps_code'
   belongs_to :industry_product, :foreign_key => 'naics_product_code'
@@ -8,4 +8,4 @@ class ProductLineIndustryProduct < ActiveRecord::Base
   col :ps_code
   col :ratio, :type => :float
   col :naics_product_code
-end
+end

data/lib/earth/industry/sector.rb

@@ -1,5 +1,5 @@
 class Sector < ActiveRecord::Base
-  set_primary_key :io_code
+  self.primary_key = "io_code"
 
   has_many :industry_sectors, :foreign_key => 'io_code'
   
@@ -7,4 +7,4 @@ class Sector < ActiveRecord::Base
   col :description, :type => :text
   col :value, :type => :float
   col :value_units
-end
+end

data/lib/earth/locality/census_division.rb

@@ -1,6 +1,6 @@
 require 'earth/fuel'
 class CensusDivision < ActiveRecord::Base
-  set_primary_key :number
+  self.primary_key = "number"
   
   belongs_to :census_region, :foreign_key => 'census_region_number'
   has_many :states, :foreign_key => 'census_division_number'
@@ -26,4 +26,4 @@ class CensusDivision < ActiveRecord::Base
   col :meeting_building_electricity_intensity_units
   col :meeting_building_district_heat_intensity, :type => :float
   col :meeting_building_district_heat_intensity_units
-end
+end

data/lib/earth/locality/census_division/data_miner.rb

@@ -1,16 +1,6 @@
 require 'earth/fuel/data_miner'
 CensusDivision.class_eval do
   data_miner do
-    process 'Define some unit conversions' do
-      Conversions.register :hundred_cubic_feet_per_square_foot_hour, :cubic_metres_per_square_metre_hour,   30.48
-      Conversions.register :gallons_per_square_foot_hour,            :litres_per_square_metre_hour,         40.7458333
-      Conversions.register :kilowatt_hours_per_square_foot_hour,     :kilowatt_hours_per_square_metre_hour, 10.7639104
-      Conversions.register :thousand_btu_per_square_foot_hour,       :megajoules_per_square_metre_hour,     11.3565267
-      Conversions.register :hundred_cubic_feet_per_room_night,       :cubic_metres_per_room_night,          2.83168466
-      Conversions.register :gallons_per_room_night,                  :litres_per_room_night,                3.78541178
-      Conversions.register :thousand_btu_per_room_night,             :megajoules_per_room_night,            1.05505585
-    end
-    
     # http://www.census.gov/popest/geographic/codes02.csv
     import('the U.S. Census Geographic Terms and Definitions',
            :url => 'http://www.census.gov/popest/about/geo/state_geocodes_v2009.txt',
@@ -26,10 +16,10 @@ CensusDivision.class_eval do
     import 'meeting building fuel intensities calculated from CBECS 2003',
            :url => 'https://spreadsheets.google.com/pub?key=0AoQJbWqPrREqdGotdjgtUEk0eUU0R3lxM1hHdlF1V0E&hl=en&gid=0&output=csv' do
       key   'number', :field_name => 'census_division'
-      store 'meeting_building_natural_gas_intensity', :from_units => :hundred_cubic_feet_per_square_foot_hour, :to_units => :cubic_metres_per_square_metre_hour
-      store 'meeting_building_fuel_oil_intensity', :from_units => :gallons_per_square_foot_hour, :to_units => :litres_per_square_metre_hour
-      store 'meeting_building_electricity_intensity', :from_units => :kilowatt_hours_per_square_foot_hour, :to_units => :kilowatt_hours_per_square_metre_hour
-      store 'meeting_building_district_heat_intensity', :from_units => :thousand_btu_per_square_foot_hour, :to_units => :megajoules_per_square_metre_hour
+      store 'meeting_building_natural_gas_intensity',   :from_units => :hundred_cubic_feet_per_square_foot_hour, :to_units => :cubic_metres_per_square_metre_hour
+      store 'meeting_building_fuel_oil_intensity',      :from_units => :gallons_per_square_foot_hour,            :to_units => :litres_per_square_metre_hour
+      store 'meeting_building_electricity_intensity',   :from_units => :kilowatt_hours_per_square_foot_hour,     :to_units => :kilowatt_hours_per_square_metre_hour
+      store 'meeting_building_district_heat_intensity', :from_units => :kbtus_per_square_foot_hour,              :to_units => :megajoules_per_square_metre_hour
     end
   end
 end

data/lib/earth/locality/census_region.rb

@@ -1,5 +1,5 @@
 class CensusRegion < ActiveRecord::Base
-  set_primary_key :number
+  self.primary_key = "number"
   
   has_many :census_divisions, :foreign_key => 'census_region_number'
   has_many :states, :through => :census_divisions
@@ -9,4 +9,4 @@ class CensusRegion < ActiveRecord::Base
   
   col :number, :type => :integer
   col :name
-end
+end

data/lib/earth/locality/climate_division.rb

@@ -1,27 +1,11 @@
 class ClimateDivision < ActiveRecord::Base
-  set_primary_key :name
+  self.primary_key = "name"
   
   has_many :zip_codes, :foreign_key => 'climate_division_name'
   belongs_to :state, :foreign_key => 'state_postal_abbreviation'
   
   RADIUS = 750
   
-  def climate_zone_number
-    if cooling_degree_days < 2000.degrees_fahrenheit.to(:degrees_celsius)
-      if heating_degree_days > 7000.degrees_fahrenheit.to(:degrees_celsius)
-        1
-      elsif heating_degree_days > 5499.degrees_fahrenheit.to(:degrees_celsius)
-        2
-      elsif heating_degree_days > 3999.degrees_fahrenheit.to(:degrees_celsius)
-        3
-      else
-        4
-      end
-    else
-      5
-    end
-  end
-  
   col :name
   col :heating_degree_days, :type => :float
   col :heating_degree_days_units