earth 0.0.18

data/lib/earth/locality/zip_code.rb

@@ -0,0 +1,29 @@
+class ZipCode < ActiveRecord::Base
+  set_primary_key :name
+  
+  belongs_to :egrid_subregion, :foreign_key => 'egrid_subregion_abbreviation'
+  belongs_to :climate_division, :foreign_key => 'climate_division_name'
+  belongs_to :state, :foreign_key => 'state_postal_abbreviation'
+#  has_one :census_division, :through => :state
+#  has_one :census_region, :through => :state
+  has_many :residences
+
+  
+  acts_as_mappable :default_units => :miles,  # FIXME imperial
+                   :lat_column_name => :latitude,
+                   :lng_column_name => :longitude
+
+  def set_latitude_and_longitude
+    return if latitude.present? and longitude.present?
+    a = Geokit::Geocoders::YahooGeocoder.geocode name
+    update_attributes! :latitude => a.lat, :longitude => a.lng
+  end
+  
+  data_miner do
+    tap "Brighter Planet's sanitized zip codes", Earth.taps_server
+    
+    process "pull dependencies" do
+      run_data_miner_on_belongs_to_associations
+    end
+  end
+end

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

@@ -0,0 +1,36 @@
+ZipCode.class_eval do
+  data_miner do
+    schema Earth.database_options do
+      string   'name'
+      string   'state_postal_abbreviation'
+      string   'description'
+      string   'latitude'
+      string   'longitude'
+      string   'egrid_subregion_abbreviation'
+      string   'climate_division_name'
+    end
+    
+    import 'the Mapping Hacks zipcode database',
+           :url => 'http://mappinghacks.com/data/zipcode.zip',
+           :filename => 'zipcode.csv' do
+      key   'name', :field_name => 'zip', :sprintf => '%05d'
+      store 'state_postal_abbreviation', :field_name => 'state'
+      store 'description', :field_name => 'city'
+      store 'latitude'
+      store 'longitude'
+    end
+    
+    import 'a list of zipcodes and eGRID Subregions',
+           :url => 'http://static.brighterplanet.com/science/data/electricity/egrid/models_export/zip_subregions.csv' do
+      key   'name', :field_name => 'zip', :sprintf => '%05d'
+      store 'egrid_subregion_abbreviation', :field_name => 'primary_subregion'
+    end
+    
+    import 'a list of zipcodes and Climate Divisions',
+           :url => 'http://static.brighterplanet.com/science/data/geography/zip_code_name-climate_division_name.csv' do
+      key   'name', :field_name => 'zip_code_name', :sprintf => '%05d'
+      store 'climate_division_name'
+    end
+  end
+end
+

data/lib/earth/pet.rb

@@ -0,0 +1,4 @@
+require 'earth/pet/breed'
+require 'earth/pet/breed_gender'
+require 'earth/pet/gender'
+require 'earth/pet/species'

data/lib/earth/pet/breed.rb

@@ -0,0 +1,15 @@
+class Breed < ActiveRecord::Base
+  set_primary_key :name
+  
+  has_many :pets, :foreign_key => 'breed_id'
+  has_many :breed_genders, :foreign_key => 'breed_name'
+  belongs_to :species, :foreign_key => 'species_name'
+  
+  data_miner do
+    tap "Brighter Planet's breed data", Earth.taps_server
+
+    process "pull dependencies" do
+      run_data_miner_on_belongs_to_associations
+    end
+  end
+end

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

@@ -0,0 +1,25 @@
+Breed.class_eval do
+  data_miner do
+    schema Earth.database_options do
+      string   'name'
+      string  'species_name'
+      float    'weight'
+      string   'weight_units'
+    end
+    
+    import "Brighter Planet's list of cat and dog breeds",
+           :url => 'http://static.brighterplanet.com/science/data/consumables/pets/breed_genders.csv',
+           :encoding => 'ISO-8859-1',
+           :select => lambda { |row| row['gender'].blank? } do
+      key 'name'
+      store 'species_name', :field_name => 'species'
+      store 'weight', :from_units => :pounds, :to_units => :kilograms
+    end
+    
+    import "a list of horse breeds", :url => 'http://www.freebase.com/type/exporttypeinstances/base/horses/horse_breed?page=0&filter_mode=type&filter_view=table&show%01p%3D%2Ftype%2Fobject%2Fname%01index=0&show%01p%3D%2Fcommon%2Ftopic%2Fimage%01index=1&show%01p%3D%2Fcommon%2Ftopic%2Farticle%01index=2&sort%01p%3D%2Ftype%2Fobject%2Ftype%01p%3Dlink%01p%3D%2Ftype%2Flink%2Ftimestamp%01index=false&=&exporttype=csv-8' do
+      key 'name'
+      store 'species_name', :static => 'horse'
+    end
+  end
+end
+

