earth 0.11.10 → 0.11.11

data/lib/earth/automobile/automobile_size_class_year.rb

@@ -1,7 +1,7 @@
 require 'earth/fuel'
 # Not yet in use - for if we want to autocaculate size class stuf - November 10, 2011
 class AutomobileSizeClassYear < ActiveRecord::Base
-  set_primary_key :name
+  self.primary_key = "name"
 
   col :name
   col :size_class_name

data/lib/earth/automobile/automobile_type_fuel_control.rb

@@ -1,6 +1,6 @@
 require 'earth/fuel'
 class AutomobileTypeFuelControl < ActiveRecord::Base
-  set_primary_key :name
+  self.primary_key = "name"
   col :name
   col :type_name
   col :fuel_common_name

data/lib/earth/automobile/automobile_type_fuel_year.rb

@@ -1,6 +1,6 @@
 require 'earth/fuel'
 class AutomobileTypeFuelYear < ActiveRecord::Base
-  set_primary_key :name
+  self.primary_key = "name"
   
   # FIXME TODO keep this until fix AutomobileFuel import so that it doesn't call type_fuel_year.type_year
   belongs_to :type_year, :class_name => 'AutomobileTypeYear', :foreign_key => 'type_year_name'

data/lib/earth/automobile/automobile_type_fuel_year_age.rb

@@ -1,6 +1,6 @@
 require 'earth/fuel'
 class AutomobileTypeFuelYearAge < ActiveRecord::Base
-  set_primary_key :name
+  self.primary_key = "name"
   
   col :name
   col :type_name

data/lib/earth/automobile/automobile_type_fuel_year_control.rb

@@ -1,6 +1,6 @@
 require 'earth/fuel'
 class AutomobileTypeFuelYearControl < ActiveRecord::Base
-  set_primary_key :name
+  self.primary_key = "name"
   
   col :name
   col :type_name

data/lib/earth/automobile/automobile_type_year.rb

@@ -1,6 +1,6 @@
 require 'earth/fuel'
 class AutomobileTypeYear < ActiveRecord::Base
-  set_primary_key :name
+  self.primary_key = "name"
   
   # FIXME TODO keep this until fix AutomobileFuel fallback hfc emission factor so that it doesn't call type_year.type_fuel_year
   has_many :type_fuel_years, :class_name => 'AutomobileTypeFuelYear', :foreign_key => 'type_year_name'
@@ -55,4 +55,4 @@ class AutomobileTypeYear < ActiveRecord::Base
   #   end
   # end
   
-end
+end

data/lib/earth/automobile/automobile_year.rb

@@ -1,6 +1,6 @@
 require 'earth/fuel'
 class AutomobileYear < ActiveRecord::Base
-  set_primary_key :year
+  self.primary_key = "year"
   
   col :year, :type => :integer
 end

data/lib/earth/bus/bus_class.rb

@@ -1,6 +1,6 @@
 require 'earth/fuel'
 class BusClass < ActiveRecord::Base
-  set_primary_key :name
+  self.primary_key = "name"
   
   # https://spreadsheets.google.com/pub?key=0AoQJbWqPrREqdHY0R0hjZnhRaTIxTnpvRk1HNThwUmc&hl=en&output=html
   falls_back_on :passengers => 7.485,

data/lib/earth/bus/bus_fuel.rb

@@ -1,6 +1,6 @@
 require 'earth/fuel'
 class BusFuel < ActiveRecord::Base
-  set_primary_key :name
+  self.primary_key = "name"
   
   belongs_to :fuel, :foreign_key => 'fuel_name'
   has_many :fuel_year_controls, :class_name => 'BusFuelYearControl', :foreign_key => 'bus_fuel_name'
@@ -91,4 +91,4 @@ class BusFuel < ActiveRecord::Base
   #     end
   #   end
   # end
-end
+end

data/lib/earth/bus/bus_fuel_control.rb

@@ -1,6 +1,6 @@
 require 'earth/fuel'
 class BusFuelControl < ActiveRecord::Base
-  set_primary_key :name
+  self.primary_key = "name"
   col :name
   col :bus_fuel_name
   col :control
