equationoftime 4.1.7 → 4.1.8

data/examples/test_eot_c.rb

@@ -0,0 +1,24 @@
+lib = File.expand_path('../../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
+require 'eot'
+
+eot = Eot.new
+
+p eot.ajd
+p eot.ta # set on initializating using ajd
+p eot.ma # set on initializating using ajd
+# new date used
+p ajd = DateTime.new(2000, 1, 1).jd
+eot.ajd = ajd
+eot.ma_ta_set # this sets the attributes
+p ta = eot.ta # now these would be different
+p ma = eot.ma # now these would be different
+p ta_m = eot.eqc(ma, ta)
+p om = eot.omega
+p eot.al(ma, ta, om)
+p eot.sun_dec(eot.al(ma, ta, om), eot.to_earth)
+p eot.eoe(ta)
+p eot.ml(ta)
+p eot.era
+p eot.tl_aries

data/examples/use_addr.rb

@@ -0,0 +1,20 @@
+require 'eot'
+eot = Eot.new
+geo = GeoLatLng.new
+heredoc = <<HD
+The default address is '#{eot.addr}' as a string.
+It is concantenated to the GeoLatLng base address
+Create an instance of GeoLatLng with new method
+ex: geo = GeoLatLng.new
+examine the base address geo.base_json
+#{geo.base_json}
+This is used to lookup your coordinates using Google
+maps. Use geo.set_coordinates.
+#{geo.set_coordinates}
+Just change the address to any desired location.
+Use comma or space seperated terms.
+ex: "huston, tx"
+#{geo.addr = 'huston, tx'}
+#{geo.set_coordinates}
+HD
+puts heredoc

data/examples/use_ajd.rb

@@ -0,0 +1,40 @@
+require 'eot'
+eot = Eot.new
+heredoc = <<HD
+Setting the ajd sets a lot of other attributes.
+All the angle calculations use this one setting.
+ex: eot.ajd = 2451545.0
+#{eot.ajd = 2_451_545.0}
+You may get just about any value now from
+various methods.
+ex: eot.eot
+#{eot.eot} radians
+What day was that ajd?
+eot.ajd_to_datetime(eot.ajd)
+#{eot.ajd_to_datetime(eot.ajd)}
+Sun apparent longitude.
+eot.al_sun
+#{eot.al_sun} radians
+Try adding 80 days to the ajd
+eot.ajd = 2451545.0 + 78
+#{eot.ajd = 2_451_545.0 + 78}
+#{eot.al_sun} radians
+Almost a full circle in radians.
+What day is that?
+eot.ajd_to_datetime(eot.ajd)
+#{eot.ajd_to_datetime(eot.ajd)}
+That's near the Vernal Exquinox.
+It nomally occurs 78 days after the Earth is
+in perihelion of it's orbit around the Sun.
+When does perihelion occur then?
+A reasonable estimate is about the 3rd day of a new year.
+eot.ajd = 2451545.0 + 2
+#{eot.ajd = 2_451_545.0 + 2}
+Now add the 78 days.
+eot.ajd + 78
+#{eot.ajd += 78}
+#{eot.al_sun} radians
+We completed the orbit plus a little extra.
+It's just a rough estimate and is always changing.
+HD
+puts heredoc

data/ext/eot/ceot.c

@@ -1,11 +1,10 @@
 #include "ceot.h"
 
-
+/* Mean geocentric longitude of the Sun */
 double mlSun(double t)
 {
   double a;
-
-  /* Mean geocentric longitude of the Sun */
+  
   a = fmod(      280.4664567    +
   t * (        36000.76982779   +
   t * (            0.0003032028 +
@@ -16,11 +15,11 @@ double mlSun(double t)
   return a;
 }
 
+/* Eccentricity of Earth orbit */
 double eoe(double t)
 {
   double e;
 
-  /* Eccentricity of Earth orbit */
   e = (0.016708617 + t * (-0.000042037 + t *  -0.0000001235));
 
   return e; 

data/ext/eot/eot.c

@@ -7,96 +7,140 @@
 
 ID id_status;
 
+/*
+Apparent longitude of the Sun C extension.
+p1 = mean anomaly
+p2 = time in julian centuries
+p3 = angle of Omega
+*/
+VALUE func_al(VALUE klass, VALUE vma, VALUE vt, VALUE vo) {
+  rb_ivar_set(klass, id_status, INT2FIX(0));
+  return DBL2NUM(alSun(NUM2DBL(vma), NUM2DBL(vt), NUM2DBL(vo)));
+}
+/*
+Cosine of the Zenith type C extension.
+p1 = zenith angle sent by choice method
+*/
+VALUE func_cosZ(VALUE klass, VALUE vz) {
+  rb_ivar_set(klass, id_status, INT2FIX(0));
+  return DBL2NUM(cosZ(NUM2DBL(vz)));
+}
+/*
+Cosine of Apparent Longitude Sun C extension.
+p1 = Apparent Longitude Sun see al
+*/
+VALUE func_cos_al_sun(VALUE klass, VALUE vals) {
+  rb_ivar_set(klass, id_status, INT2FIX(0));
+  return DBL2NUM(cos_al_sun(NUM2DBL(vals)));
+}
+/*
+Cosine of Solar Declination C extension
+*/
+VALUE func_cos_dec_sun(VALUE klass, VALUE vds) {
+  rb_ivar_set(klass, id_status, INT2FIX(0));
+  return DBL2NUM(cos_dec_sun(NUM2DBL(vds)));
+}
+/*
+C extension
+*/
 VALUE func_ml(VALUE klass, VALUE vt) {
   rb_ivar_set(klass, id_status, INT2FIX(0));
   return DBL2NUM(mlSun(NUM2DBL(vt)));
 }
-
+/*
+C extension
+*/
 VALUE func_eoe(VALUE klass, VALUE vt) {
   rb_ivar_set(klass, id_status, INT2FIX(0));
   return DBL2NUM(eoe(NUM2DBL(vt)));
 }
-
+/*
+C extension
+*/
 VALUE func_eqc(VALUE klass, VALUE vma, VALUE vt) {
  rb_ivar_set(klass, id_status, INT2FIX(0));
  return DBL2NUM(eqc(NUM2DBL(vma), NUM2DBL(vt)));  
 }
-
+/*
+C extension
+*/
 VALUE func_tl(VALUE klass, VALUE vma, VALUE vt) {
   rb_ivar_set(klass, id_status, INT2FIX(0));
   return DBL2NUM(tlSun(NUM2DBL(vma), NUM2DBL(vt)));
 }
-
-VALUE func_al(VALUE klass, VALUE vma, VALUE vt, VALUE vo) {
-  rb_ivar_set(klass, id_status, INT2FIX(0));
-  return DBL2NUM(alSun(NUM2DBL(vma), NUM2DBL(vt), NUM2DBL(vo)));
-}
-
-VALUE func_cosZ(VALUE klass, VALUE vz) {
-  rb_ivar_set(klass, id_status, INT2FIX(0));
-  return DBL2NUM(cosZ(NUM2DBL(vz)));
-}
-
-VALUE func_cos_al_sun(VALUE klass, VALUE vals) {
-  rb_ivar_set(klass, id_status, INT2FIX(0));
-  return DBL2NUM(cos_al_sun(NUM2DBL(vals)));
-}
-
+/*
+C extension
+*/
 VALUE func_cos_tl_sun(VALUE klass, VALUE vtls) {
   rb_ivar_set(klass, id_status, INT2FIX(0));
   return DBL2NUM(cos_al_sun(NUM2DBL(vtls)));
 }
-
+/*
+C extension
+*/
 VALUE func_cos_to_earth(VALUE klass, VALUE vtoe) {
   rb_ivar_set(klass, id_status, INT2FIX(0));
   return DBL2NUM(cos_to_earth(NUM2DBL(vtoe)));
 }
-
+/*
+C extension
+*/
 VALUE func_sin_al_sun(VALUE klass, VALUE vals) {
   rb_ivar_set(klass, id_status, INT2FIX(0));
   return DBL2NUM(sin_al_sun(NUM2DBL(vals)));
 }
-
+/*
+C extension
+*/
 VALUE func_sin_tl_sun(VALUE klass, VALUE vtls) {
   rb_ivar_set(klass, id_status, INT2FIX(0));
   return DBL2NUM(sin_al_sun(NUM2DBL(vtls)));
 }
-
+/*
+C extension
+*/
 VALUE func_sin_to_earth(VALUE klass, VALUE vtoe) {
   rb_ivar_set(klass, id_status, INT2FIX(0));
   return DBL2NUM(sin_to_earth(NUM2DBL(vtoe)));
 }
-
+/*
+C extension
+*/
 VALUE func_sin_dec_sun(VALUE klass, VALUE vds) {
   rb_ivar_set(klass, id_status, INT2FIX(0));
   return DBL2NUM(sin_dec_sun(NUM2DBL(vds)));
 }
-
-VALUE func_cos_dec_sun(VALUE klass, VALUE vds) {
-  rb_ivar_set(klass, id_status, INT2FIX(0));
-  return DBL2NUM(cos_dec_sun(NUM2DBL(vds)));
-}
-
+/*
+C extension
+*/
 VALUE func_sin_lat(VALUE klass, VALUE vlat) {
   rb_ivar_set(klass, id_status, INT2FIX(0));
   return DBL2NUM(sin_lat(NUM2DBL(vlat)));
 }
-
+/*
+C extension
+*/
 VALUE func_cos_lat(VALUE klass, VALUE vlat) {
   rb_ivar_set(klass, id_status, INT2FIX(0));
   return DBL2NUM(cos_lat(NUM2DBL(vlat)));
 }
-
+/*
+C extension
+*/
 VALUE func_sun(VALUE klass, VALUE vz, VALUE vds, VALUE vlat) {
   rb_ivar_set(klass, id_status, INT2FIX(0));
   return DBL2NUM(sun(NUM2DBL(vz), NUM2DBL(vds), NUM2DBL(vlat)));
 }
-
+/*
+C extension
+*/
 VALUE func_sun_dec(VALUE klass, VALUE vals, VALUE vtoe) {
   rb_ivar_set(klass, id_status, INT2FIX(0));
   return DBL2NUM(sun_dec(NUM2DBL(vals), NUM2DBL(vtoe)));
 }
-
+/*
+C extension
+*/
 VALUE func_sun_ra(VALUE klass, VALUE vy0, VALUE vcas) {
   rb_ivar_set(klass, id_status, INT2FIX(0));
   return DBL2NUM(raSun(NUM2DBL(vy0), NUM2DBL(vcas)));
@@ -108,24 +152,24 @@ Init_eot(void) {
 
   VALUE cEot = rb_define_class("Eot", rb_cObject);
   id_status = rb_intern("@status");
-  rb_define_method(cEot, "ml", func_ml, 1);
-  rb_define_method(cEot, "eoe", func_eoe, 1);
-  rb_define_method(cEot, "eqc", func_eqc, 2);
-  rb_define_method(cEot, "tl", func_tl, 2);
   rb_define_method(cEot, "al", func_al, 3);
   rb_define_method(cEot, "cosZ", func_cosZ, 1);
   rb_define_method(cEot, "cos_al_sun", func_cos_al_sun, 1);
+  rb_define_method(cEot, "cos_dec_sun", func_cos_dec_sun, 1);
+  rb_define_method(cEot, "cos_lat", func_cos_lat, 1);
   rb_define_method(cEot, "cos_tl_sun", func_cos_tl_sun, 1);
   rb_define_method(cEot, "cos_to_earth", func_cos_to_earth, 1);
+  rb_define_method(cEot, "eoe", func_eoe, 1);
+  rb_define_method(cEot, "eqc", func_eqc, 2);
+  rb_define_method(cEot, "ml", func_ml, 1); 
   rb_define_method(cEot, "sin_al_sun", func_sin_al_sun, 1);
-  rb_define_method(cEot, "sin_tl_sun", func_sin_tl_sun, 1);
-  rb_define_method(cEot, "sin_to_earth", func_sin_to_earth, 1);
-  rb_define_method(cEot, "cos_dec_sun", func_cos_dec_sun, 1);
   rb_define_method(cEot, "sin_dec_sun", func_sin_dec_sun, 1);
-  rb_define_method(cEot, "cos_lat", func_cos_lat, 1);
   rb_define_method(cEot, "sin_lat", func_sin_lat, 1);
+  rb_define_method(cEot, "sin_tl_sun", func_sin_tl_sun, 1);
+  rb_define_method(cEot, "sin_to_earth", func_sin_to_earth, 1);
+  rb_define_method(cEot, "sun", func_sun, 3); 
   rb_define_method(cEot, "sun_dec", func_sun_dec, 2);
-  rb_define_method(cEot, "sun", func_sun, 3);
   rb_define_method(cEot, "sun_ra", func_sun_ra, 2);
+  rb_define_method(cEot, "tl", func_tl, 2);
   
 }

data/lib/eot/all.rb

@@ -0,0 +1,11 @@
+# Eot is short for Equation of time.
+# It is mainly used to find a true solar transit angle
+# of the given longitude. 
+# Mean local noon in hours is (noon UTC) - (longitude / 15.0).
+# True local noon is Mean - Eot in either time or angle.
+class MainDoc < Object
+end
+# Celes gives you an undocumented Object class with rdoc generator.
+# Use bundle exec rake rdocs if you don't care about C extensions documentation.
+class Celes 
+end

data/lib/eot/angle_displays.rb

@@ -1,7 +1,11 @@
-# class Eot file = angle_displays.rb
-# methods for display of angles
+##
+# class Eot file = angle_displays.rb:
+# methods for display of angles.
+
 class Eot
-  # From displays.rb
+
+  # From angle_displays.rb
+
   # String formatter for d:m:s display
   def degrees_to_s(radians = 0.0)
     radians.nil? ? radians = 0.0 : radians
@@ -9,67 +13,77 @@ class Eot
     f_string(s, idmsf[0], idmsf[1], idmsf[2], idmsf[3])
   end
 
-  # From displays.rb
+  # From angle_displays.rb
+
   # String format of apparent longitude
   def string_al_sun
     degrees_to_s(al_sun)
   end
   alias_method :apparent_longitude_string, :string_al_sun
 
-  # From displays.rb
+  # From angle_displays.rb
+
   # String format of declination
   def string_dec_sun
     degrees_to_s(dec_sun)
   end
   alias_method :declination_string, :string_dec_sun
 
-  # From displays.rb
+  # From angle_displays.rb
+
   # String format for delta oblique
   def string_delta_oblique
     show_minutes(delta_oblique)
   end
 
-  # From displays.rb
+  # From angle_displays.rb
+
   # String format for delta orbit
   def string_delta_orbit
     show_minutes(delta_orbit)
   end
 
-  # From displays.rb
+  # From angle_displays.rb
+
   # String format for centre
   def string_eqc
     degrees_to_s(center)
   end
 
-  # From displays.rb
+  # From angle_displays.rb
+
   # String format of mean anomaly
   def string_ma_sun
     degrees_to_s(@ma)
   end
   alias_method :mean_anomaly_string, :string_ma_sun
 
-  # From displays.rb
+  # From angle_displays.rb
+
   # String format of right ascension
   def string_ra_sun
     degrees_to_s(ra_sun)
   end
   alias_method :right_ascension_string, :string_ra_sun
 
-  # From displays.rb
+  # From angle_displays.rb
+
   # String format of true anomaly
   def string_ta_sun
     degrees_to_s(ta_sun)
   end
   alias_method :true_anomaly_string, :string_ta_sun
 
-  # From displays.rb
+  # From angle_displays.rb
+
   # String format of true longitude
   def string_tl_sun
     degrees_to_s(tl_sun)
   end
   alias_method :true_longitude_string, :string_tl_sun
 
-  # From displays.rb
+  # From angle_displays.rb
+
   # String format of true obliquity
   def string_to_earth
     degrees_to_s(to_earth)

data/lib/eot/angles.rb

@@ -1,66 +1,94 @@
-# class Eot file = angles.rb
-# methods for non delta angle calculations
+##
+# class Eot file = angles.rb:
+# methods for non delta angle calculations.
+
 class Eot
+
+  ##
   # From angles.rb:
+
   # Apparent solar longitude = true longitude - aberation
+
   def al_sun
     Celes.anp(al(@ma, @ta, omega))
   end
   alias_method :apparent_longitude, :al_sun
   alias_method :alsun, :al_sun
 
+  ##
   # From angles.rb:
-  # equation of centre
+
+  # equation of centre is
   # added to mean anomaly to get true anomaly.
+
   def center
     eqc(@ma, @ta)
   end
   alias_method :equation_of_center, :center
 
+  ##
   # From angles.rb:
-  # solar declination
+
+  # solar declination 
+
   def dec_sun
     sun_dec(al_sun, to_earth)
   end
   alias_method :declination, :dec_sun
 
+  ##
   # From angles.rb:
+
   # eccentricity of elliptical Earth orbit around Sun
   # Horners' calculation method
+
   def eccentricity_earth
     eoe(@ta)
   end
   alias_method :eccentricity_earth_orbit, :eccentricity_earth
 
+  ##
   # From angles.rb:
-  # equation of equinox
-  # used for true longitude of Aries
+
+  # equation of equinox is
+  # used for true longitude of Aries but 
   # Depricated by Celes.gst06a()
   # compinents are still used
   # see: #cosine_to_earth and #angle_delta_psi
+
   def eq_of_equinox
     Celes.ee06a(@ajd, 0.0)
   end
 
+  
+  ##
   # From angles.rb:
+
   # Earth rotation angle (for comparison to tl_aries
   # which uses gmst06)
+
   def era
     Celes.era00(@ajd, 0.0)
   end
 
+  ## 
   # From angles.rb:
+
   # angle geometric mean longitude
   # needed to get true longitude for low accuracy.
+
   def gml_sun
     ml(@ta)
   end
   alias_method :geometric_mean_longitude, :gml_sun
   alias_method :ml_sun, :gml_sun
 
+  ##
   # From angles.rb:
+
   # used by ha_sun method
   # to select rise set and civil, nautical, astronomical twilights.
+
   def choice(c)
     case c
     when 1
@@ -74,30 +102,39 @@ class Eot
     end
   end
 
+  ##
   # From angles.rb:
+
   # horizon angle for provided geo coordinates
   # used for angles from transit to horizons.
+
   def ha_sun(c)
     zenith = choice(c)
     sun(zenith, dec_sun, @latitude)
   end
   alias_method :horizon_angle, :ha_sun
 
+  ##
   # From angles.rb:
+
   # angle of Suns' mean anomaly
   # calculated in nutation.rb via celes function
   # sets ta attribute for the rest the methods needing it.
   # used in equation of time
   # and to get true anomaly true longitude via center equation
+
   def ma_sun
     @ta = (@ajd - DJ00) / DJC
     @ma = Celes.falp03(@ta)
   end
   alias_method :mean_anomaly, :ma_sun
 
+  ##
   # From angles.rb:
+
   # Mean equinox point where right ascension is measured from as zero hours.
   # # see http://www.iausofa.org/publications/aas04.pdf
+
   def ml_aries
     dt = 67.184
     tt = @ajd + dt / 86_400.0
@@ -105,25 +142,34 @@ class Eot
   end
   alias_method :mean_longitude_aries, :ml_aries
 
+  ##
   # From angles.rb:
+
   # mean obliquity of Earth
+
   def mo_earth
     Celes.obl06(@ajd, 0)
   end
   alias_method :mean_obliquity_of_ecliptic, :mo_earth
   alias_method :mean_obliquity, :mo_earth
 
+  ##
   # From angles.rb:
+
   # omega is a component of nutation and used
   # in apparent longitude
   # omega is the longitude of the mean ascending node of the lunar orbit
   # on the ecliptic plane measured from the mean equinox of date.
+
   def omega
     Celes.faom03(@ta)
   end
 
+  ##
   # From angles.rb:
+
   # solar right ascension
+
   def ra_sun
     y0 = sine_al_sun * cosine_to_earth
     ra = sun_ra(y0, cosine_al_sun) 
@@ -132,17 +178,23 @@ class Eot
   end
   alias_method :right_ascension, :ra_sun
 
+  ##
   # From angles.rb:
+
   # angle true anomaly
   # used in equation of time
+
   def ta_sun
     Celes.anp(@ma + eqc(@ma, @ta))
   end
   alias_method :true_anomaly, :ta_sun
 
+  ##
   # From angles.rb:
+
   # true longitude of equinox 'first point of aries'
   # considers nutation
+
   def tl_aries
     dt = 67.184
     tt = @ajd + dt / 86_400.0
@@ -150,18 +202,24 @@ class Eot
   end
   alias_method :true_longitude_aries, :tl_aries
 
+  ##
   # From angles.rb:
+
   # angle of true longitude sun
   # used in equation of time
+
   def tl_sun
     tl(@ma, @ta)
   end
   alias_method :true_longitude, :tl_sun
   alias_method :ecliptic_longitude, :tl_sun
   alias_method :lambda, :tl_sun
-
+ 
+  ##
   # From angles.rb:
+
   # true obliquity considers nutation
+
   def to_earth
     mo_earth + angle_delta_epsilon
   end