data/lib/earth/pet/breed_gender.rb

@@ -0,0 +1,14 @@
+class BreedGender < ActiveRecord::Base
+  set_primary_key :name
+  
+  belongs_to :breed, :foreign_key => 'breed_name'
+  belongs_to :gender, :foreign_key => 'gender_name'
+  
+  data_miner do
+    tap "Brighter Planet's breed gender data", Earth.taps_server
+
+    process "pull dependencies" do
+      run_data_miner_on_belongs_to_associations
+    end
+  end
+end

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

@@ -0,0 +1,21 @@
+BreedGender.class_eval do
+  data_miner do
+    schema Earth.database_options do
+      string   'name'
+      string   'breed_name'
+      string   'gender_name'
+      float    'weight'
+      string   'weight_units'
+    end
+    
+    import "Brighter Planet's list of cat and dog breeds, genders, and weights",
+           :url => 'http://static.brighterplanet.com/science/data/consumables/pets/breed_genders.csv',
+           :select => lambda { |row| row['gender'].present? } do
+      key 'name', :synthesize => lambda { |row| row['name'] + ' ' + row['gender'] }
+      store 'breed_name', :field_name => 'name'
+      store 'gender_name', :field_name => 'gender'
+      store 'weight', :from_units => :pounds, :to_units => :kilograms
+    end
+  end
+end
+

data/lib/earth/pet/data_miner.rb

@@ -0,0 +1,4 @@
+require 'earth/pet/breed/data_miner'
+require 'earth/pet/breed_gender/data_miner'
+require 'earth/pet/gender/data_miner'
+require 'earth/pet/species/data_miner'

data/lib/earth/pet/gender.rb

@@ -0,0 +1,10 @@
+class Gender < ActiveRecord::Base
+  set_primary_key :name
+  
+  has_many :pets
+  has_many :breed_genders, :foreign_key => 'gender_name'
+  
+  data_miner do
+    tap "Brighter Planet's gender info", Earth.taps_server
+  end
+end

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

@@ -0,0 +1,13 @@
+Gender.class_eval do
+  data_miner do
+    schema Earth.database_options do
+      string 'name'
+    end
+    import "a list of genders derived from pet breed genders",
+           :url => 'http://static.brighterplanet.com/science/data/consumables/pets/breed_genders.csv',
+           :select => lambda { |row| row['gender'].present? } do
+      key 'name', :field_name => 'gender'
+    end
+  end
+end
+

data/lib/earth/pet/species.rb

@@ -0,0 +1,40 @@
+class Species < ActiveRecord::Base
+  set_primary_key :name
+  
+  has_many :pets
+  
+  scope :thoroughly_researched, :conditions => 'marginal_dietary_requirement IS NOT NULL'
+  
+  falls_back_on :diet_emission_intensity => lambda { weighted_average :diet_emission_intensity, :weighted_by => :population }, # kg CO2 / joule
+                :marginal_dietary_requirement => lambda { (thoroughly_researched.map(&:weighted_diet_size).sum / thoroughly_researched.sum(:population) ) / thoroughly_researched.weighted_average(:weight, :weighted_by => :population)}, # joules
+                :fixed_dietary_requirement => 0, # force a zero intercept to be respectful of our tiny tiny animal friends
+                :weight => lambda { weighted_average :weight, :weighted_by => :population } # kg
+
+  data_miner do
+    tap "Brighter Planet's species data", Earth.taps_server
+  end
+  
+  class << self
+    def [](name)
+      find_by_name name.to_s
+    end
+  end
+  
+  def diet_size
+    return unless weight and marginal_dietary_requirement and fixed_dietary_requirement
+    weight * marginal_dietary_requirement + fixed_dietary_requirement
+  end
+  
+  def weighted_diet_size
+    return unless _diet_size = diet_size and _population = population
+    _diet_size * _population
+  end
+  
+  def to_s
+    name
+  end
+  
+  def cat?
+    eql? self.class[:cat]
+  end
+end

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

