solar_noon 1.0.0.pre

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 3260bd1d603d32f6ec25343d8f31795927477ea5
+  data.tar.gz: bbe6dd0b6c42ad966086e72306e6ec3fde22ca37
+SHA512:
+  metadata.gz: 22704c71e0126483011ef41172aa47de5d84df7cf12f2252b53ef16a327e988fc478eba046bdb506981a88ffe1d75f19281444d85dfe3af3dbbbe596bc008aba
+  data.tar.gz: 55576a3bca8a30caa861e7064c94d533d309de4f3ba814783b53bad9681ee661bcae1e5a365bbc94221eb669dc7ca0788e466c9bcf1f9a9d9fe04deef8eca8d6

data/.gitignore

@@ -0,0 +1,4 @@
+*.gem
+.bundle
+Gemfile.lock
+pkg/*

data/.ruby-version

@@ -0,0 +1 @@
+2.0.0

data/Gemfile

@@ -0,0 +1,2 @@
+source "https://rubygems.org"
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2013 Jason Roth
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,4 @@
+Solar Noon Calculator
+=====================
+
+Based on the [NOAA solar noon calculator](http://www.esrl.noaa.gov/gmd/grad/solcalc/).

data/Rakefile

@@ -0,0 +1,7 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new do |t|
+  t.libs << "test"
+  t.test_files = FileList['test/**/*_test.rb']
+end

data/lib/solar_noon.rb

@@ -0,0 +1,21 @@
+require File.expand_path('../solar_noon/calculator', __FILE__)
+
+module SolarNoon
+  module Extensions
+    def solar_noon(longitude)
+      SolarNoon::Calculator.new(self).calculate(longitude)
+    end
+  end
+end
+
+class Date
+  include SolarNoon::Extensions
+end
+
+class DateTime
+  include SolarNoon::Extensions
+end
+
+class Time
+  include SolarNoon::Extensions
+end

data/lib/solar_noon/calculator.rb

@@ -0,0 +1,116 @@
+require 'date'
+
+module SolarNoon
+
+  class Calculator
+
+    attr_reader :date
+
+    def initialize(date)
+      @date = date.to_datetime
+    end
+
+    # Calculate noon for a given date at a given longitude
+    # Takes a Date, DateTime or Time and returns a Time instance at solar noon
+    # for that day. Time returned is UTC; to get local time call `getlocal on the
+    # result.
+    def calculate(longitude)
+      raise ArgumentError.new "Invalid longitude" unless -180.0 <= longitude && longitude <= 180.0
+
+      eq_time = true_solar_time_diff_mean_solar_time
+
+      minutes = 720 - (longitude * 4) - eq_time # in minutes
+
+      # Returned time is UTC
+      noon = Time.utc(date.year, date.month, date.day) + (minutes * 60)
+
+      noon.to_datetime
+    end
+
+    private
+
+    # convert Julian Day to centuries since J2000.0.
+    # return the T value corresponding to the Julian Day
+    def jd_centuries
+      (date.jd - 2451545.0) / 36525.0
+    end
+
+    # calculate the difference between true solar time and mean solar time
+    # Takes a Date or DateTime and returns the equation of time in minutes of time
+    def true_solar_time_diff_mean_solar_time
+      epsilon = obliquity_correction
+      l0      = geometric_mean_longitude_of_sun
+      e       = earth_orbit_eccentricity
+      m       = geometric_mean_anomaly_sun
+      y       = Math.tan(degree_to_radians(epsilon) / 2.0) ** 2
+
+      sin2l0  = Math.sin(2.0 * degree_to_radians(l0))
+      sinm    = Math.sin(degree_to_radians(m))
+      cos2l0  = Math.cos(2.0 * degree_to_radians(l0))
+      sin4l0  = Math.sin(4.0 * degree_to_radians(l0))
+      sin2m   = Math.sin(2.0 * degree_to_radians(m))
+
+      etime   = y * sin2l0 - 2.0 * e * sinm + 4.0 * e * y * sinm * cos2l0 - 0.5 * y * y * sin4l0 - 1.25 * e * e * sin2m
+
+      radian_to_degrees(etime) * 4.0
+    end
+
+    # calculate the corrected obliquity of the ecliptic
+    # Takes a Date or DateTime and returns the corrected obliquity in degrees
+    def obliquity_correction
+      t = jd_centuries
+      e0 = mean_obliquity_of_ecliptic
+      omega = 125.04 - 1934.136 * t
+      e0 + 0.00256 * Math.cos(degree_to_radians(omega))
+    end
+
+    # calculate the Geometric Mean Longitude of the Sun
+    # Takes a Date or DateTime and returns the Geometric Mean Longitude of the
+    # Sun in degrees.
+    def geometric_mean_longitude_of_sun
+      t = jd_centuries
+
+      l0 = 280.46646 + t * (36000.76983 + 0.0003032 * t)
+
+      l0 -= 360.0 while l0 > 360.0
+      l0 += 360.0 while l0 < 0.0
+
+      l0
+    end
+
+    # calculate the eccentricity of earth's orbit
+    # Takes a Date or DateTime and returns the unitless eccentricity
+    def earth_orbit_eccentricity
+      t = jd_centuries
+      0.016708634 - t * (0.000042037 + 0.0000001267 * t)
+    end
+
+    # calculate the Geometric Mean Anomaly of the Sun
+    # Takes a Date or DateTime and returns the Geometric Mean Anomaly of the Sun
+    # in degrees
+    def geometric_mean_anomaly_sun
+      t = jd_centuries
+      357.52911 + t * (35999.05029 - 0.0001537 * t)
+    end
+
+    # calculate the mean obliquity of the ecliptic
+    # Takes a Date or DateTime and returns the mean obliquity in degrees
+    def mean_obliquity_of_ecliptic
+      t = jd_centuries
+      seconds = 21.448 - t * (46.8150 + t * (0.00059 - t * (0.001813)))
+      23.0 + (26.0 + (seconds / 60.0)) / 60.0
+    end
+
+    # Convert degree angle to radians
+    def degree_to_radians(angle)
+      Math::PI * angle / 180.0
+    end
+
+    # Convert radian angle to degrees
+    def radian_to_degrees(angle)
+      180.0 * angle / Math::PI
+    end
+
+  end
+
+end

