earth 0.4.0 → 0.4.1

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

@@ -3,89 +3,142 @@ EgridSubregion.class_eval do
     schema Earth.database_options do
       string 'abbreviation'
       string 'name'
-      float  'electricity_emission_factor'
-      string 'electricity_emission_factor_units'
       string 'nerc_abbreviation'
       string 'egrid_region_name'
+      float  'net_generation'
+      string 'net_generation_units'
+      float  'electricity_co2_emission_factor'
+      string 'electricity_co2_emission_factor_units'
+      float  'electricity_co2_biogenic_emission_factor'
+      string 'electricity_co2_biogenic_emission_factor_units'
+      float  'electricity_ch4_emission_factor'
+      string 'electricity_ch4_emission_factor_units'
+      float  'electricity_n2o_emission_factor'
+      string 'electricity_n2o_emission_factor_units'
+      float  'electricity_emission_factor'
+      string 'electricity_emission_factor_units'
     end
     
-    # process "define some unit conversions" do
-    #   Conversions.register :pounds_per_megawatt_hour, :kilograms_per_kilowatt_hour, 0.00045359237
-    #   Conversions.register :pounds_per_gigawatt_hour, :kilograms_per_kilowatt_hour, 0.00000045359237
-    # end
-    # 
-    # NOTE: the following import uses an 18 Mb zip - don't know if two imports will cause it to be downloaded twice...
-    # 
+    # FIXME TODO for some reason this doesn't work...
     # import "eGRID regions and electricity emission factors derived from eGRID 2007 data",
     #        :url => 'http://www.epa.gov/cleanenergy/documents/egridzips/eGRID2007_Version1-1.zip',
-    #        :filename => 'eGRID2007V1_1_year05_aggregation.xls',
+    #        :filename => 'eGRID2007_Version1-1/eGRID2007V1_1_year05_aggregation.xls',
     #        :sheet => 'SRL05',
     #        :skip => 3,
     #        :select => lambda { |row| row['eGRID2007 2005 file eGRID subregion location (operator)-based sequence number'].to_i.between?(1, 26) } do
     #   key   'abbreviation', :field_name => 'eGRID subregion acronym'
     #   store 'name', :field_name => 'eGRID subregion name associated with eGRID subregion acronym'
     #   store 'nerc_abbreviation', :field_name => 'NERC region acronym associated with the eGRID subregion acronym'