@@ -0,0 +1,42 @@
+Species.class_eval do
+  data_miner do
+    schema Earth.database_options do
+      string   'name'
+      integer  'population'
+      float    'diet_emission_intensity'
+      string   'diet_emission_intensity_units'
+      float    'weight'
+      string   'weight_units'
+      float    'marginal_dietary_requirement'
+      string   'marginal_dietary_requirement_units'
+      float    'fixed_dietary_requirement'
+      string   'fixed_dietary_requirement_units'
+      float    'minimum_weight'
+      string   'minimum_weight_units'
+      float    'maximum_weight'
+      string   'maximum_weight_units'
+    end
+    
+    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'
+      store 'population'
+      store 'weight', :from_units => :pounds, :to_units => :kilograms
+      store 'marginal_dietary_requirement', :from_units => :kilocalories_per_pound, :to_units => :joules_per_kilogram
+      store 'fixed_dietary_requirement', :from_units => :kilocalories, :to_units => :joules
+      store 'diet_emission_intensity', :from_units => :grams_per_kilocalorie, :to_units => :kilograms_per_joule
+      store 'minimum_weight', :from_units => :pounds, :to_units => :kilograms
+      store 'maximum_weight', :from_units => :pounds, :to_units => :kilograms
+    end
+  end
+end
+

data/lib/earth/rail.rb

@@ -0,0 +1 @@
+require 'earth/rail/rail_class'

data/lib/earth/rail/data_miner.rb

@@ -0,0 +1 @@
+require 'earth/rail/rail_class/data_miner'

data/lib/earth/rail/rail_class.rb

@@ -0,0 +1,16 @@
+class RailClass < ActiveRecord::Base
+  set_primary_key :name
+  
+  has_many :rail_trips
+
+  data_miner do
+    tap "Brighter Planet's rail class data", Earth.taps_server
+  end
+  
+  # speed is missing
+  # https://brighterplanet.sifterapp.com/projects/30/issues/455
+  falls_back_on :passengers => 25.06,
+                :distance => 8.57.miles.to(:kilometres),
+                :diesel_intensity => 0.05.gallons_per_mile.to(:litres_per_kilometre),
+                :electricity_intensity => 8.89.miles.to(:kilometres)
+end

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

@@ -0,0 +1,36 @@
+RailClass.class_eval do
+  data_miner do
+    schema Earth.database_options do
+      string 'name'
+      float  'distance'
+      string 'distance_units'
+      float  'passengers'
+      float  'speed'
+      string 'speed_units'
+      float  'duration'
+      string 'duration_units'
+      float  'electricity_intensity'
+      string 'electricity_intensity_units'
+      float  'diesel_intensity'
+      string 'diesel_intensity_units'
+      string 'description'
+    end
+    
+    process "Define some unit conversions" do
+      Conversions.register :gallons_per_mile, :litres_per_kilometre, 2.35214583
+    end
+
+    import "a list of rail classes and pre-calculated trip and fuel use characteristics",
+           :url => 'http://static.brighterplanet.com/science/data/transport/rail/rail_classes.csv' do
+      key   'name'
+      store 'description'
+      store 'distance', :from_units => :miles, :to_units => :kilometres
+      store 'speed', :from_units => :miles, :to_units => :kilometres
+      store 'duration'
+      store 'passengers'
+      store 'electricity_intensity', :field_name => 'electricity_per_vehicle_mile', :from_units => :miles, :to_units => :kilometres
+      store 'diesel_intensity', :field_name => 'diesel_per_vehicle_mile', :from_units => :gallons_per_mile, :to_units => :litres_per_kilometre
+    end
+  end
+end
+

data/lib/earth/residence.rb

@@ -0,0 +1,8 @@
+require 'earth/residence/air_conditioner_use'
+require 'earth/residence/clothes_machine_use'
+require 'earth/residence/dishwasher_use'
+require 'earth/residence/residence_appliance'
+require 'earth/residence/residence_class'
+require 'earth/residence/residence_fuel_price'
+require 'earth/residence/residence_fuel_type'
+require 'earth/residence/residential_energy_consumption_survey_response'

data/lib/earth/residence/air_conditioner_use.rb

@@ -0,0 +1,30 @@
+class AirConditionerUse < ActiveRecord::Base
+  set_primary_key :name
+  
+  has_many :residences
+  has_many :residential_energy_consumption_survey_responses
+
+  falls_back_on :fugitive_emission => 0.102295.pounds_per_square_foot.to(:kilograms_per_square_metre), # https://brighterplanet.sifterapp.com/projects/30/issues/430
+                :fugitive_emission_units => 'kilograms_per_square_metre'
+  
+  data_miner do
+    schema do
+      string 'name'
+      float 'fugitive_emission'
+      string 'fugitive_emission_units'
+    end
+
+    process "derive from ResidentialEnergyConsumptionSurveyResponse" do
+      ResidentialEnergyConsumptionSurveyResponse.run_data_miner!
+      connection.execute %{
+        INSERT IGNORE INTO air_conditioner_uses(name)
+        SELECT DISTINCT residential_energy_consumption_survey_responses.central_ac_use FROM residential_energy_consumption_survey_responses WHERE LENGTH(residential_energy_consumption_survey_responses.central_ac_use) > 0
+      }
+    end
+    
+    import "Ian's precalculated fugitive emissions values", :url => 'http://spreadsheets.google.com/pub?key=ri_380yQZAqBKeqie_TECgg' do
+      key 'name', :field_name => 'air_conditioner_use_name'
+      store 'fugitive_emission', :units_field_name => 'unit', :to_units => :kilograms_per_square_metre
+    end
+  end
+end

