earth 0.11.10 → 0.11.11

data/lib/earth/locality/country.rb

@@ -3,29 +3,11 @@ require 'earth/hospitality'
 require 'earth/rail'
 
 class Country < ActiveRecord::Base
-  set_primary_key :iso_3166_code
+  self.primary_key = "iso_3166_code"
   
   has_many :rail_companies,  :foreign_key => 'country_iso_3166_code' # used to calculate rail data
   has_many :lodging_classes, :foreign_key => 'country_iso_3166_code', :class_name => 'CountryLodgingClass'
   
-  def climate_zone_number
-    if heating_degree_days and cooling_degree_days
-      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
-  end
-  
   falls_back_on :name => 'fallback',
                 :automobile_urbanity => lambda { united_states.automobile_urbanity }, # for now assume US represents world
                 :automobile_fuel_efficiency => ((22.5 + 16.2) / 2.0).miles_per_gallon.to(:kilometres_per_litre), # average of passenger car fuel unknown and light goods vehicle fuel unknown - WRI Mobile Combustion calculation tool v2.0
@@ -39,14 +21,15 @@ class Country < ActiveRecord::Base
                 :electricity_emission_factor => 0.69252, # from ecometrica paper - FIXME TODO calculate this
                 :electricity_emission_factor_units => 'kilograms_co2e_per_kilowatt_hour', # FIXME TODO derive this
                 :flight_route_inefficiency_factor => lambda { maximum(:flight_route_inefficiency_factor) }, # default to the largest inefficiency factor
+                :lodging_occupancy_rate => lambda { united_states.lodging_occupancy_rate }, # for now assume US represents world
                 :lodging_natural_gas_intensity => lambda { united_states.lodging_natural_gas_intensity }, # for now assume US represents world
                 :lodging_natural_gas_intensity_units => lambda { united_states.lodging_natural_gas_intensity_units }, # for now assume US represents world
                 :lodging_fuel_oil_intensity => lambda { united_states.lodging_fuel_oil_intensity }, # for now assume US represents world
                 :lodging_fuel_oil_intensity_units => lambda { united_states.lodging_fuel_oil_intensity_units }, # for now assume US represents world
                 :lodging_electricity_intensity => lambda { united_states.lodging_electricity_intensity }, # for now assume US represents world
                 :lodging_electricity_intensity_units => lambda { united_states.lodging_electricity_intensity_units }, # for now assume US represents world
-                :lodging_steam_intensity => lambda { united_states.lodging_steam_intensity }, # for now assume US represents world
-                :lodging_steam_intensity_units => lambda { united_states.lodging_steam_intensity_units }, # for now assume US represents world
+                :lodging_district_heat_intensity => lambda { united_states.lodging_district_heat_intensity }, # for now assume US represents world
+                :lodging_district_heat_intensity_units => lambda { united_states.lodging_district_heat_intensity_units }, # for now assume US represents world
                 :rail_trip_distance => lambda { weighted_average(:rail_trip_distance, :weighted_by => :rail_passengers) },
                 :rail_trip_distance_units => 'kilometres', # FIXME TODO derive this
                 :rail_speed => lambda { weighted_average(:rail_speed, :weighted_by => :rail_passengers) },
@@ -56,12 +39,14 @@ class Country < ActiveRecord::Base
                 :rail_trip_diesel_intensity => lambda { weighted_average(:rail_trip_diesel_intensity, :weighted_by => :rail_passengers) },
                 :rail_trip_diesel_intensity_units => 'litres_per_passenger_kilometre', # FIXME TODO derive this
                 :rail_trip_co2_emission_factor => lambda { weighted_average(:rail_trip_co2_emission_factor, :weighted_by => :rail_passengers) },
-                :rail_trip_co2_emission_factor_units => 'kilograms' # FIXME TODO derive this
+                :rail_trip_co2_emission_factor_units => 'kilograms_per_passenger_kilometre' # FIXME TODO derive this
+  
+  def self.united_states
+    find_by_iso_3166_code('US')
+  end
   
-  class << self
-    def united_states
-      find_by_iso_3166_code('US')
-    end
+  def united_states?
+    iso_3166_code == 'US'
   end
   
   col :iso_3166_code                            # alpha-2 2-letter like GB
@@ -84,14 +69,15 @@ class Country < ActiveRecord::Base
   col :electricity_emission_factor, :type => :float
   col :electricity_emission_factor_units
   col :flight_route_inefficiency_factor, :type => :float
