earth 0.3.15 → 0.4.0

data/lib/earth/automobile/automobile_type_year.rb

@@ -1,6 +1,8 @@
 class AutomobileTypeYear < ActiveRecord::Base
   set_primary_key :name
   
+  has_many :type_fuel_years, :class_name => 'AutomobileTypeFuelYear', :foreign_key => 'type_year_name'
+  
   data_miner do
     tap "Brighter Planet's sanitized automobile type year data", Earth.taps_server
   end

data/lib/earth/automobile/automobile_type_year/data_miner.rb

@@ -6,6 +6,8 @@ AutomobileTypeYear.class_eval do
       integer 'year'
       float   'hfc_emissions'
       string  'hfc_emissions_units'
+      float   'hfc_emission_factor'
+      string  'hfc_emission_factor_units'
     end
     
     import "automobile type year air conditioning emissions derived from the 2010 EPA GHG Inventory",
@@ -16,10 +18,19 @@ AutomobileTypeYear.class_eval do
       store 'hfc_emissions', :units_field_name => 'hfc_emissions_units'
     end
     
+    process "Calculate HFC emission factor from AutomobileTypeFuelYear" do
+      AutomobileTypeFuelYear.run_data_miner!
+      AutomobileTypeYear.all.each do |record|
+        record.hfc_emission_factor = record.hfc_emissions / record.type_fuel_years.sum('fuel_consumption')
+        record.hfc_emission_factor_units = "kilograms_co2e_per_litre"
+        record.save
+      end
+    end
+    
     verify "Type name should never be missing" do
       AutomobileTypeYear.all.each do |record|
         value = record.send(:type_name)
-        if value.nil?
+        unless value.present?
           raise "Missing type name for AutomobileTypeYear '#{record.name}'"
         end
       end
@@ -34,20 +45,26 @@ AutomobileTypeYear.class_eval do
       end
     end
     
-    verify "HFC emissions should be zero or more" do
-      AutomobileTypeYear.all.each do |record|
-        emissions = record.send(:hfc_emissions)
-        unless emissions >= 0
-          raise "Invalid HFC emissions for AutomobileTypeYear '#{record.name}': #{emissions} (should be zero or more)"
+    %w{ hfc_emissions hfc_emission_factor }.each do |attribute|
+      verify "#{attribute.humanize} should be zero or more" do
+        AutomobileTypeYear.all.each do |record|
+          value = record.send(:"#{attribute}")
+          unless value >= 0
+            raise "Invalid #{attribute.humanize.downcase} for AutomobileTypeYear '#{record.name}': #{value} (should be zero or more)"
+          end
         end
       end
     end
     
-    verify "HFC emissions units should be kilograms CO2e" do
-      AutomobileTypeYear.all.each do |record|
-        units = record.send(:hfc_emissions_units)
-        unless units == "kilograms_co2e"
-          raise "Invalid HFC emissions units for AutomobileTypeYear '#{record.name}': #{units} (should be kilograms_co2e)"
+    [["hfc_emissions_units", "kilograms_co2e"], ["hfc_emission_factor_units", "kilograms_co2e_per_litre"]].each do |pair|
+      attribute = pair[0]
+      proper_units = pair[1]
+      verify "#{attribute.humanize} should be #{proper_units.humanize.downcase}" do
+        AutomobileTypeYear.all.each do |record|
+          units = record.send(:"#{attribute}")
+          unless units == proper_units
+            raise "Invalid #{attribute.humanize.downcase} for AutomobileTypeYear '#{record.name}': #{units} (should be #{proper_units})"
+          end
         end
       end
     end

data/lib/earth/automobile/data_miner.rb

@@ -1,3 +1,4 @@
+require 'earth/automobile/automobile_fuel/data_miner'
 require 'earth/automobile/automobile_fuel_type/data_miner'
 require 'earth/automobile/automobile_make/data_miner'
 require 'earth/automobile/automobile_make_fleet_year/data_miner'