-    #   store 'electricity_ef_co2', :field_name => 'eGRID subregion annual CO2 output emission rate (lb/MWh)', :from_units => :pounds_per_megawatt_hour, :to_units => :kilograms_per_kilowatt_hour
-    #   store 'electricity_ef_ch4', :field_name => 'eGRID subregion annual CH4 output emission rate (lb/GWh)', :from_units => :pounds_per_gigawatt_hour, :to_units => :kilograms_per_kilowatt_hour
-    #   store 'electricity_ef_n2o', :field_name => 'eGRID subregion annual N2O output emission rate (lb/GWh)', :from_units => :pounds_per_gigawatt_hour, :to_units => :kilograms_per_kilowatt_hour
-    # end
-    # 
-    # import "US average electricity emission factors derived from eGRID 2007 data",
-    #        :url => 'http://www.epa.gov/cleanenergy/documents/egridzips/eGRID2007_Version1-1.zip',
-    #        :filename => 'eGRID2007V1_1_year05_aggregation.xls',
-    #        :sheet => 'US05',
-    #        :skip => 3,
-    #        :select => lambda { |row| row['eGRID2007 2005 file US sequence number'].to_i.is?(1) } do
-    #   key   # the single row should be keyed 'US'
-    #   store 'name' # the single row should be named 'United States Average'
-    #   store 'electricity_ef_co2', :field_name => 'US annual CO2 output emission rate (lb/MWh)', :from_units => :pounds_per_megawatt_hour, :to_units => :kilograms_per_kilowatt_hour
-    #   store 'electricity_ef_ch4', :field_name => 'US annual CH4 output emission rate (lb/GWh)', :from_units => :pounds_per_gigawatt_hour, :to_units => :kilograms_per_kilowatt_hour
-    #   store 'electricity_ef_n2o', :field_name => 'US annual N2O output emission rate (lb/GWh)', :from_units => :pounds_per_gigawatt_hour, :to_units => :kilograms_per_kilowatt_hour
-    # end
-    # 
-    # import "the eGRID regions associated with each subregion" do
-    #        :url => 'https://spreadsheets.google.com/pub?key=0AoQJbWqPrREqdGRORTJNSWRMQ1puRVprYlAtZHhDaFE&hl=en&single=true&gid=0&output=csv' do
-    #   key 'abbreviation'
-    #   store 'egrid_region_name'
-    # end
-    # 
-    # process "Calculate CO2e emission factor"
-    #   # multiply each gas ef by the gas GWP and sum
+    #   store 'net_generation', :field_name => 'eGRID subregion annual net generation (MWh)', :units => 'megawatt_hours'
+    #   store 'electricity_co2_emission_factor', :field_name => 'eGRID subregion annual CO2 output emission rate (lb/MWh)', :units => 'pounds_per_megawatt_hour'
+    #   store 'electricity_co2_biogenic_emission_factor', :static => '0.0', :units => 'kilograms_per_kilowatt_hour'
+    #   store 'electricity_ch4_emission_factor', :field_name => 'eGRID subregion annual CH4 output emission rate (lb/GWh)', :units => 'pounds_per_gigawatt_hour'
+    #   store 'electricity_n2o_emission_factor', :field_name => 'eGRID subregion annual N2O output emission rate (lb/GWh)', :units => 'pounds_per_gigawatt_hour'
     # end
     
-    import "a list of eGRID subregions and emissions factors derived from eGRID 2007 data",
-           :url => 'https://spreadsheets.google.com/pub?key=0AoQJbWqPrREqdGRORTJNSWRMQ1puRVprYlAtZHhDaFE&hl=en&single=true&gid=0&output=csv' do
-      key   'abbreviation'
+    import "eGRID subregion data",
+           :url => 'https://spreadsheets.google.com/pub?key=0AoQJbWqPrREqdGRORTJNSWRMQ1puRVprYlAtZHhDaFE&hl=en&single=true&gid=0&output=csv',
+           :select => lambda { |row| row['abbreviation'].length == 4 } do
+      key 'abbreviation'
       store 'name'
       store 'nerc_abbreviation'
       store 'egrid_region_name'
-      store 'electricity_emission_factor', :units_field_name => 'electricity_emission_factor_units'
+      store 'net_generation', :units => 'megawatt_hours'
+      store 'electricity_co2_emission_factor', :field_name => 'electricty_ef_co2', :units => 'pounds_per_megawatt_hour'
+      store 'electricity_co2_biogenic_emission_factor', :static => '0.0', :units => 'kilograms_per_kilowatt_hour'
+      store 'electricity_ch4_emission_factor', :field_name => 'electricity_ef_ch4',  :units => 'pounds_per_gigawatt_hour'
+      store 'electricity_n2o_emission_factor', :field_name => 'electricity_ef_n2o',  :units => 'pounds_per_gigawatt_hour'
     end
     
-    # FIXME TODO make this work
-    # verify "eGRID region name should appear in egrid_regions" do
-    #   regions = EgridRegion.all.map { |region| region.name }
-    #   EgridSubregion.all.each do |subregion|
-    #     unless regions.includes? subregion.egrid_region_name
-    #       raise "Invalid eGRID region name for EgridSubregion #{subregion.name}: #{subregion.egrid_region_name} (not found in egrid_regions)"
-    #     end
-    #   end
-    # end
+    process "Convert co2 emission factor to metric units" do
+      conversion_factor = 1.pounds.to(:kilograms) * 1.0 / 1_000.0 # kg / lbs * MWh / kWh
+      update_all %{ electricity_co2_emission_factor = electricity_co2_emission_factor * #{conversion_factor},
+                    electricity_co2_emission_factor_units = 'kilograms_per_kilowatt_hour'
+                    WHERE electricity_co2_emission_factor_units = 'pounds_per_megawatt_hour' }
+    end
     
