earth 1.0.3 → 1.1.0

data/lib/earth/locality/climate_division_month.rb

@@ -0,0 +1,28 @@
+require 'earth/model'
+
+require 'earth/locality/climate_division'
+
+class ClimateDivisionMonth < ActiveRecord::Base
+  extend Earth::Model
+
+  TABLE_STRUCTURE = <<-EOS
+CREATE TABLE climate_division_months
+  (
+     name                      CHARACTER VARYING(255) NOT NULL PRIMARY KEY,
+     climate_division_name     CHARACTER VARYING(255),
+     year                      INTEGER,
+     month                     INTEGER,
+     heating_degree_days       FLOAT,
+     heating_degree_days_units CHARACTER VARYING(255),
+     cooling_degree_days       FLOAT,
+     cooling_degree_days_units CHARACTER VARYING(255)
+  );
+EOS
+
+  self.primary_key = "name"
+  
+  belongs_to :climate_division, :foreign_key => 'climate_division_name'
+  
+  warn_unless_size (344 * (((Date.today.year - 2011) * 12) + (Date.today - 7).prev_month.month))
+  warn_if_any_nulls
+end

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

@@ -0,0 +1,140 @@
+ClimateDivisionMonth.class_eval do
+  # Derived from state code table in ftp://ftp.ncdc.noaa.gov/pub/data/cirs/divisional.README
+  STATE_CODES = {
+     1 => 'AL',
+     2 => 'AZ',
+     3 => 'AR',
+     4 => 'CA',
+     5 => 'CO',
+     6 => 'CT',
+     7 => 'DE',
+     8 => 'FL',
+     9 => 'GA',
+    10 => 'ID',
+    11 => 'IL',
+    12 => 'IN',
+    13 => 'IA',
+    14 => 'KS',
+    15 => 'KY',
+    16 => 'LA',
+    17 => 'ME',
+    18 => 'MD',
+    19 => 'MA',
+    20 => 'MI',
+    21 => 'MN',
+    22 => 'MS',
+    23 => 'MO',
+    24 => 'MT',
+    25 => 'NE',
+    26 => 'NV',
+    27 => 'NH',
+    28 => 'NJ',
+    29 => 'NM',
+    30 => 'NY',
+    31 => 'NC',
+    32 => 'ND',
+    33 => 'OH',
+    34 => 'OK',
+    35 => 'OR',
+    36 => 'PA',
+    37 => 'RI',
+    38 => 'SC',
+    39 => 'SD',
+    40 => 'TN',
+    41 => 'TX',
+    42 => 'UT',
+    43 => 'VT',
+    44 => 'VA',
+    45 => 'WA',
+    46 => 'WV',
+    47 => 'WI',
+    48 => 'WY'
+  }
+
+  MONTH_CODES = {
+    'jan' => 1,
+    'feb' => 2,
+    'mar' => 3,
+    'apr' => 4,
+    'may' => 5,
+    'jun' => 6,
+    'jul' => 7,
+    'aug' => 8,
+    'sep' => 9,
+    'oct' => 10,
+    'nov' => 11,
+    'dec' => 12
+  }
+
+  ::FixedWidth.define :noaa_degree_day_data do |d|
+    d.rows do |row|
+      row.trap { true } # there's only one section
+      row.column 'state_code',      2, :type => :integer
+      row.column 'division_number', 2, :type => :integer
+      row.column 'element_code',    2, :type => :integer
+      row.column 'year',            4, :type => :integer
+      row.column 'jan',             7, :type => :float # value for jan
+      row.column 'feb',             7, :type => :float # value for feb
+      row.column 'mar',             7, :type => :float # value for mar
+      row.column 'apr',             7, :type => :float # value for apr
+      row.column 'may',             7, :type => :float # value for may
+      row.column 'jun',             7, :type => :float # value for jun
+      row.column 'jul',             7, :type => :float # value for jul
+      row.column 'aug',             7, :type => :float # value for aug
+      row.column 'sep',             7, :type => :float # value for sep
+      row.column 'oct',             7, :type => :float # value for oct
+      row.column 'nov',             7, :type => :float # value for nov
+      row.column 'dec',             7, :type => :float # value for dec
+    end
+  end
+
+  class NoaaDegreeDayParser
+    def initialize(options = {})
+      # nothing
+    end
+    
+    def apply(row)
+      virtual_rows = []
+      if row['year'].to_i > 2010
+        %w{ jan feb mar apr may jun jul aug sep oct nov dec }.each do |month|
+          if row[month].to_i >= 0
+            new_row = ActiveSupport::OrderedHash.new
+            new_row['climate_division_name'] = STATE_CODES[row['state_code'].to_i] + row['division_number'].to_i.to_s
+            new_row['year'] = row['year']
+            new_row['month'] = MONTH_CODES[month]
+            new_row['name'] = new_row['climate_division_name'] + '-' + new_row['year'] + '-' + new_row['month'].to_s
+            new_row['degree_days'] = row[month]
+            virtual_rows << new_row
+          end
+        end
+      end
+      virtual_rows
+    end
+  end
+
+  data_miner do
+    import "recent NOAA NCDC climate division heating degree day data",
+           :url => 'ftp://ftp.ncdc.noaa.gov/pub/data/cirs/drd964x.hdd.txt',
+           :format => :fixed_width,
+           :schema_name => :noaa_degree_day_data,
+           :transform => { :class => NoaaDegreeDayParser } do
+      key 'name'
+      store 'climate_division_name'
+      store 'year'
+      store 'month'
+      store 'heating_degree_days', :field_name => 'degree_days', :from_units => :degrees_fahrenheit, :to_units => :degrees_celsius
+    end
+      
+    import "recent NOAA NCDC climate division cooling degree day data",
+           :url => 'ftp://ftp.ncdc.noaa.gov/pub/data/cirs/drd964x.cdd.txt',
+           :format => :fixed_width,
+           :schema_name => :noaa_degree_day_data,
+           :transform => { :class => NoaaDegreeDayParser } do
+      key 'name'
+      store 'climate_division_name'
+      store 'year'
+      store 'month'
+      store 'cooling_degree_days', :field_name => 'degree_days', :from_units => :degrees_fahrenheit, :to_units => :degrees_celsius
+    end
+  end
+end