+  col :lodging_occupancy_rate, :type => :float
   col :lodging_natural_gas_intensity, :type => :float
   col :lodging_natural_gas_intensity_units
   col :lodging_fuel_oil_intensity, :type => :float
   col :lodging_fuel_oil_intensity_units
   col :lodging_electricity_intensity, :type => :float
   col :lodging_electricity_intensity_units
-  col :lodging_steam_intensity, :type => :float
-  col :lodging_steam_intensity_units
+  col :lodging_district_heat_intensity, :type => :float
+  col :lodging_district_heat_intensity_units
   col :rail_passengers, :type => :float
   col :rail_trip_distance, :type => :float
   col :rail_trip_distance_units

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

@@ -131,6 +131,12 @@ Country.class_eval do
     end
     
     # HOSPITALITY
+    process "Define US average lodging occupancy rate" do
+      country = united_states
+      country.lodging_occupancy_rate = 0.601 # per http://www.pwc.com/us/en/press-releases/2012/pwc-us-lodging-industry-forecast.jhtml
+      country.save!
+    end
+    
     process "Ensure CountryLodgingClass is populated" do
       CountryLodgingClass.run_data_miner!
     end
@@ -144,8 +150,8 @@ Country.class_eval do
           country.lodging_fuel_oil_intensity_units = 'gallons_per_room_night' # FIXME TODO derive this
           country.lodging_electricity_intensity = country.lodging_classes.weighted_average(:electricity_intensity)
           country.lodging_electricity_intensity_units = 'kilowatt_hours_per_room_night' # FIXME TODO derive this
-          country.lodging_steam_intensity = country.lodging_classes.weighted_average(:steam_intensity)
-          country.lodging_steam_intensity_units = 'megajoules_per_room_night' # FIXME TODO derive this
+          country.lodging_district_heat_intensity = country.lodging_classes.weighted_average(:district_heat_intensity)
+          country.lodging_district_heat_intensity_units = 'megajoules_per_room_night' # FIXME TODO derive this
           country.save!
         end
       end

data/lib/earth/locality/egrid_country.rb

@@ -1,5 +1,5 @@
 class EgridCountry < ActiveRecord::Base
-  set_primary_key :name
+  self.primary_key = "name"
   
   class << self
     def us

data/lib/earth/locality/egrid_region.rb

@@ -1,11 +1,14 @@
 class EgridRegion < ActiveRecord::Base
-  set_primary_key :name
+  self.primary_key = "name"
   
+  # make EgridCountry a parent so that it automatically gets data_mined (need it for fallback calculation)
+  belongs_to :egrid_country, :foreign_key => 'country_name'
   has_many :egrid_subregions, :foreign_key => 'egrid_region_name'
   
   falls_back_on :name => 'fallback',
                 :loss_factor => lambda { (EgridCountry.us.generation + EgridCountry.us.imports - EgridCountry.us.consumption) / EgridCountry.us.generation }
   
   col :name
+  col :country_name
   col :loss_factor, :type => :float
 end

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

@@ -6,15 +6,18 @@ EgridRegion.class_eval do
            :skip => 4,
            :select => lambda { |row| row['eGRID2010 year 2007 file state sequence number'].to_i.between?(1, 51) } do
       key   'name', :field_name => 'Grid region (E=Eastern grid, W=Western grid, AK=Alaska, HI=Hawaii, TX=Texas)'
+      store 'country_name', :static => 'US'
       store 'loss_factor', :field_name => 'Year 2007 grid gross loss factor'
     end
     
-    # Need this for fallback loss_factor calculation
+    # DEPRECATED but don't remove until confirmed that all emitters use EgridRegion.fallback rather than EgridRegion.find_by_abbreviation 'US'
+    # (ElectricityUse and Meeting)
     process "Ensure EgridCountry is populated" do
       EgridCountry.run_data_miner!
     end
     
     # DEPRECATED but don't remove until confirmed that all emitters use EgridRegion.fallback rather than EgridRegion.find_by_abbreviation 'US'
+    # (ElectricityUse and Meeting)
     process "Calculate national averages" do
       us_average = find_or_create_by_name 'US'
       us_average.loss_factor = (EgridCountry.us.generation + EgridCountry.us.imports - EgridCountry.us.consumption) / EgridCountry.us.generation

data/lib/earth/locality/egrid_subregion.rb