-    verify "Electricity emission factor should be greater than zero" do
-      EgridSubregion.all.each do |subregion|
-        unless subregion.electricity_emission_factor > 0
-          raise "Invalid electricity emission factor for EgridSubregion #{subregion.name}: #{subregion.electricity_emission_factor} (should be > 0)"
+    process "Insure necessary datasets are imported" do
+      GreenhouseGas.run_data_miner!
+    end
+    
+    process "Convert ch4 emission factor to metric units and co2e" do
+      conversion_factor = 1.pounds.to(:kilograms) * 1.0 / 1_000_000.0 # kg / lbs * GWh / kWh
+      gwp = GreenhouseGas[:ch4].global_warming_potential
+      update_all %{ electricity_ch4_emission_factor = electricity_ch4_emission_factor * #{conversion_factor} * #{gwp},
+                    electricity_ch4_emission_factor_units = 'kilograms_co2e_per_kilowatt_hour'
+                    WHERE electricity_ch4_emission_factor_units = 'pounds_per_gigawatt_hour' }
+    end
+    
+    process "Convert n2o emission factor to metric units and co2e" do
+      conversion_factor = 1.pounds.to(:kilograms) * 1.0 / 1_000_000.0 # kg / lbs * GWh / kWh
+      gwp = GreenhouseGas[:n2o].global_warming_potential
+      update_all %{ electricity_n2o_emission_factor = electricity_n2o_emission_factor * #{conversion_factor} * #{gwp},
+                    electricity_n2o_emission_factor_units = 'kilograms_co2e_per_kilowatt_hour'
+                    WHERE electricity_n2o_emission_factor_units = 'pounds_per_gigawatt_hour' }
+    end
+    
+    process "Calculate combined emission factor" do
+      update_all %{ electricity_emission_factor = electricity_co2_emission_factor + electricity_ch4_emission_factor + electricity_n2o_emission_factor,
+                    electricity_emission_factor_units = 'kilograms_co2e_per_kilowatt_hour' }
+    end
+    
+    # FIXME TODO verify egrid_region_name is found in EgridRegions
+    %w{ egrid_region_name }.each do |attribute|
+      verify "#{attribute.humanize} should never be missing" do
+        EgridSubregion.all.each do |subregion|
+          unless subregion.send("#{attribute}").present?
+            puts "Missing #{attribute.humanize.downcase} for EgridSubregion #{subregion.name}"
+            fail
+          end
         end
       end
     end
     
-    verify "Electricity emission factor units should be kilograms co2e per kilowatt hour" do
+    ["net_generation",
+     "electricity_co2_emission_factor",
+     "electricity_ch4_emission_factor",
+     "electricity_n2o_emission_factor",
+     "electricity_emission_factor" ].each do |attribute|
+      verify "#{attribute.humanize} should be > 0" do
+        EgridSubregion.all.each do |subregion|
+          value = subregion.send(:"#{attribute}")
+          unless value > 0
+            puts "Invalid #{attribute.humanize.downcase} for EgridSubregion #{subregion.name}: #{value} (should be > 0)"
+            fail
+          end
+        end
+      end
+    end
+    
+    verify "Electricity co2 biogenic emission factor should be 0" do
       EgridSubregion.all.each do |subregion|
-        unless subregion.electricity_emission_factor_units == "kilograms_co2e_per_kilowatt_hour"
-          raise "Invalid electricity emission factor units for EgridSubregion #{subregion.name}: #{subregion.electricity_emission_factor_units} (should be kilograms_co2e_per_kilowatt_hour)"
+        value = subregion.electricity_co2_biogenic_emission_factor
+        unless value == 0
+          puts "Invalid electricity co2 biogenic emission factor for EgridSubregion #{subregion.name}: #{value} (should be 0)"
+          fail
         end
       end
     end