data/lib/earth/locality/direct_normal_insolation.rb

@@ -0,0 +1,37 @@
+require 'earth/model'
+require 'earth/insolation_scopes'
+
+class DirectNormalInsolation < ActiveRecord::Base
+  extend Earth::Model
+  include Earth::InsolationScopes
+
+  TABLE_STRUCTURE = <<-EOS
+CREATE TABLE direct_normal_insolations
+  (
+     row_hash       CHARACTER VARYING(255) NOT NULL PRIMARY KEY,
+     nw_lat         FLOAT,
+     nw_lon         FLOAT,
+     se_lat         FLOAT,
+     se_lon         FLOAT,
+     jan_average    FLOAT,
+     feb_average    FLOAT,
+     mar_average    FLOAT,
+     apr_average    FLOAT,
+     may_average    FLOAT,
+     jun_average    FLOAT,
+     jul_average    FLOAT,
+     aug_average    FLOAT,
+     sep_average    FLOAT,
+     oct_average    FLOAT,
+     nov_average    FLOAT,
+     dec_average    FLOAT,
+     annual_average FLOAT,
+     units          CHARACTER VARYING(255)
+  );
+EOS
+
+  self.primary_key = 'row_hash'
+
+  warn_unless_size 90508
+  warn_if_any_nulls
+end

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