data/lib/earth/residence/air_conditioner_use/data_miner.rb

@@ -0,0 +1,4 @@
+AirConditionerUse.class_eval do
+#  data_miner do
+#...
+end

data/lib/earth/residence/clothes_machine_use.rb

@@ -0,0 +1,33 @@
+class ClothesMachineUse < ActiveRecord::Base
+  set_primary_key :name
+  
+  has_many :residences
+  has_many :residential_energy_consumption_survey_responses
+
+  data_miner do
+    schema do
+      string 'name'
+      float  'annual_energy_from_electricity_for_clothes_driers'
+      string 'annual_energy_from_electricity_for_clothes_driers_units'
+    end
+
+    process "derive from ResidentialEnergyConsumptionSurveyResponse" do
+      ResidentialEnergyConsumptionSurveyResponse.run_data_miner!
+      connection.execute %{
+        INSERT IGNORE INTO clothes_machine_uses(name)
+        SELECT DISTINCT residential_energy_consumption_survey_responses.clothes_washer_use FROM residential_energy_consumption_survey_responses WHERE LENGTH(residential_energy_consumption_survey_responses.clothes_washer_use) > 0
+      }
+    end
+
+    # sabshere 5/20/10 weird that this uses cohort
+    process "precalculate annual energy use" do
+      find_in_batches do |batch|
+        batch.each do |record|
+          record.annual_energy_from_electricity_for_clothes_driers = ResidentialEnergyConsumptionSurveyResponse.big_cohort(:clothes_machine_use => record).weighted_average :annual_energy_from_electricity_for_clothes_driers
+          record.annual_energy_from_electricity_for_clothes_driers_units = 'joules'
+          record.save!
+        end
+      end
+    end
+  end
+end

data/lib/earth/residence/clothes_machine_use/data_miner.rb

@@ -0,0 +1,4 @@
+ClothesMachineUse.class_eval do
+#  data_miner do
+#...
+end

data/lib/earth/residence/data_miner.rb

@@ -0,0 +1,8 @@
+require 'earth/residence/air_conditioner_use/data_miner'
+require 'earth/residence/clothes_machine_use/data_miner'
+require 'earth/residence/dishwasher_use/data_miner'
+require 'earth/residence/residence_appliance/data_miner'
+require 'earth/residence/residence_class/data_miner'
+require 'earth/residence/residence_fuel_price/data_miner'
+require 'earth/residence/residence_fuel_type/data_miner'
+require 'earth/residence/residential_energy_consumption_survey_response/data_miner'

data/lib/earth/residence/dishwasher_use.rb

@@ -0,0 +1,33 @@
+class DishwasherUse < ActiveRecord::Base
+  set_primary_key :name
+  
+  has_many :residences
+  has_many :residential_energy_consumption_survey_responses
+
+  data_miner do
+    schema do
+      string 'name'
+      float 'annual_energy_from_electricity_for_dishwashers'
+      string 'annual_energy_from_electricity_for_dishwashers_units'
+    end
+    
+    process "derive from ResidentialEnergyConsumptionSurveyResponse" do
+      ResidentialEnergyConsumptionSurveyResponse.run_data_miner!
+      connection.execute %{
+        INSERT IGNORE INTO dishwasher_uses(name)
+        SELECT DISTINCT residential_energy_consumption_survey_responses.dishwasher_use_id FROM residential_energy_consumption_survey_responses WHERE LENGTH(residential_energy_consumption_survey_responses.dishwasher_use_id) > 0
+      }
+    end
+    
+    # sabshere 5/25/10 weird that this uses cohort
+    process "precalculate annual energy" do
+      find_in_batches do |batch|
+        batch.each do |record|
+          record.annual_energy_from_electricity_for_dishwashers = ResidentialEnergyConsumptionSurveyResponse.big_cohort(:dishwasher_use => record).weighted_average :annual_energy_from_electricity_for_dishwashers
+          record.annual_energy_from_electricity_for_dishwashers_units = 'joules'
+          record.save!
+        end
+      end
+    end
+  end
+end