@@ -11,4 +12,5 @@ require 'earth/automobile/automobile_type_year/data_miner'
 require 'earth/automobile/automobile_type_fuel_age/data_miner'
 require 'earth/automobile/automobile_type_fuel_control/data_miner'
 require 'earth/automobile/automobile_type_fuel_year/data_miner'
+require 'earth/automobile/automobile_type_fuel_year_age/data_miner'
 require 'earth/automobile/automobile_type_fuel_year_control/data_miner'

data/lib/earth/bus/bus_class.rb

@@ -1,14 +1,14 @@
 class BusClass < ActiveRecord::Base
   set_primary_key :name
   
-  # https://brighterplanet.sifterapp.com/projects/30/issues/454
-  falls_back_on :distance => 5.45.miles.to(:kilometres),
-                :passengers => 8.25,
-                :speed => 19.67.miles.to(:kilometres),
-                :diesel_intensity => 0.143.gallons_per_mile.to(:litres_per_kilometre),
-                :alternative_fuels_intensity => 0.0517.gallons_per_mile.to(:litres_per_kilometre),
-                :air_conditioning_emission_factor => 0.0203.pounds_per_mile.to(:kilograms_per_kilometre)
-
+  # https://spreadsheets.google.com/pub?key=0AoQJbWqPrREqdHY0R0hjZnhRaTIxTnpvRk1HNThwUmc&hl=en&output=html
+  falls_back_on :passengers => 7.485,
+                :distance => 4.9726.miles.to(:kilometres),
+                :speed => 19.849.miles.to(:kilometres),
+                :diesel_intensity => 0.13836.gallons_per_mile.to(:litres_per_kilometre),
+                :alternative_fuels_intensity => 0.04632038.gallons_per_mile.to(:litres_per_kilometre),
+                :air_conditioning_emission_factor => 0.04779 / 1.miles.to(:kilometres)
+  
   data_miner do
     tap "Brighter Planet's sanitized bus class data", Earth.taps_server
   end

data/lib/earth/computation/computation_platform/data_miner.rb

@@ -13,7 +13,7 @@ ComputationPlatform.class_eval do
     
     verify "Data center company name should never be missing" do
       ComputationPlatform.all.each do |platform|
-        if platform.data_center_company_name.nil?
+        unless platform.data_center_company_name.present?
           raise "Invalid data center company name for DataCenterCompany #{platform.name}: #{platform.data_center_company_name}"
         end
       end

data/lib/earth/computation/server_type/data_miner.rb

@@ -24,7 +24,7 @@ ServerType.class_eval do
     
     verify "Data center company name should never be missing" do
       ServerType.all.each do |server|
-        if server.data_center_company_name.nil?
+        unless server.data_center_company_name.present?
           raise "Invalid data center company name for ServerType #{server.name}: #{server.data_center_company_name}"
         end
       end

data/lib/earth/computation/server_type_alias/data_miner.rb

@@ -20,7 +20,7 @@ ServerTypeAlias.class_eval do
       ServerTypeAlias.all.each do |server_alias|
         [:server_type_name, :platform_name].each do |x|
           test_item = server_alias.send(x)
-          if test_item.nil?
+          unless test_item.present?
             raise "Invalid #{x} for ServerTypeAlias #{server_alias.name}: #{test_item}"
           end
         end

data/lib/earth/conversions_ext.rb

@@ -30,7 +30,9 @@ Conversions.register(:square_feet, :square_metres, 0.09290304)
 Conversions.register(:pounds_per_square_foot, :kilograms_per_square_metre, 4.88242764)
 Conversions.register(:kilograms_per_kilowatt_hour, :kilograms_per_megawatt_hour, 1_000.0)
 Conversions.register(:btus, :joules, 1_055.05585)
+Conversions.register(:btus, :megajoules, 0.00105505585)
 Conversions.register(:kbtus, :joules, 1_000.0 * 1_055.05585)