@@ -0,0 +1,41 @@
+begin
+  require 'geo_ruby'
+rescue LoadError
+  puts '[Earth] You need to install the geo_ruby gem to mine Insolation from scratch'
+  exit
+end
+begin
+  require 'dbf'
+rescue LoadError
+  puts '[Earth] You need to install the dbf gem to mine Insolation from scratch'
+  exit
+end
+require 'unix_utils'
+
+DirectNormalInsolation.class_eval do
+  data_miner do
+    import 'Direct Normal Insolation shapefile from NREL at http://www.nrel.gov/gis/data_solar.html',
+          :url => 'http://www.nrel.gov/gis/cfm/data/GIS_Data_Technology_Specific/United_States/Solar/High_Resolution/Lower_48_DNI_High_Resolution.zip',
+          :format => :shp do
+      key :row_hash
+      store 'nw_lat',         :field_name => 'upper_corner_y'
+      store 'nw_lon',         :field_name => 'upper_corner_x'
+      store 'se_lat',         :field_name => 'lower_corner_y'
+      store 'se_lon',         :field_name => 'lower_corner_x'
+      store 'jan_average',    :field_name => 'DNI01'
+      store 'feb_average',    :field_name => 'DNI02'
+      store 'mar_average',    :field_name => 'DNI03'
+      store 'apr_average',    :field_name => 'DNI04'
+      store 'may_average',    :field_name => 'DNI05'
+      store 'jun_average',    :field_name => 'DNI06'
+      store 'jul_average',    :field_name => 'DNI07'
+      store 'aug_average',    :field_name => 'DNI08'
+      store 'sep_average',    :field_name => 'DNI09'
+      store 'oct_average',    :field_name => 'DNI10'
+      store 'nov_average',    :field_name => 'DNI11'
+      store 'dec_average',    :field_name => 'DNI12'
+      store 'annual_average', :field_name => 'DNIANN'
+      store 'units', :static => 'kilowatt_hours_per_square_metre_per_day'
+    end
+  end
+end

data/lib/earth/locality/egrid_subregion.rb

@@ -50,5 +50,8 @@ EOS
                 :electricity_emission_factor_units => 'kilograms_co2e_per_kilowatt_hour'
   
   warn_unless_size 26
-  warn_if_any_nulls
+  warn_if_nulls_except(
+    :co2_biogenic_emission_factor,
+    :co2_biogenic_emission_factor_units
+  )
 end

data/lib/earth/locality/electricity_mix.rb

@@ -45,5 +45,13 @@ EOS
                 :loss_factor => 0.096 # from ecometrica paper FIXME TODO calculate this
   
   warn_unless_size 213
-  warn_if_any_nulls
+  warn_if_nulls_except(
+    :egrid_subregion_abbreviation,
+    :state_postal_abbreviation,
+    :country_iso_3166_code,
+    :co2_biogenic_emission_factor,
+    :co2_biogenic_emission_factor_units
+  )
+  warn_if_nulls /abbreviation/, :conditions => 'country_iso_3166_code IS NULL'
+  warn_if_nulls :country_iso_3166_code, :conditions => 'egrid_subregion_abbreviation IS NULL AND state_postal_abbreviation IS NULL'
 end

data/lib/earth/locality/global_horizontal_insolation.rb

@@ -0,0 +1,37 @@
+require 'earth/model'
+require 'earth/insolation_scopes'
+
+class GlobalHorizontalInsolation < ActiveRecord::Base
+  extend Earth::Model
+  include Earth::InsolationScopes
+
+  TABLE_STRUCTURE = <<-EOS
+CREATE TABLE global_horizontal_insolations
+  (
+     row_hash       CHARACTER VARYING(255) NOT NULL PRIMARY KEY,
+     nw_lat         FLOAT,
+     nw_lon         FLOAT,
+     se_lat         FLOAT,
+     se_lon         FLOAT,
+     jan_average    FLOAT,
+     feb_average    FLOAT,
+     mar_average    FLOAT,
+     apr_average    FLOAT,
+     may_average    FLOAT,
+     jun_average    FLOAT,
+     jul_average    FLOAT,
+     aug_average    FLOAT,
+     sep_average    FLOAT,
+     oct_average    FLOAT,
+     nov_average    FLOAT,
+     dec_average    FLOAT,
+     annual_average FLOAT,
+     units          CHARACTER VARYING(255)
+  );
+EOS
+
+  self.primary_key = 'row_hash'
+
+  warn_unless_size 138970
+  warn_if_any_nulls
+end

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