@@ -8,4 +8,4 @@ class BusFuelControl < ActiveRecord::Base
   col :ch4_emission_factor_units
   col :n2o_emission_factor, :type => :float
   col :n2o_emission_factor_units
-end
+end

data/lib/earth/bus/bus_fuel_year_control.rb

@@ -1,6 +1,6 @@
 require 'earth/fuel'
 class BusFuelYearControl < ActiveRecord::Base
-  set_primary_key :name
+  self.primary_key = "name"
   
   belongs_to :fuel_control, :class_name => 'BusFuelControl', :foreign_key => 'bus_fuel_control_name'
 
@@ -10,4 +10,4 @@ class BusFuelYearControl < ActiveRecord::Base
   col :control
   col :bus_fuel_control_name
   col :total_travel_percent, :type => :float
-end
+end

data/lib/earth/computation/computation_carrier.rb

@@ -1,6 +1,6 @@
 require 'earth/locality'
 class ComputationCarrier < ActiveRecord::Base
-  set_primary_key :name
+  self.primary_key = "name"
   
   falls_back_on :name => 'fallback',
                 :power_usage_effectiveness => lambda { ComputationCarrier.maximum('power_usage_effectiveness') }
@@ -15,4 +15,4 @@ class ComputationCarrier < ActiveRecord::Base
   #     end
   #   end
   # end
-end
+end

data/lib/earth/computation/computation_carrier_instance_class.rb

@@ -1,6 +1,6 @@
 require 'earth/locality'
 class ComputationCarrierInstanceClass < ActiveRecord::Base
-  set_primary_key :name
+  self.primary_key = "name"
   
   belongs_to :computation_carrier, :foreign_key => 'computation_carrier_name'
   
@@ -32,4 +32,4 @@ class ComputationCarrierInstanceClass < ActiveRecord::Base
   #   end
   # end
   
-end
+end

data/lib/earth/computation/computation_carrier_region.rb

@@ -1,6 +1,6 @@
 require 'earth/locality'
 class ComputationCarrierRegion < ActiveRecord::Base
-  set_primary_key :name
+  self.primary_key = "name"
   
   belongs_to :egrid_subregion, :foreign_key => 'egrid_subregion_abbreviation'
 
@@ -8,4 +8,4 @@ class ComputationCarrierRegion < ActiveRecord::Base
   col :computation_carrier_name
   col :region
   col :egrid_subregion_abbreviation
-end
+end

data/lib/earth/conversions_ext.rb

@@ -5,15 +5,18 @@ Conversions.register :kilometres, :miles,          0.621371192
 Conversions.register :kilometres, :nautical_miles, 0.539956803
 
 # Area
-Conversions.register :square_metres, :square_feet, 10.7639104
+Conversions.register :square_metres, :square_feet,         10.7639104
+Conversions.register :square_metres, :million_square_feet, (1.square_metres.to(:square_feet) / 1_000_000)
 
 # Volume, liquid: base unit = litre
-Conversions.register :litres,       :gallons,            0.264172052
-Conversions.register :litres,       :cubic_inches,       61.0237441
+Conversions.register :gallons,      :litres, 3.78541178
+Conversions.register :cubic_inches, :litres, 0.016387064
+Conversions.register :barrels,      :litres, 42.gallons.to(:litres)
 
 # Volume, solid: base unit = cubic metre
 Conversions.register :cubic_metres, :cubic_feet,         35.3146667
-Conversions.register :cubic_metres, :hundred_cubic_feet, 0.353146667
+Conversions.register :cubic_metres, :hundred_cubic_feet, (1.cubic_metres.to(:cubic_feet) / 100)
+Conversions.register :cubic_metres, :billion_cubic_feet, (1.cubic_metres.to(:cubic_feet) / 1_000_000_000)
 
 # Mass: base unit = kilogram
 Conversions.register :kilograms, :grams,         1_000.0
@@ -22,8 +25,14 @@ Conversions.register :kilograms, :pounds,        2.20462262
 Conversions.register :kilograms, :tons,          0.00110231131
 
 # Energy: base unit = megajoule
