calc_sun 1.2.8 → 1.2.9

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d2a97912158413d5cabb50716d0b96395b95558d
-  data.tar.gz: 3d5d6b8e3936de236a62956205faf7616a97af66
+  metadata.gz: 17ba770fc7f7e5fba650d574db11d2f821628647
+  data.tar.gz: b2d518e421c8f5c4db7bfd9509f9e664c85f07ad
 SHA512:
-  metadata.gz: a6c9e12783949cfb6cbeab472a39a43b27dc8e2d277e53185293b10867ac4f79c52af0f6009e811d95397eed820c0bcf39b331c57f99ca5dae3cb347fcdac775
-  data.tar.gz: 0ed71a31906f0a06a05dccf772fdcd51ca26ac76682eeb66a236f65001d763f7baaa69ac64d447e3b69131438df5c37eaa87b44cdd85eefbabb978834001f941
+  metadata.gz: d901c66a7f59225201d44e0f110812a0f7dc799a68ff1684af2ff0a6e559effaeb8d308ea1c175215252ed4f99c9bcd235f426217c77bf20f3af55422c2548ea
+  data.tar.gz: 8b3d353868169de3fac48059028292444fdd5a2d4d4d3766578d02093db431c14661421b5fcd47d0280aa70f4e620fd894ac9c5ee97aa2d65ffc2a4a8e810330

data/README.rdoc

@@ -5,7 +5,7 @@
 
 Home    :: https://rubygems.org/gems/calc_sun
 Code    :: https://github.com/DouglasAllen/calc_sun
-RDoc    :: http://www.rubydoc.info/gems/calc_sun/0.1.1
+RDoc    :: http://www.rubydoc.info/gems/calc_sun/1.2.9
 Issues  :: https://github.com/DouglasAllen/calc_sun/issues
 
 
@@ -31,7 +31,7 @@ since version 1.2.6
    or make a batchfile to start your envirnment with 'run devkitvars'
    cd to calc_sun dir
    $> gem build calc_sun.gemspec
-   $> gem install calc_sun-1.2.6.gem -l
+   $> gem install calc_sun-1.2.9.gem -l
 
 === DEVELOPERS:
 
@@ -66,11 +66,19 @@ and generate the RDoc.
 
     # set the date with set_date as date is just an ivar
     day = cs.set_datetime('2003-10-17 12:30:30')
-    puts day
+    puts day.httpdate
 
-    puts "Sun rise: #{cs.rise(day.ajd, lat, lon).httpdate}"
-    puts "Sun noon: #{cs.noon(day.ajd, lat, lon).httpdate}"
-    puts "Sun set: #{cs.set(day.ajd, lat, lon).httpdate}"
+    puts "Sun rise: #{cs.rise(day.jd, lat, lon).httpdate}"
+    puts "Sun noon: #{cs.noon(day.jd, lat, lon).httpdate}"
+    puts "Sun set: #{cs.set(day.jd, lat, lon).httpdate}"
+
+    puts "Sun AJD rise: #{cs.rise_jd(day.jd, lat, lon)}"
+    puts "Sun AJD noon: #{cs.noon_jd(day.jd, lat, lon)}"
+    puts "Sun AJD set: #{cs.set_jd(day.jd, lat, lon)}"
+
+    puts "Sun azimuth rise: #{cs.rise_az(day.jd, lat, lon)}"
+    puts "Sun azimuth noon: #{cs.noon_az(day.jd, lat, lon)}"
+    puts "Sun azimuth set: #{cs.set_az(day.jd, lat, lon)}"
 
 === LICENSE:
 

data/calc_sun.gemspec

@@ -9,11 +9,13 @@ Gem::Specification.new do |spec|
   spec.author        = 'Douglas Allen'
   spec.email         = ['kb9agt@gmail.com']
   spec.summary       = 'Calculates Sun Times ea. rise, noon, set'
-  spec.description   = 'supply the date as a Julian Day Number, latitude decimal, and
-                        longitude decimal in the calls to each method
+  spec.description   = 'Given a Julian Day Number of day,
+                        latitude decimal, and
+                        longitude decimal in the calls to instance methods
                         rise(jd, lat, lon),
                         noon(jd, lat, lon), and
-                        set(jd, lat, lon)'
+                        set(jd, lat, lon)
+                        see source code for more details'
   spec.homepage      = 'https://github.com/DouglasAllen/calc_sun'
   spec.license       = 'MIT'
   require 'English'

data/ext/calc_sun/calc_sun.c

@@ -16,7 +16,9 @@
 # define INV360 1.0 / 360.0
 # define DJ00 2451545.0L
 # define RND12 1000000000000.0L