@@ -0,0 +1,41 @@
+begin
+  require 'geo_ruby'
+rescue LoadError
+  puts '[Earth] You need to install the geo_ruby gem to mine Insolation from scratch'
+  exit
+end
+begin
+  require 'dbf'
+rescue LoadError
+  puts '[Earth] You need to install the dbf gem to mine Insolation from scratch'
+  exit
+end
+require 'unix_utils'
+
+GlobalHorizontalInsolation.class_eval do
+  data_miner do
+    import 'Global Horizontal Insolation shapefile from NREL at http://www.nrel.gov/gis/data_solar.html',
+          :url => 'http://www.nrel.gov/gis/cfm/data/GIS_Data_Technology_Specific/United_States/Solar/High_Resolution/Lower_48_GHI_High_Resolution.zip',
+          :format => :shp do
+      key :row_hash
+      store 'nw_lat',         :field_name => 'upper_corner_y'
+      store 'nw_lon',         :field_name => 'upper_corner_x'
+      store 'se_lat',         :field_name => 'lower_corner_y'
+      store 'se_lon',         :field_name => 'lower_corner_x'
+      store 'jan_average',    :field_name => 'GHI01'
+      store 'feb_average',    :field_name => 'GHI02'
+      store 'mar_average',    :field_name => 'GHI03'
+      store 'apr_average',    :field_name => 'GHI04'
+      store 'may_average',    :field_name => 'GHI05'
+      store 'jun_average',    :field_name => 'GHI06'
+      store 'jul_average',    :field_name => 'GHI07'
+      store 'aug_average',    :field_name => 'GHI08'
+      store 'sep_average',    :field_name => 'GHI09'
+      store 'oct_average',    :field_name => 'GHI10'
+      store 'nov_average',    :field_name => 'GHI11'
+      store 'dec_average',    :field_name => 'GHI12'
+      store 'annual_average', :field_name => 'GHIANN'
+      store 'units', :static => 'kilowatt_hours_per_square_metre_per_day'
+    end
+  end
+end

data/lib/earth/locality/photovoltaic_insolation.rb

@@ -0,0 +1,37 @@
+require 'earth/model'
+require 'earth/insolation_scopes'
+
+class PhotovoltaicInsolation < ActiveRecord::Base
+  extend Earth::Model
+  include Earth::InsolationScopes
+
+  TABLE_STRUCTURE = <<-EOS
+CREATE TABLE photovoltaic_insolations
+  (
+     row_hash       CHARACTER VARYING(255) NOT NULL PRIMARY KEY,
+     nw_lat         FLOAT,
+     nw_lon         FLOAT,
+     se_lat         FLOAT,
+     se_lon         FLOAT,
+     jan_average    FLOAT,
+     feb_average    FLOAT,
+     mar_average    FLOAT,
+     apr_average    FLOAT,
+     may_average    FLOAT,
+     jun_average    FLOAT,
+     jul_average    FLOAT,
+     aug_average    FLOAT,
+     sep_average    FLOAT,
+     oct_average    FLOAT,
+     nov_average    FLOAT,
+     dec_average    FLOAT,
+     annual_average FLOAT,
+     units          CHARACTER VARYING(255)
+  );
+EOS
+
+  self.primary_key = 'row_hash'
+
+  warn_unless_size 90469
+  warn_if_any_nulls
+end

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