+Conversions.register(:kbtus, :megajoules, 1.05505585)
 Conversions.register(:cords, :joules, 2.11011171e10)
 
 Conversions.register(:gallons_per_mile, :litres_per_kilometre, 2.35214583)
@@ -43,3 +45,5 @@ Conversions.register :kilocalories_per_pound, :joules_per_kilogram, 9_224.14105
 Conversions.register :grams_per_kilocalorie, :kilograms_per_joule, 2.39005736e-7
 # 1 joule = 0.000239005736 kilocalories
 Conversions.register :joules, :kilocalories, 0.000239005736
+
+Conversions.register :carbon, :co2, (44.0 / 12.0)

data/lib/earth/fuel.rb

@@ -1,3 +1,4 @@
+require 'earth/fuel/fuel'
 require 'earth/fuel/fuel_price'
 require 'earth/fuel/fuel_type'
 require 'earth/fuel/fuel_year'

data/lib/earth/fuel/data_miner.rb

@@ -1,3 +1,4 @@
+require 'earth/fuel/fuel/data_miner'
 require 'earth/fuel/fuel_price/data_miner'
 require 'earth/fuel/fuel_type/data_miner'
 require 'earth/fuel/fuel_year/data_miner'

data/lib/earth/fuel/fuel.rb

@@ -0,0 +1,77 @@
+class Fuel < ActiveRecord::Base
+  set_primary_key :name
+  
+  has_many :fuel_years, :foreign_key => 'fuel_name'
+  
+  data_miner do
+    tap "Brighter Planet's fuels data", Earth.taps_server
+  end
+  
+  def latest_year
+    fuel_years.find_by_year(fuel_years.maximum('year'))
+  end
+  
+  def energy_content
+    if content = super
+      content
+    elsif fuel_years.present?
+      latest_year.energy_content
+    end
+  end
+  
+  def energy_content_units
+    if units = super
+      units
+    elsif fuel_years.present?
+      latest_year.energy_content_units
+    end
+  end
+  
+  def carbon_content
+    if content = super
+      content
+    elsif fuel_years.present?
+      latest_year.carbon_content
+    end
+  end
+  
+  def carbon_content_units
+    if units = super
+      units
+    elsif fuel_years.present?
+      latest_year.carbon_content_units
+    end
+  end
+  
+  def co2_emission_factor
+    if ef = super
+      ef
+    elsif fuel_years.present?
+      latest_year.co2_emission_factor
+    end
+  end
+  
+  def co2_emission_factor_units
+    if units = super
+      units
+    elsif fuel_years.present?
+      latest_year.co2_emission_factor_units
+    end
+  end
+  
+  def co2_biogenic_emission_factor
+    if ef = super
+      ef
+    elsif fuel_years.present?
+      latest_year.co2_biogenic_emission_factor
+    end
+  end
+  
+  def co2_biogenic_emission_factor_units
+    if units = super
+      units
+    elsif fuel_years.present?
+      latest_year.co2_biogenic_emission_factor_units
+    end
+  end
+end

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

