simple_metar_parser 0.0.0

data/lib/simple_metar_parser/metar/base.rb

@@ -0,0 +1,24 @@
+module SimpleMetarParser
+  class Base
+
+    def initialize(_parent)
+      @parent = _parent
+      reset
+    end
+
+    attr_reader :parent
+
+    def reset
+      # implement
+    end
+
+    def decode_split(s)
+      # implement
+    end
+
+    def post_process
+      # implement
+    end
+
+  end
+end

data/lib/simple_metar_parser/metar/clouds.rb

@@ -0,0 +1,81 @@
+$:.unshift(File.dirname(__FILE__))
+
+module SimpleMetarParser
+  class Clouds < Base
+
+    # Cloud level - clear sky
+    CLOUD_CLEAR = (0 * 100.0 / 8.0).round
+    # Cloud level - few clouds
+    CLOUD_FEW = (1.5 * 100.0 / 8.0).round
+    #Cloud level - scattered
+    CLOUD_SCATTERED = (3.5 * 100.0 / 8.0).round
+    #Cloud level - broken
+    CLOUD_BROKEN = (6 * 100.0 / 8.0).round
+    #Cloud level - overcast
+    CLOUD_OVERCAST = (8 * 100.0 / 8.0).round
+    #Cloud level - not significant
+    CLOUD_NOT_SIGN = (0.5 * 100.0 / 8.0).round
+
+    def reset
+      @clouds = Array.new
+      @clouds_max = nil
+    end
+
+    attr_reader :clouds, :clouds_max
+
+    def decode_split(s)
+      if s =~ /^(SKC|FEW|SCT|BKN|OVC|NSC)(\d{3}?)$/
+        cl = case $1
+               when "SKC" then
+                 CLOUD_CLEAR
+               when "FEW" then
+                 CLOUD_FEW
+               when "SCT" then
+                 CLOUD_SCATTERED
+               when "BKN" then
+                 CLOUD_BROKEN
+               when "OVC" then
+                 CLOUD_OVERCAST
+               when "NSC" then
+                 CLOUD_NOT_SIGN
+               else
+                 CLOUD_CLEAR
+             end
+
+        cloud = {
+          :coverage => cl
+        }
+        # optionally cloud bottom
+        unless '' == $2.to_s
+          cloud[:bottom] = $2.to_i * 30
+        end
+
+        @clouds << cloud
+        @clouds.uniq!
+      end
+
+      # obscured by clouds, vertical visibility
+      if s =~ /^(VV)(\d{3}?)$/
+        @clouds << {
+          :coverage => CLOUD_OVERCAST,
+          :vertical_visibility => $2.to_i * 30
+        }
+
+        @clouds.uniq!
+      end
+
+      if s =~ /^(CAVOK)$/
+        # everything is awesome :)
+      end
+
+    end
+
+    # Calculate numeric description of clouds
+    def post_process
+      @clouds_max = 0
+      @clouds.each do |c|
+        @clouds_max = c[:coverage] if @clouds_max < c[:coverage]
+      end
+    end
+  end
+end

data/lib/simple_metar_parser/metar/metar_city.rb

@@ -0,0 +1,36 @@
+$:.unshift(File.dirname(__FILE__))
+
+module SimpleMetarParser
+  class MetarCity < Base
+
+    # You can set AR model for fetching additional information about city
+    def self.rails_model=(klass)
+      @@rails_model_class = klass
+    end
+
+    # Get city information using AR
+    def self.find_by_metar(metar)
+      return nil if not defined? @@rails_model_class or @@rails_model_class.nil?
+      @@rails_model_class.find_by_metar(metar)
+    end
+
+    def reset
+      @code = nil
+      @model = nil
+    end
+
+    def decode_split(s)
+      if s =~ /^([A-Z]{4})$/ and not s == 'AUTO' and not s == 'GRID' and not s == 'WNDS'
+        @code = $1
+        @model = self.class.find_by_metar(@code)
+      end
+    end
+
+    # Addition city information fetched using AR
+    attr_reader :model
+
+    # Metar code of city
+    attr_reader :code
+
+  end
+end

data/lib/simple_metar_parser/metar/metar_other.rb