@@ -1,6 +1,6 @@
 require 'earth/fuel'
 class EgridSubregion < ActiveRecord::Base
-  set_primary_key :abbreviation
+  self.primary_key = "abbreviation"
   
   has_many :zip_codes, :foreign_key => 'egrid_subregion_abbreviation'
   belongs_to :egrid_region, :foreign_key => 'egrid_region_name'

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

@@ -25,6 +25,7 @@ EgridSubregion.class_eval do
     end
     
     # DEPRECATED but don't remove until confirmed that all emitters use EgridSubregion.fallback rather than EgridSubregion.find_by_abbreviation 'US'
+    # (ElectricityUse and Meeting)
     process "Calculate national averages" do
       us_average = find_by_abbreviation 'US'
       subregions = where("abbreviation != 'US'")

data/lib/earth/locality/petroleum_administration_for_defense_district.rb

@@ -1,6 +1,6 @@
 class PetroleumAdministrationForDefenseDistrict < ActiveRecord::Base
-  set_primary_key :code
-  set_table_name :petroleum_districts
+  self.primary_key = "code"
+  self.table_name = :petroleum_districts
   
   def name
     str = "PAD District #{district_code} (#{district_name})"
@@ -13,4 +13,4 @@ class PetroleumAdministrationForDefenseDistrict < ActiveRecord::Base
   col :district_name
   col :subdistrict_code
   col :subdistrict_name
-end
+end

data/lib/earth/locality/state.rb

@@ -1,5 +1,5 @@
 class State < ActiveRecord::Base
-  set_primary_key :postal_abbreviation
+  self.primary_key = "postal_abbreviation"
   
   has_many :climate_divisions, :foreign_key => 'state_postal_abbreviation'
   has_many :zip_codes, :foreign_key => 'state_postal_abbreviation'
@@ -11,14 +11,9 @@ class State < ActiveRecord::Base
     Country.united_states
   end
   
-  def climate_zone_number
-    potential_zones = climate_divisions.map(&:climate_zone_number)
-    potential_zones.uniq.length == 1 ? potential_zones.first : nil
-  end
-  
   col :postal_abbreviation
   col :fips_code, :type => :integer
   col :name
-  col :census_division_number
+  col :census_division_number, :type => :integer
   col :petroleum_administration_for_defense_district_code
 end

data/lib/earth/locality/zip_code.rb

@@ -1,7 +1,7 @@
 require ::File.join(Earth.vendor_dir, 'geokit-rails', 'lib', 'geokit-rails')
 
 class ZipCode < ActiveRecord::Base
-  set_primary_key :name
+  self.primary_key = "name"
   
   belongs_to :egrid_subregion,  :foreign_key => 'egrid_subregion_abbreviation'
   belongs_to :climate_division, :foreign_key => 'climate_division_name'

data/lib/earth/pet/breed.rb

@@ -1,5 +1,5 @@
 class Breed < ActiveRecord::Base
-  set_primary_key :name
+  self.primary_key = "name"
   
   has_many :breed_genders, :foreign_key => 'breed_name'
   belongs_to :species, :foreign_key => 'species_name'
@@ -8,4 +8,4 @@ class Breed < ActiveRecord::Base
   col :species_name
   col :weight, :type => :float
   col :weight_units
-end
+end

data/lib/earth/pet/breed_gender.rb

@@ -1,5 +1,5 @@
 class BreedGender < ActiveRecord::Base
-  set_primary_key :name
+  self.primary_key = "name"
   
   belongs_to :breed, :foreign_key => 'breed_name'
   belongs_to :gender, :foreign_key => 'gender_name'
@@ -9,4 +9,4 @@ class BreedGender < ActiveRecord::Base
   col :gender_name
   col :weight, :type => :float
   col :weight_units
-end
+end

data/lib/earth/pet/gender.rb

@@ -1,7 +1,7 @@
 class Gender < ActiveRecord::Base
-  set_primary_key :name
+  self.primary_key = "name"
   
   has_many :breed_genders, :foreign_key => 'gender_name'
   
   col :name
-end
+end

data/lib/earth/pet/species.rb

@@ -1,5 +1,5 @@
 class Species < ActiveRecord::Base
-  set_primary_key :name
+  self.primary_key = "name"
   
   col :name
   col :population, :type => :integer
@@ -55,4 +55,4 @@ class Species < ActiveRecord::Base
   def cat?
     eql? self.class[:cat]
   end