@@ -0,0 +1,98 @@
+Fuel.class_eval do
+  data_miner do
+    schema Earth.database_options do
+      string 'name'
+      float  'density'
+      string 'density_units'
+      float  'energy_content'
+      string 'energy_content_units'
+      float  'carbon_content'
+      string 'carbon_content_units'
+      float  'oxidation_factor'
+      float  'biogenic_fraction'
+      float  'co2_emission_factor'
+      string 'co2_emission_factor_units'
+      float  'co2_biogenic_emission_factor'
+      string 'co2_biogenic_emission_factor_units'
+    end
+    
+    process "Derive fuel names from FuelYear" do
+      FuelYear.run_data_miner!
+      connection.execute %{
+        INSERT IGNORE INTO fuels(name)
+        SELECT DISTINCT fuel_years.fuel_name FROM fuel_years
+      }
+    end
+    
+    import "fuels with non-variable characteristics",
+           :url => 'https://spreadsheets.google.com/pub?key=0AoQJbWqPrREqdGJmYkdtajZyV3Byb0lrd21xLVhXUGc&hl=en&output=csv' do
+      key 'name'
+      store 'energy_content', :units_field_name => 'energy_content_units'
+      store 'carbon_content', :units_field_name => 'carbon_content_units'
+      store 'oxidation_factor'
+      store 'biogenic_fraction'
+    end
+    
+    import "densities for aircraft fuels",
+           :url => 'https://spreadsheets.google.com/pub?key=0AoQJbWqPrREqdHBjTVE4NmRlc05iUHVZR1E3eEJwOGc&hl=en&output=csv' do
+      key 'name'
+      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) * (1.0 / 158.987295) # Google: 1_055.05585 MJ / 1 MMBtu * 1 barrel / 158.987295 l
+      connection.execute %{
+        UPDATE fuels
+        SET energy_content = energy_content * #{conversion_factor}, energy_content_units = 'megajoules_per_litre'
+        WHERE energy_content_units = 'million_btu_per_barrel'
+      }
+    end
+    
+    process "Convert energy content of gaseous fuels to metric units" do
+      conversion_factor = (1.0 / 947.81712) * (35.3146667 / 1.0) # Google: 1.0 MJ / 947.81712 Btu * 35.3146667 cubic feet / 1 cubic m
+      connection.execute %{
+        UPDATE fuels
+        SET energy_content = energy_content * #{conversion_factor}, energy_content_units = 'megajoules_per_cubic_metre'
+        WHERE energy_content_units = 'btu_per_cubic_foot'
+      }
+    end
+    
+    process "Convert carbon content to metric units" do
+      conversion_factor = (1_000_000_000_000.0 / 1.0) * (1.0 / 1_055_055_852_620.0) # Google: 1e12 g / Tg * 1 QBtu / 1.055e12 MJ
+      connection.execute %{
+        UPDATE fuels
+        SET carbon_content = carbon_content * #{conversion_factor}, carbon_content_units = 'grams_per_megajoule'
+        WHERE carbon_content_units = 'teragrams_per_quadrillion_btu'
+      }
+    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
+      connection.execute %{
+        UPDATE fuels
+        SET co2_emission_factor = carbon_content * energy_content * oxidation_factor * (1 - biogenic_fraction) * #{conversion_factor},
+            co2_biogenic_emission_factor = carbon_content * energy_content * oxidation_factor * biogenic_fraction * #{conversion_factor}
+      }
+    end
+    
+    process "Update emission factor units for liquid fuels" do
+      connection.execute %{
+        UPDATE fuels
+        SET co2_emission_factor_units = 'kilograms_per_litre',
+            co2_biogenic_emission_factor_units = 'kilograms_per_litre'
+        WHERE energy_content_units = 'megajoules_per_litre'
+      }
+    end
+    
+    process "Update emission factor units for gaseous fuels" do
+      connection.execute %{
+        UPDATE fuels
+        SET co2_emission_factor_units = 'kilograms_per_cubic_metre',
+            co2_biogenic_emission_factor_units = 'kilograms_per_cubic_metre'
+        WHERE energy_content_units = 'megajoules_per_cubic_metre'
+      }
+    end
+    
+    # FIXME TODO verify this stuff
+  end
+end

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

@@ -3,7 +3,7 @@ FuelType.class_eval do
   # annual emissions factors
   # annual energy contents
   # gas-specific emissions factors
-
+  
   data_miner do
     schema Earth.database_options do
       string 'name'
@@ -27,7 +27,7 @@ FuelType.class_eval do
     #   Conversions.register :carbon,                                          :carbon_dioxide,              3.66666667
     # end
     
-    import "a list of fuels and their emissions factors and densities",
+    import "a list of fuels and their emission factors and densities",
            :url => 'https://spreadsheets.google.com/pub?key=0AoQJbWqPrREqdDR3RjlTcWlsLTc2TzQ0cERTMElJbHc&single=true&gid=0&output=csv' do
       key 'name', :field_name => 'fuel'
       store 'emission_factor', :units_field_name => 'emission_factor_units'

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