@@ -0,0 +1,27 @@
+$:.unshift(File.dirname(__FILE__))
+
+module SimpleMetarParser
+  class MetarOther < Base
+
+    def reset
+      @station = nil
+      @station_auto = false
+    end
+
+    attr_reader :station, :station_auto
+
+    def decode_split(s)
+      if s.strip == 'AO1'
+        @station = :auto_without_precipitation
+      elsif s.strip == 'A02'
+        @station = :auto_with_precipitation
+      end
+
+      # fully automated station
+      if s.strip == 'AUTO'
+        @station_auto = true
+      end
+
+    end
+  end
+end

data/lib/simple_metar_parser/metar/metar_specials.rb

@@ -0,0 +1,210 @@
+$:.unshift(File.dirname(__FILE__))
+
+module SimpleMetarParser
+  class MetarSpecials < Base
+
+    # description http://www.ofcm.gov/fmh-1/pdf/H-CH8.pdf
+
+    def reset
+      @specials = Array.new
+    end
+
+    attr_reader :specials
+
+    attr_reader :snow_metar
+
+    attr_reader :rain_metar
+
+    def decode_split(s)
+      decode_specials(s)
+    end
+
+    # Calculate numeric description of clouds
+    def post_process
+      calculate_rain_and_snow
+    end
+
+    def decode_specials(s)
+      if s =~ /^(VC|\-|\+|\b)(MI|PR|BC|DR|BL|SH|TS|FZ|)(DZ|RA|SN|SG|IC|PE|GR|GS|UP|)(BR|FG|FU|VA|DU|SA|HZ|PY|)(PO|SQ|FC|SS|)$/
+        intensity = case $1
+                      when "VC" then
+                        "in the vicinity"
+                      when "+" then
+                        "heavy"
+                      when "-" then
+                        "light"
+                      else
+                        "moderate"
+                    end
+
+        descriptor = case $2
+                       when "MI" then
+                         "shallow"
+                       when "PR" then
+                         "partial"
+                       when "BC" then
+                         "patches"
+                       when "DR" then
+                         "low drifting"
+                       when "BL" then
+                         "blowing"
+                       when "SH" then
+                         "shower"
+                       when "TS" then
+                         "thunderstorm"
+                       when "FZ" then
+                         "freezing"
+                       else
+                         nil
+                     end
+
+        precipitation = case $3
+                          when "DZ" then
+                            "drizzle"
+                          when "RA" then
+                            "rain"
+                          when "SN" then
+                            "snow"
+                          when "SG" then
+                            "snow grains"
+                          when "IC" then
+                            "ice crystals"
+                          when "PE" then
+                            "ice pellets"
+                          when "GR" then
+                            "hail"
+                          when "GS" then
+                            "small hail/snow pellets"
+                          when "UP" then
+                            "unknown"
+                          else
+                            nil
+                        end
+
+        obscuration = case $4
+                        when "BR" then
+                          "mist"
+                        when "FG" then
+                          "fog"
+                        when "FU" then
+                          "smoke"
+                        when "VA" then
+                          "volcanic ash"
+                        when "DU" then
+                          "dust"
+                        when "SA" then
+                          "sand"
+                        when "HZ" then
+                          "haze"
+                        when "PY" then
+                          "spray"
+                        else
+                          nil
+                      end
+
+        misc = case $5
+                 when "PO" then
+                   "dust whirls"
+                 when "SQ" then
+                   "squalls"
+                 #when "FC " then "funnel cloud/tornado/waterspout"
+                 when "FC" then
+                   "funnel cloud/tornado/waterspout"
+                 when "SS" then
+                   "duststorm"
+                 else
+                   nil
+               end
+
+        # when no sensible data do nothing
+        return if descriptor.nil? and precipitation.nil? and obscuration.nil? and misc.nil?
+
+        @specials << {
+          :intensity => intensity,
+          :intensity_raw => $1,
+          :descriptor => descriptor,
+          :descriptor_raw => $2,
+          :precipitation => precipitation,
+          :precipitation_raw => $3,
+          :obscuration => obscuration,
+          :obscuration_raw => $4,
+          :misc => misc,
+          :misc_raw => $5
+        }
+
+      end
+    end
+
+    # Calculate precipitation in self defined units and aproximated real world units
+    def calculate_rain_and_snow
+      @snow_metar = 0
+      @rain_metar = 0
+
+      self.specials.each do |s|
+        new_rain = 0
+        new_snow = 0
+        coefficient = 1
+        case s[:precipitation]
+          when 'drizzle' then
+            new_rain = 5
+
+          when 'rain' then
+            new_rain = 10
+
+          when 'snow' then
+            new_snow = 10
+
+          when 'snow grains' then
+            new_snow = 5
+
+          when 'ice crystals' then
+            new_snow = 1
+            new_rain = 1
+
+          when 'ice pellets' then
+            new_snow = 2
+            new_rain = 2
+
+          when 'hail' then
+            new_snow = 3
+            new_rain = 3
+
+          when 'small hail/snow pellets' then
+            new_snow = 1
+            new_rain = 1
+        end
+
+        case s[:intensity]
+          when 'in the vicinity' then
+            coefficient = 1.5
+          when 'heavy' then
+            coefficient = 3
+          when 'light' then
+            coefficient = 0.5
+          when 'moderate' then
+            coefficient = 1
+        end
+
+        snow = new_snow * coefficient
+        rain = new_rain * coefficient
+
+        if @snow_metar < snow
+          @snow_metar = snow
+        end
+        if @rain_metar < rain
+          @rain_metar = rain
+        end
+
+      end
+
+      # http://www.ofcm.gov/fmh-1/pdf/H-CH8.pdf page 3
+      # 10 units means more than 0.3 (I assume 0.5) inch per hour, so:
+      # 10 units => 0.5 * 25.4mm
+      real_world_coefficient = 0.5 * 25.4 / 10.0
+
+      @snow_metar *= real_world_coefficient
+      @rain_metar *= real_world_coefficient
+    end
+
+  end
+end