-Conversions.register :megajoules, :kbtus,          0.94781712
-Conversions.register :megajoules, :kilowatt_hours, 0.277777778
+Conversions.register :btus,                   :megajoules, 0.00105505585
+Conversions.register :kbtus,                  :megajoules, 1_000.btus.to(:megajoules)
+Conversions.register :trillion_btus,          :megajoules, 1_000_000_000_000.btus.to(:megajoules)
+Conversions.register :kilowatt_hours,         :megajoules, 3.6
+Conversions.register :billion_kilowatt_hours, :megajoules, 1_000_000_000.kilowatt_hours.to(:megajoules)
+
+# Electricity: base unit = kilowatt hour
+Conversions.register :kilowatt_hours, :billion_kilowatt_hours, (1.0 / 1_000_000_000.0)
 
 # Monetary
 Conversions.register :dollars, :cents, 100.0
@@ -42,10 +51,13 @@ Conversions.register :litres_per_square_metre_hour,         :gallons_per_square_
 Conversions.register :litres_per_room_night,                :gallons_per_room_night,                  (1.litres.to(:gallons))
 Conversions.register :cubic_metres_per_square_metre_hour,   :hundred_cubic_feet_per_square_foot_hour, (1.cubic_metres.to(:hundred_cubic_feet) / 1.square_metres.to(:square_feet))
 Conversions.register :cubic_metres_per_room_night,          :hundred_cubic_feet_per_room_night,       (1.cubic_metres.to(:hundred_cubic_feet))
+Conversions.register :kilowatt_hours_per_square_metre,      :kilowatt_hours_per_square_foot,          (1 / 1.square_metres.to(:square_feet))
 Conversions.register :kilowatt_hours_per_square_metre_hour, :kilowatt_hours_per_square_foot_hour,     (1 / 1.square_metres.to(:square_feet))
 Conversions.register :megajoules_per_square_metre_hour,     :kbtus_per_square_foot_hour,              (1.megajoules.to(:kbtus) / 1.square_metres.to(:square_feet))
 Conversions.register :megajoules_per_room_night,            :kbtus_per_room_night,                    (1.megajoules.to(:kbtus))
-
+Conversions.register :million_btu_per_barrel,               :megajoules_per_litre,                    (1_000_000.btus.to(:megajoules) / 1.barrels.to(:litres)) # Fuel
+Conversions.register :btus_per_cubic_foot,                  :megajoules_per_cubic_metre,              (1.btus.to(:megajoules) / 1.cubic_feet.to(:cubic_metres)) # Fuel
+Conversions.register :teragrams_per_quadrillion_btu,        :grams_per_megajoule,                     (1_000_000_000_000 / 1_000_000_000_000_000.btus.to(:megajoules)) # Fuel
 
 # Odd units for pet - FIXME use megajoules rather than joules
 Conversions.register :kilocalories,           :joules,              4_184.0