-end
+end

data/lib/earth/pet/species/data_miner.rb

@@ -1,14 +1,5 @@
 Species.class_eval do
   data_miner do
-    process "Define some unit conversions" do
-      # 1 (kilocalories per pound) = 9 224.14105 joules per kilogram
-      Conversions.register :kilocalories_per_pound, :joules_per_kilogram, 9_224.14105
-      # 1 (grams per kilocalories) = 2.39005736 × 10-7 kilograms per joules
-      Conversions.register :grams_per_kilocalorie, :kilograms_per_joule, 2.39005736e-7
-      # 1 joule = 0.000239005736 kilocalories
-      Conversions.register :joules, :kilocalories, 0.000239005736
-    end
-    
     import "a list of pet species weights, dietary requirements, and diet emissions intensities",
            :url => 'http://static.brighterplanet.com/science/data/consumables/pets/species.csv' do
       key 'name', :field_name => 'species'

data/lib/earth/rail/country_rail_class.rb

@@ -1,6 +1,6 @@
 require 'earth/locality'
 class CountryRailClass < ActiveRecord::Base
-  set_primary_key :name
+  self.primary_key = "name"
   
   col :name
   col :country_iso_3166_code

data/lib/earth/rail/country_rail_traction.rb

@@ -1,7 +1,7 @@
 require 'earth/fuel'
 require 'earth/locality'
 class CountryRailTraction < ActiveRecord::Base
-  set_primary_key :name
+  self.primary_key = "name"
   
   col :name
   col :country_iso_3166_code

data/lib/earth/rail/country_rail_traction_class.rb

@@ -1,7 +1,7 @@
 require 'earth/fuel'
 require 'earth/locality'
 class CountryRailTractionClass < ActiveRecord::Base
-  set_primary_key :name
+  self.primary_key = "name"
   
   col :name
   col :country_iso_3166_code

data/lib/earth/rail/national_transit_database_company.rb

@@ -1,7 +1,7 @@
 require 'earth/locality'
 class NationalTransitDatabaseCompany < ActiveRecord::Base
-  set_primary_key :id
-  set_table_name :ntd_companies
+  self.primary_key = "id"
+  self.table_name = :ntd_companies
   
   has_many :ntd_records, :foreign_key => 'company_id', :primary_key => 'id', :class_name => 'NationalTransitDatabaseRecord'
   

data/lib/earth/rail/national_transit_database_mode.rb

@@ -1,6 +1,6 @@
 class NationalTransitDatabaseMode < ActiveRecord::Base
-  set_primary_key :code
-  set_table_name :ntd_modes
+  self.primary_key = "code"
+  self.table_name = :ntd_modes
   
   def self.rail_modes
     where(:rail_mode => true)

data/lib/earth/rail/national_transit_database_record.rb

@@ -1,7 +1,7 @@
 require 'earth/fuel'
 class NationalTransitDatabaseRecord < ActiveRecord::Base
-  set_primary_key :name
-  set_table_name :ntd_records
+  self.primary_key = "name"
+  self.table_name = :ntd_records
   
   belongs_to :ntd_company, :foreign_key => 'company_id', :class_name => 'NationalTransitDatabaseCompany'
   

data/lib/earth/rail/national_transit_database_record/data_miner.rb

@@ -7,49 +7,28 @@ NationalTransitDatabaseRecord.class_eval do
       store 'company_id', :field_name => 'trs_id'
       store 'mode_code'
       store 'service_type',       :field_name => 'service_code', :dictionary => { :input => 'code', :output => 'name', :url => 'https://docs.google.com/spreadsheet/pub?key=0AoQJbWqPrREqdDBTZENxb3A1SzJaNTVEVGZ5cTdaMVE&output=csv' }
-      store 'vehicle_distance',   :field_name => 'vehicle_or_train_revenue_miles', :units => 'miles'
+      store 'vehicle_distance',   :field_name => 'vehicle_or_train_revenue_miles', :from_units => :miles, :to_units => :kilometres
       store 'vehicle_time',       :field_name => 'vehicle_or_train_revenue_hours', :units => 'hours'
-      store 'passenger_distance', :field_name => 'passenger_miles',                :units => 'miles'
+      store 'passenger_distance', :field_name => 'passenger_miles',                :from_units => :miles, :to_units => :kilometres
       store 'passengers'
     end
     