@@ -0,0 +1,41 @@
+begin
+  require 'geo_ruby'
+rescue LoadError
+  puts '[Earth] You need to install the geo_ruby gem to mine Insolation from scratch'
+  exit
+end
+begin
+  require 'dbf'
+rescue LoadError
+  puts '[Earth] You need to install the dbf gem to mine Insolation from scratch'
+  exit
+end
+require 'unix_utils'
+
+PhotovoltaicInsolation.class_eval do
+  data_miner do
+    import 'Photovoltaic Insolation shapefile from NREL at http://www.nrel.gov/gis/data_solar.html',
+          :url => 'http://www.nrel.gov/gis/cfm/data/GIS_Data_Technology_Specific/United_States/Solar/High_Resolution/Lower_48_LATTILT_High_Resolution.zip',
+          :format => :shp do
+      key :row_hash
+      store 'nw_lat',         :field_name => 'upper_corner_y'
+      store 'nw_lon',         :field_name => 'upper_corner_x'
+      store 'se_lat',         :field_name => 'lower_corner_y'
+      store 'se_lon',         :field_name => 'lower_corner_x'
+      store 'jan_average',    :field_name => 'JAN'
+      store 'feb_average',    :field_name => 'FEB'
+      store 'mar_average',    :field_name => 'MAR'
+      store 'apr_average',    :field_name => 'APR'
+      store 'may_average',    :field_name => 'MAY'
+      store 'jun_average',    :field_name => 'JUN'
+      store 'jul_average',    :field_name => 'JUL'
+      store 'aug_average',    :field_name => 'AUG'
+      store 'sep_average',    :field_name => 'SEP'
+      store 'oct_average',    :field_name => 'OCT'
+      store 'nov_average',    :field_name => 'NOV'
+      store 'dec_average',    :field_name => 'DEC'
+      store 'annual_average', :field_name => 'ANNUAL'
+      store 'units', :static => 'kilowatt_hours_per_square_metre_per_day'
+    end
+  end
+end

data/lib/earth/locality/zip_code.rb

@@ -1,6 +1,5 @@
 require 'earth/model'
 require 'earth/loader'
-Earth::Loader.load_plugins
 
 require 'earth/locality/climate_division'
 require 'earth/locality/country'
@@ -9,6 +8,8 @@ require 'earth/locality/state'
 require 'earth/electricity/electric_market'
 require 'earth/electricity/electric_utility'
 
+require 'geocoder'
+
 class ZipCode < ActiveRecord::Base
   data_miner do
     process "Ensure Country is imported because it's like a belongs_to association" do
@@ -17,6 +18,7 @@ class ZipCode < ActiveRecord::Base
   end
 
   extend Earth::Model
+  extend Geocoder::Model::ActiveRecord
 
   TABLE_STRUCTURE = <<-EOS
 
@@ -25,8 +27,8 @@ CREATE TABLE zip_codes
      name                         CHARACTER VARYING(255) NOT NULL PRIMARY KEY,
      state_postal_abbreviation    CHARACTER VARYING(255),
      description                  CHARACTER VARYING(255),
-     latitude                     CHARACTER VARYING(255),
-     longitude                    CHARACTER VARYING(255),
+     latitude                     FLOAT,
+     longitude                    FLOAT,
      egrid_subregion_abbreviation CHARACTER VARYING(255),
      climate_division_name        CHARACTER VARYING(255),
      population                   INTEGER
@@ -43,21 +45,13 @@ EOS
   has_many :electric_utilities, :through => :electric_markets
   
   scope :known_subregion, where('egrid_subregion_abbreviation IS NOT NULL')
-  
+
+  reverse_geocoded_by :latitude, :longitude
+
   def country
     Country.united_states
   end
-  
-  # Used by LodgingProperty custom find to find properties near to a zip code
-  def latitude_longitude
-    [latitude, longitude]
-  end
-  
-  # Used by LodgingProperty custom find to find properties near to a zip code
-  acts_as_mappable :default_units => :kilometres,
-                   :lat_column_name => :latitude,
-                   :lng_column_name => :longitude
-  
+
   warn_unless_size 43770
   warn_if_nonexistent_owner_except :egrid_subregion
 end