@@ -64,6 +76,13 @@ Conversions.register :kbtus,          :joules,             (1_000.0 * 1_055.0558
 Conversions.register :watt_hours,     :joules,             3_600.0
 Conversions.register :kilowatt_hours, :joules,             3_600_000.0
 
+# Odd units for CBECS
+Conversions.register :trillion_btus_per_million_square_feet, :megajoules_per_square_metre,     (1.trillion_btus.to(:megajoules) / 1.square_feet.to(:square_metres))
+Conversions.register :kilowatt_hours_per_square_foot, :megajoules_per_square_metre,            (1.kilowatt_hours.to(:megajoules) / 1.square_feet.to(:square_metres))
+Conversions.register :billion_cubic_feet_of_natural_gas, :megajoules,                          (1_000_000_000.cubic_feet.to(:cubic_metres) * 38.3395) # 2003 NatGas energy content MJ/m3
+Conversions.register :cubic_feet_of_natural_gas_per_square_foot, :megajoules_per_square_metre, ((1.cubic_feet.to(:cubic_metres) * 38.3395) / 1.square_feet.to(:square_metres))
+Conversions.register :million_gallons_of_fuel_oil, :megajoules,                                (1_000_000.gallons.to(:litres) * 39.0136) # Residual Fuel Oil energy content MJ/l from Fuels
+Conversions.register :gallons_of_fuel_oil_per_square_foot, :megajoules_per_square_metre,       ((39.0136 * 1.gallons.to(:litres)) / 1.square_feet.to(:square_metres))
 
 # Only used in app1
 Conversions.register(:pounds_per_gallon, :kilograms_per_litre, 0.119826427) # only used in app1

data/lib/earth/diet/diet_class.rb

@@ -1,5 +1,5 @@
 class DietClass < ActiveRecord::Base
-  set_primary_key :name
+  self.primary_key = "name"
   
   class << self
     def fallback
@@ -20,4 +20,4 @@ class DietClass < ActiveRecord::Base
   col :fruit_share, :type => :float
   col :vegetables_share, :type => :float
   col :oils_and_sugars_share, :type => :float
-end
+end

data/lib/earth/diet/food_group.rb

@@ -1,5 +1,5 @@
 class FoodGroup < ActiveRecord::Base
-  set_primary_key :name
+  self.primary_key = "name"
 
   class << self
     def names
@@ -17,4 +17,4 @@ class FoodGroup < ActiveRecord::Base
   col :energy, :type => :float
   col :energy_units
   col :suggested_imperial_measurement # ?
-end
+end

data/lib/earth/eia.rb

@@ -1,21 +1,21 @@
 require 'earth'
+
 module Earth
   module EIA
     extend self
-
-    def normalize(model, fields)
-      model.all.each do |record|
-        fields.each do |k|
-          v = record.send k
-          normalized_v = case v
-          when 'Q', 'W', '*'
-            0
-          else
-            v
-          end
-          record.send "#{k}=", normalized_v
+    
+    def convert_value(value, args = {})
+      case value
+      when '*'
+        0
+      when 'Q', 'W'
+        nil
+      else
+        if args[:to]
+          value.to_f.send(args[:from]).to(args[:to])
+        else
+          value.to_f
         end
-        record.save!
       end
     end
   end

data/lib/earth/fuel/fuel.rb

@@ -1,9 +1,10 @@
 class Fuel < ActiveRecord::Base
-  set_primary_key :name
+  self.primary_key = "name"
   
   has_many :fuel_years, :foreign_key => 'fuel_name'
   
   col :name
+  col :physical_units
   col :density, :type => :float
   col :density_units
   col :energy_content, :type => :float
@@ -17,7 +18,15 @@ class Fuel < ActiveRecord::Base
   col :co2_biogenic_emission_factor, :type => :float
   col :co2_biogenic_emission_factor_units
   
-  def latest_year
+  # Need to ensure FuelYear gets data_mined even when pulling with taps
+  # b/c Fuel has instance methods to look up missing values from FuelYear
+  data_miner do
+    process "Ensure FuelYear is imported" do
+      FuelYear.run_data_miner!
+    end
+  end
+  
+  def latest_fuel_year
     fuel_years.find_by_year(fuel_years.maximum('year'))
   end
   
@@ -25,7 +34,7 @@ class Fuel < ActiveRecord::Base
     if content = super
       content
     elsif fuel_years.present?
-      latest_year.energy_content
+      latest_fuel_year.energy_content
     end
   end
   
@@ -33,7 +42,7 @@ class Fuel < ActiveRecord::Base
     if units = super
       units
     elsif fuel_years.present?
-      latest_year.energy_content_units
+      latest_fuel_year.energy_content_units
     end
   end
   
@@ -41,7 +50,7 @@ class Fuel < ActiveRecord::Base
     if content = super
       content
     elsif fuel_years.present?
-      latest_year.carbon_content
+      latest_fuel_year.carbon_content
     end
   end
   
@@ -49,7 +58,7 @@ class Fuel < ActiveRecord::Base
     if units = super
       units
     elsif fuel_years.present?
-      latest_year.carbon_content_units
+      latest_fuel_year.carbon_content_units
     end
   end
   
@@ -57,7 +66,7 @@ class Fuel < ActiveRecord::Base
     if oxidation_factor = super
       oxidation_factor
     elsif fuel_years.present?
-      latest_year.oxidation_factor
+      latest_fuel_year.oxidation_factor
     end
   end
   
@@ -65,7 +74,7 @@ class Fuel < ActiveRecord::Base
     if biogenic_fraction = super
       biogenic_fraction
     elsif fuel_years.present?
-      latest_year.biogenic_fraction
+      latest_fuel_year.biogenic_fraction
     end
   end
   
@@ -73,7 +82,7 @@ class Fuel < ActiveRecord::Base
     if ef = super
       ef
     elsif fuel_years.present?
-      latest_year.co2_emission_factor
+      latest_fuel_year.co2_emission_factor
     end
   end
   
@@ -81,7 +90,7 @@ class Fuel < ActiveRecord::Base
     if units = super
       units
     elsif fuel_years.present?
-      latest_year.co2_emission_factor_units
+      latest_fuel_year.co2_emission_factor_units
     end
   end
   
@@ -89,7 +98,7 @@ class Fuel < ActiveRecord::Base
     if ef = super
       ef
     elsif fuel_years.present?
-      latest_year.co2_biogenic_emission_factor
+      latest_fuel_year.co2_biogenic_emission_factor
     end
   end
   
@@ -97,7 +106,7 @@ class Fuel < ActiveRecord::Base
     if units = super
       units
     elsif fuel_years.present?
-      latest_year.co2_biogenic_emission_factor_units
+      latest_fuel_year.co2_biogenic_emission_factor_units
     end
   end
-end
+end

data/lib/earth/fuel/fuel/data_miner.rb

@@ -12,11 +12,24 @@ Fuel.class_eval do
       )
     end
     