data/lib/simple_metar_parser/metar/metar_time.rb

@@ -0,0 +1,40 @@
+$:.unshift(File.dirname(__FILE__))
+
+module SimpleMetarParser
+  class MetarTime < Base
+
+    def year
+      self.parent.year
+    end
+
+    def month
+      self.parent.month
+    end
+
+    def reset
+      @time = nil
+    end
+
+    def decode_split(s)
+      if s =~ /(\d{2})(\d{2})(\d{2})Z/
+        @time = Time.utc(self.year, self.month, $1.to_i, $2.to_i, $3.to_i, 0, 0)
+      end
+    end
+
+    # Time "from"
+    attr_reader :time
+    alias :time_from :time
+
+    # Interval of one metar
+    def time_interval
+      self.parent.options[:time_interval]
+    end
+
+    # End of time period
+    def time_to
+      self.time_from + self.time_interval
+    end
+
+
+  end
+end

data/lib/simple_metar_parser/metar/pressure.rb

@@ -0,0 +1,52 @@
+$:.unshift(File.dirname(__FILE__))
+
+module SimpleMetarParser
+  class Pressure < Base
+
+    HG_INCH_TO_HPA = 1013.0/2992.1
+    HG_MM_TO_HPA = HG_INCH_TO_HPA * 25.4
+
+    def reset
+      @pressure = nil
+    end
+
+    attr_reader :pressure
+
+    def decode_split(s)
+      # Europe
+      if s =~ /Q(\d{4})/
+        @pressure = $1.to_i
+      end
+      # US
+      if s =~ /A(\d{4})/
+        #1013 hPa = 29.921 inNg
+        @pressure=(($1.to_f) * HG_INCH_TO_HPA).round
+      end
+    end
+
+    def pressure_hg_mm
+      return nil if self.pressure.nil?
+      (@pressure / HG_MM_TO_HPA).round
+    end
+
+    def pressure_hg_inch
+      (@pressure / HG_INCH_TO_HPA).round
+    end
+
+    # Pressure in hPa
+    def hpa
+      self.pressure
+    end
+
+    # mm of Hg
+    def hg_mm
+      self.pressure_hg_mm
+    end
+
+    # inches of Hg
+    def hg_inch
+      self.pressure_hg_inch
+    end
+
+  end
+end