@@ -4,38 +4,107 @@ FuelYear.class_eval do
       string  'name'
       string  'fuel_name'
       integer 'year'
-      string  'fuel_common_name'
-      float   'carbon_content'
-      string  'carbon_content_units'
       float   'energy_content'
       string  'energy_content_units'
+      float   'carbon_content'
+      string  'carbon_content_units'
+      float   'oxidation_factor'
+      float   'biogenic_fraction'
       float   'co2_emission_factor'
       string  'co2_emission_factor_units'
+      float   'co2_biogenic_emission_factor'
+      string  'co2_biogenic_emission_factor_units'
     end
     
-    import "a list of fuel years and their carbon and energy contents, derived from the 2010 EPA GHG Inventory",
-           :url => 'https://spreadsheets.google.com/pub?key=0AoQJbWqPrREqdFZVSlZ3SUZsTzZLVTB5bVk5THdBN2c&hl=en&single=true&gid=0&output=csv' do
+    import "fuels with annually variable characteristics, derived from the 2010 EPA GHG Inventory",
+           :url => 'https://spreadsheets.google.com/pub?hl=en&hl=en&key=0AoQJbWqPrREqdFZVSlZ3SUZsTzZLVTB5bVk5THdBN2c&output=csv' do
       key 'name'
       store 'fuel_name'
       store 'year'
-      store 'fuel_common_name'
-      store 'carbon_content', :units_field_name => 'carbon_content_units'
       store 'energy_content', :units_field_name => 'energy_content_units'
+      store 'carbon_content', :units_field_name => 'carbon_content_units'
+      store 'oxidation_factor'
+      store 'biogenic_fraction'
+    end
+    
+    process "Convert energy content of solid fuels to metric units" do
+      conversion_factor = (1_055.05585 / 1.0) * (1.0 / 907.18474) # Google: 1_055.05585 MJ / 1 MMBtu * 1 short ton / 907.18474 kg
+      connection.execute %{
+        UPDATE fuel_years
+        SET energy_content = energy_content * #{conversion_factor}, energy_content_units = 'megajoules_per_kilogram'
+        WHERE energy_content_units = 'million_btu_per_short_ton'
+      }
+    end
+    
+    process "Convert energy content of liquid fuels to metric units" do
+      conversion_factor = (1_055.05585 / 1.0) * (1.0 / 158.987295) # Google: 1_055.05585 MJ / 1 MMBtu * 1 barrel / 158.987295 l
+      connection.execute %{
+        UPDATE fuel_years
+        SET energy_content = energy_content * #{conversion_factor}, energy_content_units = 'megajoules_per_litre'
+        WHERE energy_content_units = 'million_btu_per_barrel'
+      }
+    end
+    
+    process "Convert energy content of gaseous fuels to metric units" do
+      conversion_factor = (1.0 / 947.81712) * (35.3146667 / 1.0) # Google: 1.0 MJ / 947.81712 Btu * 35.3146667 cubic feet / 1 cubic m
+      connection.execute %{
+        UPDATE fuel_years
+        SET energy_content = energy_content * #{conversion_factor}, energy_content_units = 'megajoules_per_cubic_metre'
+        WHERE energy_content_units = 'btu_per_cubic_foot'
+      }
     end
     
-    process "Calculate CO2 emission factor" do
-      conversion_factor = (1000000.0 / 1000000000000000.0) * (1000000000000.0 / 1000.0) * (1.0 / 158.987295) * (44.0 / 12.0)
-      update_all "co2_emission_factor = carbon_content * energy_content * #{conversion_factor}"
-      update_all "co2_emission_factor_units = 'kilograms_per_litre'"
+    process "Convert carbon content to metric units" do
+      conversion_factor = (1_000_000_000_000.0 / 1.0) * (1.0 / 1_055_055_852_620.0) # Google: 1e12 g / Tg * 1 QBtu / 1.055e12 MJ
+      connection.execute %{
+        UPDATE fuel_years
+        SET carbon_content = carbon_content * #{conversion_factor}, carbon_content_units = 'grams_per_megajoule'
+        WHERE carbon_content_units = 'teragrams_per_quadrillion_btu'
+      }
     end
     