-    import "fuels with non-variable characteristics",
-           :url => 'https://spreadsheets.google.com/pub?key=0AoQJbWqPrREqdGJmYkdtajZyV3Byb0lrd21xLVhXUGc&hl=en&gid=0&output=csv' do
+    import "liquid fuels with non-variable characteristics",
+           :url => 'https://spreadsheets.google.com/pub?key=0AoQJbWqPrREqdGJmYkdtajZyV3Byb0lrd21xLVhXUGc&output=csv',
+           :select => lambda {|row| row['energy_content_units'] == 'million_btu_per_barrel'} do
       key 'name'
-      store 'energy_content', :units_field_name => 'energy_content_units'
-      store 'carbon_content', :units_field_name => 'carbon_content_units'
+      store 'physical_units', :static => 'litre'
+      store 'energy_content', :from_units => :million_btu_per_barrel,        :to_units => :megajoules_per_litre
+      store 'carbon_content', :from_units => :teragrams_per_quadrillion_btu, :to_units => :grams_per_megajoule
+      store 'oxidation_factor'
+      store 'biogenic_fraction'
+    end
+    
+    import "gaseous fuels with non-variable characteristics",
+           :url => 'https://spreadsheets.google.com/pub?key=0AoQJbWqPrREqdGJmYkdtajZyV3Byb0lrd21xLVhXUGc&output=csv',
+           :select => lambda {|row| row['energy_content_units'] == 'btu_per_cubic_foot'} do
+      key 'name'
+      store 'physical_units', :static => 'cubic_metre'
+      store 'energy_content', :from_units => :btus_per_cubic_foot,           :to_units => :megajoules_per_cubic_metre
+      store 'carbon_content', :from_units => :teragrams_per_quadrillion_btu, :to_units => :grams_per_megajoule
       store 'oxidation_factor'
       store 'biogenic_fraction'
     end
@@ -27,52 +40,31 @@ Fuel.class_eval do
       store 'density', :units_field_name => 'density_units'
     end
     