-
+/* macro for normalizing
+* angles into 0-2pie range
+*/
 static inline double
 anp(double angle){
   double w = fmod(angle, M2PI);
@@ -28,7 +30,7 @@ anp(double angle){
  * call-seq:
  *  initialize()
  *
- * Create CalcSun class Ruby object.
+ * Create CalcSun class instance Ruby object.
  *
  */
 static VALUE t_init(VALUE self){
@@ -36,9 +38,14 @@ static VALUE t_init(VALUE self){
 }
 /*
  * call-seq:
- *  date('yyyy-mm-dd')
+ *  date('yyyy-mm-ddT00:00:00+/-zoneoffset')
+ * or
+ *  date('20010203T040506+0700')
+ * or
+ *  date('3rd Feb 2001 04:05:06 PM')
  *
- * convert input string to DateTime object.
+ * given a string representing date time
+ * convert to DateTime object.
  *
  */
 static VALUE func_set_datetime(VALUE self, VALUE vdatetime){
@@ -50,7 +57,8 @@ static VALUE func_set_datetime(VALUE self, VALUE vdatetime){
  * call-seq:
  *  ajd2dt(ajd)
  *
- * convert input float to DateTime object.
+ * give Astronomical Julian Day Number
+ * convert to DateTime object.
  *
  */
 static VALUE func_ajd_2_datetime(VALUE self, VALUE vajd){
@@ -64,7 +72,8 @@ static VALUE func_ajd_2_datetime(VALUE self, VALUE vajd){
  * call-seq:
  *  ajd(date)
  *
- * convert Date or DateTime object to AJD number.
+ * given Date or DateTime object
+ * convert  to Astronomical Julian Day Number.
  *
  */
 static VALUE func_get_ajd(VALUE self, VALUE vdatetime){
@@ -75,7 +84,8 @@ static VALUE func_get_ajd(VALUE self, VALUE vdatetime){
  * call-seq:
  *  jd(date)
  *
- * convert Date or DateTime object to JD number.
+ * given Date or DateTime object
+ * convert to JD number.
  *
  */
 static VALUE func_get_jd(VALUE self, VALUE vdatetime){
@@ -85,10 +95,10 @@ static VALUE func_get_jd(VALUE self, VALUE vdatetime){
 
 /*
  * call-seq:
- *  mean_anomaly(date)
+ *  mean_anomaly(ajd)
  *
- * convert Date or DateTime object to float
- * representing Solar Mean Anomaly in radians.
+ * given an Astronomical Julian Day Number
+ * returns Mean Anomaly of Sun in radians.
  *
  */
 static VALUE func_mean_anomaly(VALUE self, VALUE vajd){
@@ -102,7 +112,14 @@ static VALUE func_mean_anomaly(VALUE self, VALUE vajd){
     t * (1.0 / -313315926.8929504))))) * D2R, M2PI);
   return DBL2NUM(roundf(vma * RND12) / RND12);
 }
-
+/*
+ * call-seq:
+ *  eccentricity(ajd)
+ *
+ * given an Astronomical Julian Day Number
+ * returns Eccentriciy of Earth Orbit around Sun.
+ *
+ */
 static VALUE func_eccentricity(VALUE self, VALUE vajd){
   double jd = NUM2DBL(vajd);
   double d = jd - DJ00;
@@ -113,21 +130,12 @@ static VALUE func_eccentricity(VALUE self, VALUE vajd){
 }
 
 /*
-static VALUE func_equation_of_center(VALUE self, VALUE vajd){
-  double vma =
-  NUM2DBL(func_mean_anomaly(self, vajd));
-  double ve =
-  NUM2DBL(func_eccentricity(self, vajd));
-  double ve2 = ve * 2.0;
-  double vesqr = ve * ve;
-  double vesqr54 = 5.0 / 4.0 * vesqr;
-  double vecube12 = (vesqr * ve) / 12.0;
-  double veoc =
-  ve2 * sin(vma) +
-  vesqr54 * sin(2 * vma) +
-  vecube12 * (13.0 * sin(3 * vma) - 3.0 * sin(vma));
-  return DBL2NUM(roundf(veoc * RND12) / RND12);
-}
+ * call-seq:
+ *  equation_of_center(ajd)
+ *
+ * given an Astronomical Julian Day Number
+ * returns Equation of Center in radians.
+ *
 */
 
 static VALUE func_equation_of_center(VALUE self, VALUE vajd){
@@ -149,7 +157,14 @@ static VALUE func_equation_of_center(VALUE self, VALUE vajd){
   double veoc = eoe * (sin1a * 8.0 + eoe * (sin2b + eoe * (ad3 + eoe * (ad4 + eoe * ad5))));
   return DBL2NUM(roundf(veoc * RND12) / RND12);
 }
-
+/*
+ * call-seq:
+ *  true_anomaly(ajd)
+ *
+ * given an Astronomical Julian Day Number
+ * returns True Anomaly of Sun in radians.
+ *
+*/
 static VALUE func_true_anomaly(VALUE self, VALUE vajd){
   double vma =
   NUM2DBL(func_mean_anomaly(self, vajd));
@@ -158,7 +173,14 @@ static VALUE func_true_anomaly(VALUE self, VALUE vajd){
   double vta = vma + veoc;
   return DBL2NUM(roundf(vta * RND12) / RND12);
 }
-
+/*
+ * call-seq:
+ *  mean_longitude(ajd)
+ *
+ * given an Astronomical Julian Day Number
+ * returns Mean Longitude of Sun in radians.
+ *
+*/
 static VALUE func_mean_longitude(VALUE self, VALUE vajd){
   double jd = NUM2DBL(vajd);
   double d = jd - DJ00;
@@ -169,7 +191,14 @@ static VALUE func_mean_longitude(VALUE self, VALUE vajd){
     ) * D2R, M2PI);
   return DBL2NUM(roundf(vml * RND12) / RND12);
 }
-
+/*
+ * call-seq:
+ *  eccentric_anomaly(ajd)
+ *
+ * given an Astronomical Julian Day Number
+ * returns Eccentric Anomaly of Sun in radians.
+ *
+*/
 static VALUE func_eccentric_anomaly(VALUE self, VALUE vajd){
   double ve =
   NUM2DBL(func_eccentricity(self, vajd));
@@ -179,7 +208,14 @@ static VALUE func_eccentric_anomaly(VALUE self, VALUE vajd){
   vml + ve * sin(vml) * (1.0 + ve * cos(vml));
   return DBL2NUM(roundf(vea * RND12) / RND12);
 }
-
+/*
+ * call-seq:
+ *  obliquity_of_ecliptic(ajd)
+ *
+ * given an Astronomical Julian Day Number
+ * returns Earth Tilt (Obliquity) in radians.
+ *
+*/
 static VALUE func_obliquity_of_ecliptic(VALUE self, VALUE vajd){
   double jd = NUM2DBL(vajd);
   double d = jd - DJ00;
@@ -187,18 +223,30 @@ static VALUE func_obliquity_of_ecliptic(VALUE self, VALUE vajd){
   (23.439291 - 3.563E-7 * d) * D2R;
   return DBL2NUM(roundf(vooe * RND12) / RND12);
 }
-
+/*
+ * call-seq:
+ *  longitude_of_perihelion(ajd)
+ *
+ * given an Astronomical Julian Day Number
+ * returns Longitude of Sun at Perihelion in radians.
+ *
+ *
+*/
 static VALUE func_longitude_of_perihelion(VALUE self, VALUE vajd){
-  double jd = NUM2DBL(vajd);
-  double d = jd - DJ00;
-  double vlop =
-  fmod(
-    (282.9404 +
-     4.70935e-05 * d
-    ) * D2R, M2PI);
+  double vml = NUM2DBL(func_mean_longitude(self, vajd));
+  double vma = NUM2DBL(func_mean_anomaly(self, vajd));
+  double vlop = anp(vml - vma);
   return DBL2NUM(roundf(vlop * RND12) / RND12);
 }
-
+/*
+ * call-seq:
+ *  xv(ajd)
+ *
+ * given an Astronomical Julian Day Number
+ * returns X component of Radius Vector in radians.
+ *
+ *
+*/
 static VALUE func_xv(VALUE self, VALUE vajd){
   double vea =
   NUM2DBL(func_eccentric_anomaly(self, vajd));
@@ -207,7 +255,15 @@ static VALUE func_xv(VALUE self, VALUE vajd){
   double vxv = cos(vea) - ve;
   return DBL2NUM(roundf(vxv * RND12) / RND12);
 }
-
+/*
+ * call-seq:
+ *  xv(ajd)
+ *
+ * given an Astronomical Julian Day Number
+ * returns Y component of Radius Vector in radians.
+ *
+ *
+*/
 static VALUE func_yv(VALUE self, VALUE vajd){
   double vea =
   NUM2DBL(func_eccentric_anomaly(self, vajd));
@@ -217,34 +273,44 @@ static VALUE func_yv(VALUE self, VALUE vajd){
   sqrt(1.0 - ve * ve) * sin(vea);
   return DBL2NUM(roundf(vyv * RND12) / RND12);
 }
-
+/*
+ * call-seq:
+ *  true_anomaly1(ajd)
+ *
+ * given an Astronomical Julian Day Number
+ * returns True Anomaly of Sun in radians.
+ *
+*/
 static VALUE func_true_anomaly1(VALUE self, VALUE vajd){
   double xv = NUM2DBL(func_xv(self, vajd));
   double yv = NUM2DBL(func_yv(self, vajd));
   double vta = anp(atan2(yv, xv));
   return DBL2NUM(roundf(vta * RND12) / RND12);
 }
-
+/*
+ * call-seq:
+ *  true_longitude1(ajd)
+ *
+ * given an Astronomical Julian Day Number
+ * returns True Longitude of Sun in radians.
+ *
+*/
 static VALUE func_true_longitude(VALUE self, VALUE vajd){
-  double vta =
-  NUM2DBL(func_true_anomaly(self, vajd));
-  double vlop =
-  NUM2DBL(func_longitude_of_perihelion(self, vajd));
-  double vtl =
-  fmod(vta + vlop, M2PI);
+  double vml =
+  NUM2DBL(func_mean_longitude(self, vajd));
+  double veoc =
+  NUM2DBL(func_equation_of_center(self, vajd));
+  double vtl = anp(vml + veoc);
   return DBL2NUM(roundf(vtl * RND12) / RND12);
 }
-
 /*
-static VALUE func_gmsa0(VALUE self, VALUE vajd){
-  double tl =
-  NUM2DBL(func_true_longitude(self, vajd));
-  double st =
-  anp(PI + tl) * R2D;
-  return DBL2NUM(roundf(st * RND12) / RND12);
-}
+ * call-seq:
+ *  mean_sidereal_time(ajd)
+ *
+ * given an Astronomical Julian Day Number
+ * returns Greenwich Mean Sidereal Time in hours.
+ *
 */
-
 static VALUE func_mean_sidetime(VALUE self, VALUE vajd){
   double ajd = NUM2DBL(vajd);
   long double sidereal;
@@ -260,7 +326,14 @@ static VALUE func_mean_sidetime(VALUE self, VALUE vajd){
   /* change to hours */
   return DBL2NUM(fmod(roundf((sidereal / 15.0) * RND12) / RND12, 24.0));
 }
-
+/*
+ * call-seq:
+ *  gmsa0(ajd)
+ *
+ * given an Astronomical Julian Day Number
+ * returns Greenwich Mean Sidereal Time at midnight as angle.
+ *
+*/
 static VALUE func_gmsa0(VALUE self, VALUE vajd){
   double msa0;
   double ajd0 = NUM2DBL(vajd);
@@ -276,7 +349,14 @@ static VALUE func_gmsa0(VALUE self, VALUE vajd){
   NUM2DBL(func_mean_sidetime(self, DBL2NUM(ajd0))) * 15;
   return DBL2NUM(roundf(msa0 * RND12) / RND12);
 }
-
+/*
+ * call-seq:
+ *  gmsa(ajd)
+ *
+ * given an Astronomical Julian Day Number
+ * returns Greenwich Mean Sidereal Time as angle.
+ *
+*/
 static VALUE func_gmsa(VALUE self, VALUE vajd){
   double ajd = NUM2DBL(vajd) - 0.5;
   double ajdt = fmod(ajd, 1.0);
@@ -285,18 +365,39 @@ static VALUE func_gmsa(VALUE self, VALUE vajd){
   double msa = anp(msar0 + vtr) * R2D;
   return DBL2NUM(roundf(msa * RND12) / RND12);
 }
-
+/*
+ * call-seq:
+ *  gmst0(ajd)
+ *
+ * given an Astronomical Julian Day Number
+ * returns Greenwich Mean Sidereal Time at midnight in hours.
+ *
+*/
 static VALUE func_gmst0(VALUE self, VALUE vajd){
   double era0 =
   NUM2DBL(func_gmsa0(self, vajd)) / 15.0;
   return DBL2NUM(roundf(era0 * RND12) / RND12);
 }
-
+/*
+ * call-seq:
+ *  gmst(ajd)
+ *
+ * given an Astronomical Julian Day Number
+ * returns Greenwich Mean Sidereal Time in hours.
+ *
+*/
 static VALUE func_gmst(VALUE self, VALUE vajd){
   double vmst = NUM2DBL(func_gmsa(self, vajd)) / 15.0;
   return DBL2NUM(roundf(vmst * RND12) / RND12);
 }
-
+/*
+ * call-seq:
+ *  radius_vector(ajd)
+ *
+ * given an Astronomical Julian Day Number
+ * returns radius vector.
+ *
+*/
 static VALUE func_rv(VALUE self, VALUE vajd){
   double vxv =
   NUM2DBL(func_xv(self, vajd));
@@ -306,7 +407,14 @@ static VALUE func_rv(VALUE self, VALUE vajd){
   sqrt(vxv * vxv + vyv * vyv);
   return DBL2NUM(roundf(vrv * RND12) / RND12);
 }
-
+/*
+ * call-seq:
+ *  ecliptic_x(ajd)
+ *
+ * given an Astronomical Julian Day Number
+ * returns ecliptic x component.
+ *
+*/
 static VALUE func_ecliptic_x(VALUE self, VALUE vajd){
   double vrv =
   NUM2DBL(func_rv(self, vajd));
@@ -315,7 +423,14 @@ static VALUE func_ecliptic_x(VALUE self, VALUE vajd){
   double vex = vrv * cos(vtl);
   return DBL2NUM(roundf(vex * RND12) / RND12);
 }
-
+/*
+ * call-seq:
+ *  ecliptic_y(ajd)
+ *
+ * given an Astronomical Julian Day Number
+ * returns ecliptic y component.
+ *
+*/
 static VALUE func_ecliptic_y(VALUE self, VALUE vajd){
   double vrv =
   NUM2DBL(func_rv(self, vajd));
@@ -324,7 +439,14 @@ static VALUE func_ecliptic_y(VALUE self, VALUE vajd){
   double vey = vrv * sin(vtl);
   return DBL2NUM(roundf(vey * RND12) / RND12);
 }
-
+/*
+ * call-seq:
+ *  right_ascension(ajd)
+ *
+ * given an Astronomical Julian Day Number
+ * returns Right Ascension of Sun in hours.
+ *
+*/
 static VALUE func_right_ascension(VALUE self, VALUE vajd){
   double vey =
   NUM2DBL(func_ecliptic_y(self, vajd));
@@ -336,7 +458,14 @@ static VALUE func_right_ascension(VALUE self, VALUE vajd){
   fmod(atan2(vey * cos(vooe), vex) + M2PI, M2PI);
   return DBL2NUM(fmod(roundf((vra * R2D / 15.0) * RND12) / RND12, 24.0));
 }
-
+/*
+ * call-seq:
+ *  gha(ajd)
+ *
+ * given an Astronomical Julian Day Number
+ * returns Greenwich Hour Angle in degrees.
+ *
+*/
 static VALUE func_gha(VALUE self, VALUE vajd){
   double gmsa =
   NUM2DBL(func_mean_sidetime(self, vajd)) * 15 * D2R;
@@ -345,7 +474,14 @@ static VALUE func_gha(VALUE self, VALUE vajd){
   double gha = anp(gmsa - ra);
   return DBL2NUM(roundf(gha * R2D * RND12) / RND12);
 }
-
+/*
+ * call-seq:
+ *  declination(ajd)
+ *
+ * given an Astronomical Julian Day Number
+ * returns Declination of Sun in degrees.
+ *
+*/
 static VALUE func_declination(VALUE self, VALUE vajd){
   double vex =
   NUM2DBL(func_ecliptic_x(self, vajd));
@@ -358,13 +494,29 @@ static VALUE func_declination(VALUE self, VALUE vajd){
   double vdec = atan2(vz, ver);
   return DBL2NUM(roundf((vdec * R2D) * RND12) / RND12);
 }
-
+/*
+ * call-seq:
+ *  local_sidereal_time(ajd, lon)
+ *
+ * given an Astronomical Julian Day Number and
+ * local Longitude,
+ * returns Local Mean Sidereal Time in hours.
+ *
+*/
 static VALUE func_local_sidetime(VALUE self, VALUE vajd, VALUE vlon){
   double vst = NUM2DBL(func_mean_sidetime(self, vajd));
   double vlst = vst + NUM2DBL(vlon) / 15.0 ;
   return DBL2NUM(fmod(roundf(vlst * RND12) / RND12, 24.0));
 }
-
+/*
+ * call-seq:
+ *  daylight_time(ajd, lat)
+ *
+ * given an Astronomical Julian Day Number and
+ * local Latitude,
+ * returns Hours of Day Light.
+ *
+*/
 static VALUE func_dlt(VALUE self, VALUE vajd, VALUE vlat){
   double jd = floor(NUM2DBL(vajd));
   double vsin_alt = sin(-0.8333 * D2R);
@@ -387,77 +539,152 @@ static VALUE func_dlt(VALUE self, VALUE vajd, VALUE vlat){
   double vdlt = vdla / 15.0 * 2.0;
   return DBL2NUM(roundf(vdlt * RND12) / RND12);
 }
-
+/*
+ * call-seq:
+ *  diurnal_arc(ajd, lat)
+ *
+ * given an Astronomical Julian Day Number and
+ * local Latitude,
+ * returns Hours from Noon or half Day Light Time.
+ *
+*/
 static VALUE func_diurnal_arc(VALUE self, VALUE vajd, VALUE vlat){
   double jd = floor(NUM2DBL(vajd));
   double dlt = NUM2DBL(func_dlt(self, DBL2NUM(jd), vlat));
   double da = dlt / 2.0;
   return DBL2NUM(roundf(da * RND12) / RND12);
 }
-
+/*
+ * call-seq:
+ *  t_south(ajd, lon)
+ *
+ * given an Astronomical Julian Day Number and
+ * local Longitude,
+ * returns Time in Hours when Sun transits local meridian.
+ *
+*/
 static VALUE func_t_south(VALUE self, VALUE vajd, VALUE vlon){
   double jd = floor(NUM2DBL(vajd));
   double lst = NUM2DBL(func_local_sidetime(self, DBL2NUM(jd), vlon));
   double ra = NUM2DBL(func_right_ascension(self, DBL2NUM(jd)));
   double vx = lst - ra;
   double vt = vx - 24.0 * floor(vx * INV24 + 0.5);
-  //printf("%f", jd);
   return DBL2NUM(fmod(roundf((12.0 - vt) * RND12) / RND12, 24.0));
-  //return DBL2NUM(fmod(-vx, 24.0));
-  //return DBL2NUM(lst - ra);
 }
-
+/*
+ * call-seq:
+ *  t_rise(ajd, lat, lon)
+ *
+ * given an Astronomical Julian Day Number and
+ * local Latitude and Longitude,
+ * returns Time in Hours when Sun rises.
+ *
+*/
 static VALUE func_t_rise(VALUE self, VALUE vajd, VALUE vlat, VALUE vlon){
   double ts = NUM2DBL(func_t_south(self, vajd, vlon));
   double da = NUM2DBL(func_diurnal_arc(self, vajd, vlat));
   return DBL2NUM(fmod(roundf((ts - da) * RND12) / RND12, 24.0));
 }
-
+/*
+ * call-seq:
+ *  t_mid_day(ajd, lat, lon)
+ *
+ * given an Astronomical Julian Day Number and
+ * local Latitude and Longitude,
+ * returns Time in Hours when Sun transits local meridian.
+ *
+*/
 static VALUE func_t_mid_day(VALUE self, VALUE vajd, VALUE vlat, VALUE vlon){
   double ts = NUM2DBL(func_t_south(self, vajd, vlon));
   return DBL2NUM(fmod(roundf(ts * RND12) / RND12, 24.0));
 }
-
+/*
+ * call-seq:
+ *  t_set(ajd, lat, lon)
+ *
+ * given an Astronomical Julian Day Number and
+ * local Latitude and Longitude,
+ * returns Time in Hours when Sun sets.
+ *
+*/
 static VALUE func_t_set(VALUE self, VALUE vajd, VALUE vlat, VALUE vlon){
   double ts = NUM2DBL(func_t_south(self, vajd, vlon));
   double da = NUM2DBL(func_diurnal_arc(self, vajd, vlat));
   return DBL2NUM(roundf(fmod((ts + da), 24.0) * RND12) / RND12);
 }
-
+/*
+ * call-seq:
+ *  rise(ajd. lat, lon)
+ *
+ * given an Astronomical Julian Day Number and
+ * local Latitude and Longitude,
+ * returns a Ruby DateTime object when Sun rises.
+ *
+*/
 static VALUE func_rise(VALUE self, VALUE vajd, VALUE vlat, VALUE vlon){
   double rt = NUM2DBL(func_t_rise(self, vajd, vlat, vlon));
   double ajd = NUM2DBL(vajd);
   double rtajd = floor(ajd) - 0.5 + rt / 24.0;
   VALUE vrt = DBL2NUM(rtajd);
-  //VALUE date = rb_sprintf("Sun rises: %2.0f:%02.0f UTC\n",
-  //floor(rt), floor(fmod(rt, 1) * 60.0));
   return func_ajd_2_datetime(self, vrt);
 }
-
+/*
+ * call-seq:
+ *  rise_jd(ajd, lat, lon)
+ *
+ * given an Astronomical Julian Day Number and
+ * local Latitude and Longitude,
+ * returns a Astronomical Julian Day Number when Sun rises.
+ *
+*/
 static VALUE func_rise_jd(VALUE self, VALUE vajd, VALUE vlat, VALUE vlon){
   double rt = NUM2DBL(func_t_rise(self, vajd, vlat, vlon));
   double ajd = NUM2DBL(vajd);
   double rtajd = floor(ajd) - 0.5 + rt / 24.0;
   return DBL2NUM(rtajd);
 }
-
+/*
+ * call-seq:
+ *  noon(ajd, lat, lon)
+ *
+ * given an Astronomical Julian Day Number and
+ * local Latitude and Longitude,
+ * returns a Ruby DateTime object when Sun transits
+ * local meridian.
+ *
+*/
 static VALUE func_noon(VALUE self, VALUE vajd, VALUE vlat, VALUE vlon){
   double nt = NUM2DBL(func_t_south(self, vajd, vlon));
   double ajd = NUM2DBL(vajd);
   double ntajd = floor(ajd) - 0.5 + nt / 24.0;
   VALUE vnt = DBL2NUM(ntajd);
-  //VALUE date = rb_sprintf("Sun noon: %2.0f:%02.0f UTC\n",
-  //floor(nt), floor(fmod(nt, 1.0) * 60.0));
   return func_ajd_2_datetime(self, vnt);
 }
-
+/*
+ * call-seq:
+ *  noon_jd(ajd, lat, lon)
+ *
+ * given an Astronomical Julian Day Number and
+ * local Latitude and Longitude,
+ * returns a Astronomical Julian Day Number when Sun
+ * transits local meridian.
+ *
+*/
 static VALUE func_noon_jd(VALUE self, VALUE vajd, VALUE vlat, VALUE vlon){
   double nt = NUM2DBL(func_t_south(self, vajd, vlon));
   double ajd = NUM2DBL(vajd);
   double ntajd = floor(ajd) - 0.5 + nt / 24.0;
   return DBL2NUM(ntajd);
 }
-
+/*
+ * call-seq:
+ *  set(ajd, lat, lon)
+ *
+ * given an Astronomical Julian Day Number and
+ * local Latitude and Longitude,
+ * returns a Ruby DateTime object when Sun sets.
+ *
+*/
 static VALUE func_set(VALUE self, VALUE vajd, VALUE vlat, VALUE vlon){
   VALUE vst;
   double stajd;
@@ -473,7 +700,15 @@ static VALUE func_set(VALUE self, VALUE vajd, VALUE vlat, VALUE vlon){
   //floor(st), floor(fmod(st, 1.0) * 60.0));
   return func_ajd_2_datetime(self, vst);
 }
-
+/*
+ * call-seq:
+ *  set_jd(ajd, lat, lon)
+ *
+ * given an Astronomical Julian Day Number and
+ * local Latitude and Longitude,
+ * returns a Astronomical Julian Day Number when Sun sets.
+ *
+*/
 static VALUE func_set_jd(VALUE self, VALUE vajd, VALUE vlat, VALUE vlon){
   double stajd;
   double st = NUM2DBL(func_t_set(self, vajd, vlat, vlon));
@@ -485,38 +720,49 @@ static VALUE func_set_jd(VALUE self, VALUE vajd, VALUE vlat, VALUE vlon){
   stajd = floor(ajd) - 0.5 + st / 24.0;
   return DBL2NUM(stajd);
 }
-
-/* Get the days to J2000 h is UT in decimal hours only works between 1901 to 2099
-static inline double
-days_since_2000_Jan_0(int year, int month, int day, double hours){
-  double days_till_J2000;
-  days_till_J2000 = 367 * year - (7 * (
-    year + (month + 9) / 12) / 4) + 275 * month / 9 + day - 730531.5 + hours / 24;
-  return(days_till_J2000);
-}
+/*
+* macro for days since JD 2000
 */
-
 #define days_since_2000_Jan_0(y,m,d) \
     (367L * (y) - ((7 * ((y) + (((m) + 9) / 12))) / 4) + ((275 * (m))  /9) + (d) - 730531.5L)
-
+/*
+ * call-seq:
+ *  jd2000_dif(ajd)
+ *
+ * given an Astronomical Julian Day Number
+ * returns the number of days and decimal time
+ * since JD 2000.
+ *
+*/
 static VALUE func_jd_from_2000(VALUE self, VALUE vajd){
-  /*VALUE vdatetime = func_ajd_2_datetime(self, vajd);
-  int year = NUM2INT(rb_funcall(vdatetime, rb_intern("year"), 0));
-  int month = NUM2INT(rb_funcall(vdatetime, rb_intern("month"), 0));
-  int day = NUM2INT(rb_funcall(vdatetime, rb_intern("day"), 0));
-  double days = days_since_2000_Jan_0(year, month, day);*/
   double ajd = NUM2DBL(vajd);
   double days = ajd - 2451545.0;
   return INT2NUM(days);
 }
-
+/*
+ * call-seq:
+ *  jd2000_dif_lon(ajd, lon)
+ *
+ * given an Astronomical Julian Day Number and
+ * local  Longitude,
+ * returns the number of days and decimal time
+ * since JD 2000.
+ *
+*/
 static VALUE func_days_from_2000(VALUE self, VALUE vajd, VALUE vlon){
   double jd = NUM2DBL(vajd);
   double lon = NUM2DBL(vlon);
   double days = jd - DJ00 - lon / 360;
   return DBL2NUM(roundf(days * RND12) / RND12);
 }
-
+/*
+ * call-seq:
+ *  eot(ajd)
+ *
+ * given an Astronomical Julian Day Number
+ * returns equation of time in degrees
+ *
+*/
 static VALUE func_eot(VALUE self, VALUE vajd){
   double ma =
   NUM2DBL(func_mean_anomaly(self, vajd));
@@ -528,23 +774,57 @@ static VALUE func_eot(VALUE self, VALUE vajd){
   NUM2DBL(func_right_ascension(self, vajd));
   return DBL2NUM(roundf(anp(ma - ta + tl - ra) * R2D * RND12) / RND12 );
 }
-
+/*
+ * call-seq:
+ *  eot_jd(ajd)
+ *
+ * given an Astronomical Julian Day Number
+ * returns equation of time as time of a fractional
+ * day for easy Julian Number work
+ *
+*/
+static VALUE func_eot_jd(VALUE self, VALUE vajd){
+  double veot =
+  NUM2DBL(func_eot(self, vajd));
+  double jdeot = veot / 360.0;
+  return DBL2NUM(roundf(jdeot * RND12) / RND12);
+}
+/*
+ * call-seq:
+ *  eot_min(ajd)
+ *
+ * given an Astronomical Julian Day Number
+ * returns equation of time in minutes
+ *
+*/
 static VALUE func_eot_min(VALUE self, VALUE vajd){
   double eot = NUM2DBL(func_eot(self, vajd));
   return DBL2NUM(roundf((eot / 15 * 60) * RND12) / RND12);
 }
-
-static VALUE func_min_to_s(VALUE self, VALUE vmin){
-  return Qnil;
-}
-
+/*
+ * call-seq:
+ *  lha(ajd, lon)
+ *
+ * given an Astronomical Julian Day Number and
+ * local Longitude,
+ * returns Local Hour Angle in degrees.
+ *
+*/
 static VALUE func_lha(VALUE self, VALUE vajd, VALUE vlon){
   double lon = NUM2DBL(vlon) * D2R;
   double gha = NUM2DBL(func_gha(self, vajd)) * D2R;
   double lha = anp(gha + lon) * R2D;
   return DBL2NUM(roundf(lha * RND12) / RND12);
 }
-
+/*
+ * call-seq:
+ *  altitude(ajd, lat, lon)
+ *
+ * given an Astronomical Julian Day Number and
+ * local Latitude and Longitude,
+ * returns the Altitude of the Sun in degrees.
+ *
+*/
 static VALUE func_altitude(VALUE self, VALUE vajd, VALUE vlat, VALUE vlon){
   double lat = NUM2DBL(vlat) * D2R;
   double delta = NUM2DBL(func_declination(self, vajd)) * D2R;
@@ -554,7 +834,15 @@ static VALUE func_altitude(VALUE self, VALUE vajd, VALUE vlat, VALUE vlon){
     cos(lat) * cos(delta) * cos(lha)) * R2D;
   return DBL2NUM(roundf(alt * RND12) / RND12);
 }
-
+/*
+ * call-seq:
+ *  azimuth(ajd, lat, lon)
+ *
+ * given an Astronomical Julian Day Number and
+ * local Latitude and Longitude,
+ * returns the Azimuth of the Sun in degrees.
+ *
+*/
 static VALUE func_azimuth(VALUE self, VALUE vajd, VALUE vlat, VALUE vlon){
   double lat = NUM2DBL(vlat) * D2R;
   double delta = NUM2DBL(func_declination(self, vajd)) * D2R;
@@ -565,30 +853,50 @@ static VALUE func_azimuth(VALUE self, VALUE vajd, VALUE vlat, VALUE vlon){
             tan(delta) * cos(lat)) * R2D + 180.0;
   return DBL2NUM(roundf(az * RND12) / RND12);
 }
-
+/*
+ * call-seq:
+ *  rise_az(ajd, lat, lon)
+ *
+ * given an Astronomical Julian Day Number and
+ * local Latitude and Longitude,
+ * returns the Azimuth of the Sun rise in degrees.
+ *
+*/
 static VALUE func_rise_az(VALUE self, VALUE vajd, VALUE vlat, VALUE vlon){
   double rjd = NUM2DBL(func_rise_jd(self, vajd, vlat, vlon));
   double raz = NUM2DBL(func_azimuth(self, DBL2NUM(rjd), vlat, vlon));
   return DBL2NUM(raz);
 }
-
+/*
+ * call-seq:
+ *  noon_az(ajd, lat, lon)
+ *
+ * given an Astronomical Julian Day Number and
+ * local Latitude and Longitude,
+ * returns the Azimuth of the Sun at transit in degrees.
+ * Note : should be very close to 180 degrees.
+ *
+*/
 static VALUE func_noon_az(VALUE self, VALUE vajd, VALUE vlat, VALUE vlon){
   double njd = NUM2DBL(func_noon_jd(self, vajd, vlat, vlon));
   double naz = NUM2DBL(func_azimuth(self, DBL2NUM(njd), vlat, vlon));
   return DBL2NUM(naz);
 }
-
+/*
+ * call-seq:
+ *  set_az(ajd, lat, lon)
+ *
+ * given an Astronomical Julian Day Number and
+ * local Latitude and Longitude,
+ * returns the Azimuth of the Sun set in degrees.
+ *
+*/
 static VALUE func_set_az(VALUE self, VALUE vajd, VALUE vlat, VALUE vlon){
   double sjd = NUM2DBL(func_set_jd(self, vajd, vlat, vlon));
   double saz = NUM2DBL(func_azimuth(self, DBL2NUM(sjd), vlat, vlon));
   return DBL2NUM(saz);
 }
 
-static VALUE func_rev12(VALUE self, VALUE vx){
-  double x = NUM2DBL(vx);
-  return DBL2NUM(x - 24.0 * floor(x * INV24 + 0.5));
-}
-
 void Init_calc_sun(void){
   VALUE cCalcSun = rb_define_class("CalcSun", rb_cObject);
   rb_require("date");
@@ -609,9 +917,10 @@ void Init_calc_sun(void){
   rb_define_method(cCalcSun, "eccentric_anomaly", func_eccentric_anomaly, 1);
   rb_define_method(cCalcSun, "ecliptic_x", func_ecliptic_x, 1);
   rb_define_method(cCalcSun, "ecliptic_y", func_ecliptic_y, 1);
+  rb_define_method(cCalcSun, "eot", func_eot, 1);
+  rb_define_method(cCalcSun, "eot_jd", func_eot_jd, 1);
   rb_define_method(cCalcSun, "eot_min", func_eot_min, 1);
   rb_define_method(cCalcSun, "equation_of_center", func_equation_of_center, 1);
-  rb_define_method(cCalcSun, "equation_of_time", func_eot, 1);
   rb_define_method(cCalcSun, "gha", func_gha, 1);
   rb_define_method(cCalcSun, "gmsa0", func_gmsa0, 1);
   rb_define_method(cCalcSun, "gmsa", func_gmsa, 1);
@@ -626,13 +935,11 @@ void Init_calc_sun(void){
   rb_define_method(cCalcSun, "mean_anomaly", func_mean_anomaly, 1);
   rb_define_method(cCalcSun, "mean_longitude", func_mean_longitude, 1);
   rb_define_method(cCalcSun, "mean_sidereal_time", func_mean_sidetime, 1);
-  rb_define_method(cCalcSun, "min_to_s", func_min_to_s, 1);
   rb_define_method(cCalcSun, "noon", func_noon, 3);
   rb_define_method(cCalcSun, "noon_jd", func_noon_jd, 3);
   rb_define_method(cCalcSun, "noon_az", func_noon_az, 3);
   rb_define_method(cCalcSun, "obliquity_of_ecliptic", func_obliquity_of_ecliptic, 1);
   rb_define_method(cCalcSun, "radius_vector", func_rv, 1);
-  rb_define_method(cCalcSun, "reverse_12", func_rev12, 1);
   rb_define_method(cCalcSun, "right_ascension", func_right_ascension, 1);
   rb_define_method(cCalcSun, "rise", func_rise, 3);
   rb_define_method(cCalcSun, "rise_jd", func_rise_jd, 3);

data/lib/calc_sun/version.rb

@@ -2,5 +2,5 @@
 
 # class file CalcSun
 class CalcSun
-  VERSION = '1.2.8'.freeze
+  VERSION = '1.2.9'.freeze
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: calc_sun
 version: !ruby/object:Gem::Version
-  version: 1.2.8
+  version: 1.2.9
 platform: ruby
 authors:
 - Douglas Allen
@@ -30,14 +30,16 @@ cert_chain:
   J4L8DCnzZFU8ARwINSdPvhk8WzXpVgErPQezTziVg7gAtBjqdJO5qVlAiOp+z7m2
   gT57pae1qMGtqvMp
   -----END CERTIFICATE-----
-date: 2017-04-06 00:00:00.000000000 Z
+date: 2017-04-07 00:00:00.000000000 Z
 dependencies: []
 description: |-
-  supply the date as a Julian Day Number, latitude decimal, and
-                          longitude decimal in the calls to each method
+  Given a Julian Day Number of day,
+                          latitude decimal, and
+                          longitude decimal in the calls to instance methods
                           rise(jd, lat, lon),
                           noon(jd, lat, lon), and
                           set(jd, lat, lon)
+                          see source code for more details
 email:
 - kb9agt@gmail.com
 executables: []

metadata.gz.sig

@@ -1,2 +1,3 @@
-gŤ� ����$*�$/e
-�)��_�@�d�l�����>��nLg�I�W���.V�2\;*je�af�U�kU]{������JE:ٺ�,*����r[֥x\�+(^�q��8#w����紡�oF����󓫛gV�^��~\��<�h�u3TV����
��9e����r>'�(6���U�Y=���J���O�Ee��e�S��i�P�l����C�򗶴>A�'Ȗ�
+y���'�2�^����e����8J<�2�itd�E��$9�Ÿ��l��K�QnX'�w�$�B�ᦀ�TzEDF�"Kc�J
+�/p�5�{f|Z�]dQ7�}�mv�G'��c.$P�O��Vq��3�Q�_���'�3)R����lW_
+Q��:5