-    verify "Fuel name and fuel common name should never be missing" do
+    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
+      connection.execute %{
+        UPDATE fuel_years
+        SET co2_emission_factor = carbon_content * energy_content * oxidation_factor * (1 - biogenic_fraction) * #{conversion_factor},
+            co2_biogenic_emission_factor = carbon_content * energy_content * oxidation_factor * biogenic_fraction * #{conversion_factor}
+      }
+    end
+    
+    process "Update emission factor units for solid fuels" do
+      connection.execute %{
+        UPDATE fuel_years
+        SET co2_emission_factor_units = 'kilograms_per_kilogram',
+            co2_biogenic_emission_factor_units = 'kilograms_per_kilogram'
+        WHERE energy_content_units = 'megajoules_per_kilogram'
+      }
+    end
+    
+    process "Update emission factor units for liquid fuels" do
+      connection.execute %{
+        UPDATE fuel_years
+        SET co2_emission_factor_units = 'kilograms_per_litre',
+            co2_biogenic_emission_factor_units = 'kilograms_per_litre'
+        WHERE energy_content_units = 'megajoules_per_litre'
+      }
+    end
+    
+    process "Update emission factor units for gaseous fuels" do
+      connection.execute %{
+        UPDATE fuel_years
+        SET co2_emission_factor_units = 'kilograms_per_cubic_metre',
+            co2_biogenic_emission_factor_units = 'kilograms_per_cubic_metre'
+        WHERE energy_content_units = 'megajoules_per_cubic_metre'
+      }
+    end
+    
+    # FIXME TODO verify fuel name is in Fuel
+    verify "Fuel name should never be missing" do
       FuelYear.all.each do |record|
-        %w{ fuel_name fuel_common_name }.each do |attribute|
-          value = record.send(:"#{attribute}")
-          if value.nil?
-            raise "Missing #{attribute} for FuelYear '#{record.name}'"
-          end
+        fuel_name = record.send(:fuel_name)
+        if fuel_name.nil?
+          raise "Missing fuel name for FuelYear '#{record.name}'"
         end
       end
     end
@@ -49,9 +118,9 @@ FuelYear.class_eval do
       end
     end
     
-    verify "Carbon content, energy content, and CO2 emission factor should be greater than zero" do
+    verify "Carbon content and energy content should be greater than zero" do
       FuelYear.all.each do |record|
-        %w{ carbon_content energy_content co2_emission_factor }.each do |attribute|
+        %w{ carbon_content energy_content }.each do |attribute|
           value = record.send(:"#{attribute}")
           unless value > 0
             raise "Invalid #{attribute} for FuelYear '#{record.name}': #{value} (should be > 0)"
@@ -60,17 +129,17 @@ FuelYear.class_eval do
       end
     end
     
-    verify "Units should be correct" do
+    verify "Emission factors should be zero or more" do
       FuelYear.all.each do |record|
-        ["carbon_content_units teragrams_per_quadrillion_btu", "energy_content_units million_btu_per_barrel", "co2_emission_factor_units kilograms_per_litre"].each do |pair|
-          attribute = pair.split[0]
-          proper_units = pair.split[1]
-          units = record.send(:"#{attribute}")
-          unless units == proper_units
-            raise "Invalid #{attribute} for FuelYear '#{record.name}': #{units} (should be #{proper_units})"
+        %w{ co2_emission_factor co2_biogenic_emission_factor }.each do |attribute|
+          value = record.send(:"#{attribute}")
+          unless value >= 0
+            raise "Invalid #{attribute} for FuelYear '#{record.name}': #{value} (should be >= 0)"
           end
         end
       end
     end
+    
+    # FIXME TODO verify units
   end
 end