+    
+    [["net_generation_units","megawatt_hours"],
+     ["electricity_co2_emission_factor_units","kilograms_per_kilowatt_hour"],
+     ["electricity_co2_biogenic_emission_factor_units","kilograms_per_kilowatt_hour"],
+     ["electricity_ch4_emission_factor_units","kilograms_co2e_per_kilowatt_hour"],
+     ["electricity_n2o_emission_factor_units","kilograms_co2e_per_kilowatt_hour"],
+     ["electricity_emission_factor_units","kilograms_co2e_per_kilowatt_hour"]].each do |pair|
+      attribute = pair[0]
+      proper_units = pair[1]
+      verify "#{attribute.humanize} should be #{proper_units.humanize.downcase}" do
+        EgridSubregion.all.each do |subregion|
+          units = subregion.send(:"#{attribute}")
+          unless units == proper_units
+            puts "Invalid #{attribute.humanize.downcase} for EgridSubregion #{subregion.name}: #{units} (should be #{proper_units})"
+            fail
+          end
+        end
+      end
+    end
+    
+    # FIXME TODO verify fallbacks
   end
 end

data/spec/earth/automobile/automobile_fuel_spec.rb

@@ -3,17 +3,14 @@ require 'earth/automobile'
 require 'earth/automobile/data_miner'
 
 describe AutomobileFuel do
-  before :all do
-    AutomobileFuel.run_data_miner!
+  describe 'import', :slow => true do
+    it 'should import data without problems' do
+      AutomobileFuel.run_data_miner!
+      AutomobileFuel.all.count.should > 0
+    end
+    
+    it 'correctly assigns hfc_emission_factor' do
+      AutomobileFuel.first.hfc_emission_factor.should == 0.0
+    end
   end
-  
-  it 'imports data without problems' do
-    AutomobileFuel.all.count.should > 0
-  end
-  # it 'correctly assigns hfc_emission_factor' do
-  #   AutomobileTypeFuelAge.run_data_miner!
-  #   AutomobileTypeFuelYear.run_data_miner!
-  #   AutomobileTypeYear.run_data_miner!
-  #   AutomobileFuel.first.hfc_emission_factor.should == 0.0
-  # end
 end

data/spec/earth/bus/bus_class_spec.rb

@@ -0,0 +1,12 @@
+require 'spec_helper'
+
+describe 'BusFuel' do
+  before :all do
+    Earth.init :bus, :fuel, :apply_schemas => true
+  end
+
+  it 'is related to fuels' do
+    BusFuel.run_data_miner!
+    BusFuel.last.fuel.should_not be_nil
+  end
+end

data/spec/earth/bus/bus_fuel_control_spec.rb

@@ -0,0 +1,12 @@
+require 'spec_helper'
+
+describe 'BusFuelControl' do
+  before :all do
+    Earth.init :bus, :fuel, :apply_schemas => true
+  end
+
+  it 'imports successfully' do
+    BusFuelControl.run_data_miner!
+    BusFuelControl.all.count.should > 0
+  end
+end

data/spec/earth/bus/bus_fuel_year_control_spec.rb

@@ -0,0 +1,16 @@
+require 'spec_helper'
+
+describe 'BusFuelYearControl' do
+  before :all do
+    Earth.init :bus, :fuel, :apply_schemas => true
+  end
+  
+  it 'imports successfully' do
+    BusFuelYearControl.run_data_miner!
+    BusFuelYearControl.all.count.should > 0
+  end
+  
+  it 'is related to BusFuelControl' do
+    BusFuelYearControl.first.control.should_not be_nil
+  end
+end

data/spec/earth/pet/species_spec.rb

@@ -11,4 +11,3 @@ describe 'Species' do
     end
   end
 end
-

data/spec/earth_spec.rb