-    # FIXME TODO electricity synthesization should return NULL rather than 0
     import "US National Transit Database fuel consumption data",
            :url => 'https://docs.google.com/spreadsheet/pub?key=0AoQJbWqPrREqdDItVVR5NjA2Y3FCVjgza25Ccy0zS2c&output=csv' do
       key 'name', :synthesize => lambda { |row| [row['trs_id'], row['mode_code'], row['service_code']].join(' ') }
       store 'company_id', :field_name => 'trs_id'
       store 'mode_code'
       store 'service_type', :field_name => 'service_code', :dictionary => { :input => 'code', :output => 'name', :url => 'https://docs.google.com/spreadsheet/pub?key=0AoQJbWqPrREqdDBTZENxb3A1SzJaNTVEVGZ5cTdaMVE&output=csv' }
-      store 'electricity',  :synthesize => lambda { |row| row['electricity_kwh'].to_f + row['battery_kwh'].to_f }, :units => 'kilowatt_hours', :nullify => true
-      store 'diesel',       :field_name => 'diesel_gallons',    :units => 'gallons', :nullify => true
-      store 'gasoline',     :field_name => 'gasoline_gallons',  :units => 'gallons', :nullify => true
-      store 'lpg',          :field_name => 'lpg_gallons',       :units => 'gallons', :nullify => true
-      store 'lng',          :field_name => 'lng_gallons',       :units => 'gallons', :nullify => true
-      store 'cng',          :field_name => 'cng_gallons',       :units => 'gallons', :nullify => true
-      store 'kerosene',     :field_name => 'kerosene_gallons',  :units => 'gallons', :nullify => true
-      store 'biodiesel',    :field_name => 'biodiesel_gallons', :units => 'gallons', :nullify => true
-      store 'other_fuel',                                                            :nullify => true
-      store 'other_fuel_description', :field_name => 'other_fuel_description',       :nullify => true
-    end
-    
-    process "Convert miles to kilometres" do
-      conversion_factor = 1.miles.to(:kilometres)
-      %w{ vehicle_distance passenger_distance }.each do |field|
-        where("#{field}_units" => 'miles').update_all(%{
-          #{field} = 1.0 * #{field} * #{conversion_factor},
-          #{field}_units = 'kilometres'
-        })
-      end
-    end
-      
-    process "Convert gallons to litres" do
-      conversion_factor = 1.gallons.to(:litres)
-      %w{ diesel gasoline lpg lng cng kerosene biodiesel }.each do |fuel|
-        where("#{fuel}_units" => 'gallons').update_all(%{
-          #{fuel} = 1.0 * #{fuel} * #{conversion_factor},
-          #{fuel}_units = 'litres'
-        })
-      end
+      store 'electricity',  :synthesize => lambda { |row| row['electricity_kwh'].to_f + row['battery_kwh'].to_f }, :units => 'kilowatt_hours'
+      store 'diesel',       :field_name => 'diesel_gallons',    :from_units => :gallons, :to_units => :litres
+      store 'gasoline',     :field_name => 'gasoline_gallons',  :from_units => :gallons, :to_units => :litres
+      store 'lpg',          :field_name => 'lpg_gallons',       :from_units => :gallons, :to_units => :litres
+      store 'lng',          :field_name => 'lng_gallons',       :from_units => :gallons, :to_units => :litres
+      store 'cng',          :field_name => 'cng_gallons',       :from_units => :gallons, :to_units => :litres
+      store 'kerosene',     :field_name => 'kerosene_gallons',  :from_units => :gallons, :to_units => :litres
+      store 'biodiesel',    :field_name => 'biodiesel_gallons', :from_units => :gallons, :to_units => :litres
+      store 'other_fuel'
+      store 'other_fuel_description', :field_name => 'other_fuel_description'
     end
   end
 end

data/lib/earth/rail/rail_class.rb

@@ -1,5 +1,5 @@
 class RailClass < ActiveRecord::Base
-  set_primary_key :name
+  self.primary_key = "name"
   
   col :name
 end

data/lib/earth/rail/rail_company.rb

@@ -1,7 +1,7 @@
 require 'earth/fuel'
 require 'earth/locality'
 class RailCompany < ActiveRecord::Base
-  set_primary_key :name
+  self.primary_key = "name"
   
   belongs_to :country, :foreign_key => 'country_iso_3166_code'
   

data/lib/earth/rail/rail_company_traction.rb

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

data/lib/earth/rail/rail_company_traction_class.rb

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