-    process "Convert energy content of liquid fuels to metric units" do
-      conversion_factor = (1_055.05585) * (1.0 / 158.987295) # Google: 1_055.05585 MJ / 1 MMBtu * 1 barrel / 158.987295 l
-      where(:energy_content_units => 'million_btu_per_barrel').update_all(%{
-        energy_content = 1.0 * energy_content * #{conversion_factor},
-        energy_content_units = 'megajoules_per_litre'
-      })
-    end
-    
-    process "Convert energy content of gaseous fuels to metric units" do
-      conversion_factor = (1.0 / 947.81712) * (35.3146667) # Google: 1.0 MJ / 947.81712 Btu * 35.3146667 cubic feet / 1 cubic m
-      where(:energy_content_units => 'btu_per_cubic_foot').update_all(%{
-        energy_content = 1.0 * energy_content * #{conversion_factor},
-        energy_content_units = 'megajoules_per_cubic_metre'
-      })
-    end
-    
-    process "Convert carbon content to metric units" do
-      conversion_factor = (1_000_000_000_000.0) * (1.0 / 1_055_055_852_620.0) # Google: 1e12 g / Tg * 1 QBtu / 1.055e12 MJ
-      where(:carbon_content_units => 'teragrams_per_quadrillion_btu').update_all(%{
-        carbon_content = 1.0 * carbon_content * #{conversion_factor},
-        carbon_content_units = 'grams_per_megajoule'
-      })
+    process "Create district heat" do
+      natural_gas = find_by_name 'Pipeline Natural Gas'
+      fuel_oil = find_by_name 'Residual Fuel Oil No. 6'
+      district_heat = find_or_create_by_name "District Heat"
+      
+      # Assumptions:              half nat gas at 81.7% efficiency    half fuel oil at 84.6% efficiency      5% transmission losses
+      district_heat.carbon_content = (((natural_gas.carbon_content / 0.817) + (fuel_oil.carbon_content / 0.846)) / 2.0) / 0.95
+      district_heat.carbon_content_units = 'grams_per_megajoule'
+      district_heat.energy_content = 1.0
+      district_heat.energy_content_units = 'megajoules_per_megajoule'
+      district_heat.oxidation_factor = 1.0
+      district_heat.biogenic_fraction = 0.0
+      district_heat.physical_units = 'megajoule'
+      district_heat.save!
     end
     
     process "Calculate CO2 and CO2 biogenic emission factors" do
-      conversion_factor = (1.0 / 1_000.0) * (44.0 / 12.0) # Google: 1 kg / 1e3 g * 44 CO2 / 12 C
-      update_all(%{
-        co2_emission_factor = 1.0 * carbon_content * energy_content * oxidation_factor * (1 - biogenic_fraction) * #{conversion_factor},
-        co2_biogenic_emission_factor = 1.0 * carbon_content * energy_content * oxidation_factor * biogenic_fraction * #{conversion_factor}
+      where('carbon_content IS NOT NULL and energy_content IS NOT NULL and oxidation_factor IS NOT NULL and biogenic_fraction IS NOT NULL').update_all(%{
+        co2_emission_factor                = 1.0 * carbon_content * #{1.grams.to(:kilograms).carbon.to(:co2)} * energy_content * oxidation_factor * (1.0 - biogenic_fraction),
+        co2_emission_factor_units          = 'kilograms_per_' || physical_units,
+        co2_biogenic_emission_factor       = 1.0 * carbon_content * #{1.grams.to(:kilograms).carbon.to(:co2)} * energy_content * oxidation_factor * biogenic_fraction,
+        co2_biogenic_emission_factor_units = 'kilograms_per_' || physical_units
       })
     end
     
-    process "Update emission factor units for liquid fuels" do
-      where(:energy_content_units => 'megajoules_per_litre').update_all(
-        :co2_emission_factor_units => 'kilograms_per_litre',
-        :co2_biogenic_emission_factor_units => 'kilograms_per_litre'
-      )
-    end
-    
-    process "Update emission factor units for gaseous fuels" do
-      where(:energy_content_units => 'megajoules_per_cubic_metre').update_all(
-        :co2_emission_factor_units => 'kilograms_per_cubic_metre',
-        :co2_biogenic_emission_factor_units => 'kilograms_per_cubic_metre'
-      )
-    end
-    
     # FIXME TODO verify this stuff
   end
 end