@@ -27,7 +27,7 @@ describe Earth do
   describe '.resources' do
     it 'should get a list of resources' do
       resources = Earth.resources
-      resources.keys.count.should == 74
+      resources.keys.count.should == 77
       resources['FuelType'][:domain].should == 'fuel'
     end
     it 'should exclude data_miner files' do
@@ -37,7 +37,7 @@ describe Earth do
 
   describe '.resource_names' do
     it 'should get a list of all resource names' do
-      Earth.resource_names.count.should == 74
+      Earth.resource_names.count.should == 77
       Earth.resource_names.should include('Aircraft')
       Earth.resource_names.should include('Industry')
     end

metadata

@@ -1,12 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: earth
 version: !ruby/object:Gem::Version 
+  hash: 13
   prerelease: false
   segments: 
   - 0
   - 4
-  - 0
-  version: 0.4.0
+  - 1
+  version: 0.4.1
 platform: ruby
 authors: 
 - Seamus Abshere
@@ -16,167 +17,178 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-02-17 00:00:00 -05:00
+date: 2011-02-21 00:00:00 -08:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: activerecord
+  prerelease: false
   requirement: &id001 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ~>
       - !ruby/object:Gem::Version 
+        hash: 5
         segments: 
         - 3
         version: "3"
   type: :runtime
-  prerelease: false
   version_requirements: *id001
 - !ruby/object:Gem::Dependency 
   name: data_miner
+  prerelease: false
   requirement: &id002 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ~>
       - !ruby/object:Gem::Version 
+        hash: 17
         segments: 
         - 1
         - 1
         - 1
         version: 1.1.1
   type: :runtime
-  prerelease: false
   version_requirements: *id002
 - !ruby/object:Gem::Dependency 
   name: errata
+  prerelease: false
   requirement: &id003 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
+        hash: 3
         segments: 
         - 0
         version: "0"
   type: :runtime
-  prerelease: false
   version_requirements: *id003
 - !ruby/object:Gem::Dependency 
   name: falls_back_on
+  prerelease: false
   requirement: &id004 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
+        hash: 25
         segments: 
         - 0
         - 0
         - 3
         version: 0.0.3
   type: :runtime
-  prerelease: false
   version_requirements: *id004
 - !ruby/object:Gem::Dependency 
   name: geokit
+  prerelease: false
   requirement: &id005 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
+        hash: 3
         segments: 
         - 1
         - 5
         - 0
         version: 1.5.0
   type: :runtime
-  prerelease: false
   version_requirements: *id005
 - !ruby/object:Gem::Dependency 
   name: geokit-rails
+  prerelease: false
   requirement: &id006 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
+        hash: 3
         segments: 
         - 0
         version: "0"
   type: :runtime
-  prerelease: false
   version_requirements: *id006
 - !ruby/object:Gem::Dependency 
   name: cohort_scope
+  prerelease: false
   requirement: &id007 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
+        hash: 17
         segments: 
         - 0
         - 0
         - 7
         version: 0.0.7
   type: :runtime
-  prerelease: false
   version_requirements: *id007
 - !ruby/object:Gem::Dependency 
   name: conversions
+  prerelease: false
   requirement: &id008 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
+        hash: 13
         segments: 
         - 1
         - 4
         - 5
         version: 1.4.5
   type: :runtime
-  prerelease: false
   version_requirements: *id008
 - !ruby/object:Gem::Dependency 
   name: weighted_average
+  prerelease: false
   requirement: &id009 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
+        hash: 23
         segments: 
         - 0
         - 0
         - 4
         version: 0.0.4
   type: :runtime
-  prerelease: false
   version_requirements: *id009
 - !ruby/object:Gem::Dependency 
   name: loose_tight_dictionary
+  prerelease: false
   requirement: &id010 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
+        hash: 15
         segments: 
         - 0
         - 0
         - 8
         version: 0.0.8
   type: :runtime
-  prerelease: false
   version_requirements: *id010
 - !ruby/object:Gem::Dependency 
   name: sniff