data/solar_noon.gemspec

@@ -0,0 +1,27 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+
+Gem::Specification.new do |s|
+  s.name        = "solar_noon"
+  s.version     = "1.0.0.pre"
+  s.authors     = ["Jason Roth"]
+  s.email       = ["jasonmichaelroth@gmail.com"]
+  s.homepage    = "https://github.com/jasonmichaelroth/solar_noon"
+  s.summary     = "A solar noon calculator."
+  s.description = %q{
+    This gem extends Date, Time and DateTime with solar noon calculation
+    functions. It is based on the NOAA solar noon calculator:
+      http://www.esrl.noaa.gov/gmd/grad/solcalc
+  }
+
+  s.rubyforge_project = "solar_noon"
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- test/*`.split("\n")
+  s.require_paths = ["lib"]
+
+  s.add_development_dependency 'rake', '~> 10.0'
+  s.add_development_dependency 'bundler', '~> 1.3'
+  s.add_development_dependency 'minitest', '~> 5'
+
+end

data/test/minitest_helper.rb

@@ -0,0 +1,8 @@
+require 'bundler/setup'
+require 'minitest/autorun'
+
+class Minitest::Spec
+  class << self
+    alias_method :test, :it
+  end
+end

data/test/solar_noon_test.rb

@@ -0,0 +1,34 @@
+require 'minitest_helper'
+require 'solar_noon'
+
+class SolarNoonTest < Minitest::Spec
+
+  def assert_within_one_minute(expected, actual)
+    flunk "#{actual.inspect} is not a Time or DateTime instance" unless [DateTime, Time].include? actual.class
+    flunk "#{expected.inspect} is not a Time or DateTime instance" unless [DateTime, Time].include? expected.class
+    flunk "#{actual.inspect} is not the same class as #{expected.inspect}" unless expected.is_a? actual.class
+    assert_in_delta expected, actual, 60
+  end
+
+  test "DST time - 2011-03-26 11:42:36 MDT at -105.0" do
+    expected = DateTime.civil(2011, 3, 26, 19, 5, 00, 'UTC')
+    assert_within_one_minute expected, Date.civil(2011, 3, 26).solar_noon(-105.0)
+    assert_within_one_minute expected, DateTime.civil(2011, 3, 26, 11, 42, 36).solar_noon(-105.0)
+    assert_within_one_minute expected, Time.local(2011, 3, 26, 11, 42, 36).solar_noon(-105.0)
+  end
+
+  test "UTC time - 2001-06-12 19:18:15 UTC at 82.5" do
+    expected = DateTime.civil(2001, 6, 12, 6, 29, 00, 'UTC')
+    assert_within_one_minute expected, Date.civil(2001, 6, 12).solar_noon(82.5)
+    assert_within_one_minute expected, DateTime.civil(2001, 6, 12, 19, 18, 15, "UTC").solar_noon(82.5)
+    assert_within_one_minute expected, Time.utc(2001, 6, 12, 19, 18, 15).solar_noon(82.5)
+  end
+
+  test "future time - 2031-11-28 05:07:26 MDT at 132.2" do
+    expected = DateTime.civil(2031, 11, 28, 2, 59, 00, 'UTC')
+    assert_within_one_minute expected, Date.civil(2031, 11, 28).solar_noon(132.2)
+    assert_within_one_minute expected, DateTime.civil(2031, 11, 28, 5, 7, 26, "MDT").solar_noon(132.2)
+    assert_within_one_minute expected, Time.utc(2031, 11, 28, 5, 7, 26).solar_noon(132.2)
+  end
+
+end

metadata

@@ -0,0 +1,100 @@
+--- !ruby/object:Gem::Specification
+name: solar_noon
+version: !ruby/object:Gem::Version
+  version: 1.0.0.pre
+platform: ruby
+authors:
+- Jason Roth
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-10-27 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '5'
+description: "\n    This gem extends Date, Time and DateTime with solar noon calculation\n
+  \   functions. It is based on the NOAA solar noon calculator:\n      http://www.esrl.noaa.gov/gmd/grad/solcalc\n
+  \ "
+email:
+- jasonmichaelroth@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .ruby-version
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/solar_noon.rb
+- lib/solar_noon/calculator.rb
+- solar_noon.gemspec
+- test/minitest_helper.rb
+- test/solar_noon_test.rb
+homepage: https://github.com/jasonmichaelroth/solar_noon
+licenses: []
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>'
+    - !ruby/object:Gem::Version
+      version: 1.3.1
+requirements: []
+rubyforge_project: solar_noon
+rubygems_version: 2.0.3
+signing_key: 
+specification_version: 4
+summary: A solar noon calculator.
+test_files:
+- test/minitest_helper.rb
+- test/solar_noon_test.rb