+  prerelease: false
   requirement: &id011 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ~>
       - !ruby/object:Gem::Version 
+        hash: 5
         segments: 
         - 0
         - 6
         - 1
         version: 0.6.1
   type: :development
-  prerelease: false
   version_requirements: *id011
 description: An earth-simulation environment with ActiveRecord models and data
 email: andy@rossmeissl.net
@@ -214,6 +226,7 @@ files:
 - features/automobile_type_fuel_year_control.feature
 - features/automobile_type_year.feature
 - features/bus_class.feature
+- features/bus_fuel.feature
 - features/carrier.feature
 - features/carrier_mode.feature
 - features/computation_platform.feature
@@ -262,6 +275,8 @@ files:
 - features/support/imports/automobile_type_year_good.csv
 - features/support/imports/bus_class_bad.csv
 - features/support/imports/bus_class_good.csv
+- features/support/imports/bus_fuel_bad.csv
+- features/support/imports/bus_fuel_good.csv
 - features/support/imports/carrier_bad.csv
 - features/support/imports/carrier_good.csv
 - features/support/imports/carrier_mode_bad.csv
@@ -349,6 +364,12 @@ files:
 - lib/earth/bus.rb
 - lib/earth/bus/bus_class.rb
 - lib/earth/bus/bus_class/data_miner.rb
+- lib/earth/bus/bus_fuel.rb
+- lib/earth/bus/bus_fuel/data_miner.rb
+- lib/earth/bus/bus_fuel_control.rb
+- lib/earth/bus/bus_fuel_control/data_miner.rb
+- lib/earth/bus/bus_fuel_year_control.rb
+- lib/earth/bus/bus_fuel_year_control/data_miner.rb
 - lib/earth/bus/data_miner.rb
 - lib/earth/computation.rb
 - lib/earth/computation/computation_platform.rb
@@ -461,6 +482,9 @@ files:
 - lib/earth/version.rb
 - spec/earth/air/aircraft_spec.rb
 - spec/earth/automobile/automobile_fuel_spec.rb
+- spec/earth/bus/bus_class_spec.rb
+- spec/earth/bus/bus_fuel_control_spec.rb
+- spec/earth/bus/bus_fuel_year_control_spec.rb
 - spec/earth/pet/species_spec.rb
 - spec/earth_spec.rb
 - spec/spec_helper.rb
@@ -520,7 +544,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
-      hash: -3794272341704170348
+      hash: 3
       segments: 
       - 0
       version: "0"
@@ -529,7 +553,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
-      hash: -3794272341704170348
+      hash: 3
       segments: 
       - 0
       version: "0"
@@ -558,6 +582,7 @@ test_files:
 - features/automobile_type_fuel_year_control.feature
 - features/automobile_type_year.feature
 - features/bus_class.feature
+- features/bus_fuel.feature
 - features/carrier.feature
 - features/carrier_mode.feature
 - features/computation_platform.feature
@@ -606,6 +631,8 @@ test_files:
 - features/support/imports/automobile_type_year_good.csv
 - features/support/imports/bus_class_bad.csv
 - features/support/imports/bus_class_good.csv
+- features/support/imports/bus_fuel_bad.csv
+- features/support/imports/bus_fuel_good.csv
 - features/support/imports/carrier_bad.csv
 - features/support/imports/carrier_good.csv
 - features/support/imports/carrier_mode_bad.csv
@@ -634,6 +661,9 @@ test_files:
 - features/support/imports/shipment_mode_good.csv
 - spec/earth/air/aircraft_spec.rb
 - spec/earth/automobile/automobile_fuel_spec.rb
+- spec/earth/bus/bus_class_spec.rb
+- spec/earth/bus/bus_fuel_control_spec.rb
+- spec/earth/bus/bus_fuel_year_control_spec.rb
 - spec/earth/pet/species_spec.rb
 - spec/earth_spec.rb
 - spec/spec_helper.rb