astronoby 0.5.0 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 43ef390a6ab6a498edbf148b2af44c906daf73ff9ba61b5aafeadd828fb550e4
-  data.tar.gz: b2cf0743676aa49f95f24c62b3d5d759553014bc52114260a71ecedfb9e6c1cb
+  metadata.gz: 15679e58775b5058f6a154502a3e94731effe12a9c90d0a28c642b96d07aa6b2
+  data.tar.gz: 00f9bcc5a4c0fa4111e33911ba3f1e3da4829edad54e4d1419c0d716f660ea69
 SHA512:
-  metadata.gz: 052bfebf4ddaf6ef3f24883fec090a831d38a9e4124dd5f561d6b1dd7074b6385502396edddd5496ab6066ff93acab4f220ec3aaa244ad0638c0b65fbaace55f
-  data.tar.gz: fe37ac2714328893b068ba958e37a3b057a76ddfa1b299a35f22be005687d3168d20e98ebe571db519bd6cf69227cc0f0dc4c0889dd9ca5bb9d1abb2b1ee550d
+  metadata.gz: b524b994952bfec402e42e69976c5f74d69d51e1d6fbf3b2f21327c9ed0e02011c32d897d09c216f7784c3c286ed69c11beee466207a64051aef536fbc8f5a64
+  data.tar.gz: 5ebbd92e2bb360d2d354800b7f05d35e4e74bce01cae06c8cf8176dae286e8ae70baa39c509c2c3466b05c676d624d4942a4a7cd08546ec895255785645e235b

data/CHANGELOG.md

@@ -1,5 +1,51 @@
 # Changelog
 
+## 0.6.0 - 2024-12-10
+
+_If you are upgrading: please see [UPGRADING.md]._
+
+[UPGRADING.md]: https://github.com/rhannequin/astronoby/blob/main/UPGRADING.md
+
+### Bug fixes
+
+* Fix `ObservationEvents` infinite loop in ([#110])
+* Fix observation events times with local time dates in ([#105])
+* Fix `IncompatibleArgumentsError` on Moon's observation events in ([#111])
+
+### Features
+
+* Add `Astronoby::Moon#current_phase_fraction` in ([#115])
+* Add sources and results for comparison in ([#114])
+
+### Improvements
+
+* Bump standard from 1.36.0 to 1.39.2 by @dependabot in ([#95])
+* Bump standard from 1.39.2 to 1.40.0 by @dependabot in ([#96])
+* Bump dependencies in ([#100])
+* Move dependencies to development ones in ([#99])
+* Bump standard from 1.40.0 to 1.41.1 by @dependabot in ([#104])
+* Bump standard from 1.41.1 to 1.42.0 by @dependabot in ([#107])
+* Bump standard from 1.42.0 to 1.42.1 by @dependabot in ([#108])
+* Bump dependencies in ([#116])
+* Add supported Ruby versions in ([#117])
+
+**Full Changelog**: https://github.com/rhannequin/astronoby/compare/v0.5.0...v0.6.0
+
+[#95]: https://github\.com/rhannequin/astronoby/pull/95
+[#96]: https://github\.com/rhannequin/astronoby/pull/96
+[#99]: https://github\.com/rhannequin/astronoby/pull/99
+[#100]: https://github\.com/rhannequin/astronoby/pull/100
+[#104]: https://github\.com/rhannequin/astronoby/pull/104
+[#105]: https://github\.com/rhannequin/astronoby/pull/105
+[#107]: https://github\.com/rhannequin/astronoby/pull/107
+[#108]: https://github\.com/rhannequin/astronoby/pull/108
+[#110]: https://github\.com/rhannequin/astronoby/pull/110
+[#111]: https://github\.com/rhannequin/astronoby/pull/111
+[#114]: https://github\.com/rhannequin/astronoby/pull/114
+[#115]: https://github\.com/rhannequin/astronoby/pull/115
+[#116]: https://github\.com/rhannequin/astronoby/pull/116
+[#117]: https://github\.com/rhannequin/astronoby/pull/117
+
 ## 0.5.0 - 2024-06-11
 
 _If you are upgrading: please see [UPGRADING.md]._

data/Gemfile.lock

@@ -1,74 +1,69 @@
 PATH
   remote: .
   specs:
-    astronoby (0.5.0)
+    astronoby (0.6.0)
       matrix (~> 0.4.2)
-      rake (~> 13.0)
-      rspec (~> 3.0)
 
 GEM
   remote: https://rubygems.org/
   specs:
     ast (2.4.2)
     diff-lcs (1.5.1)
-    json (2.7.2)
+    json (2.9.0)
     language_server-protocol (3.17.0.3)
     lint_roller (1.1.0)
     matrix (0.4.2)
-    parallel (1.24.0)
-    parser (3.3.1.0)
+    parallel (1.26.3)
+    parser (3.3.6.0)
       ast (~> 2.4.1)
       racc
-    racc (1.7.3)
+    racc (1.8.1)
     rainbow (3.1.1)
     rake (13.2.1)
-    regexp_parser (2.9.1)
-    rexml (3.2.8)
-      strscan (>= 3.0.9)
+    regexp_parser (2.9.3)
     rspec (3.13.0)
       rspec-core (~> 3.13.0)
       rspec-expectations (~> 3.13.0)
       rspec-mocks (~> 3.13.0)
-    rspec-core (3.13.0)
+    rspec-core (3.13.2)
       rspec-support (~> 3.13.0)
-    rspec-expectations (3.13.0)
+    rspec-expectations (3.13.3)
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.13.0)
-    rspec-mocks (3.13.0)
+    rspec-mocks (3.13.2)
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.13.0)
-    rspec-support (3.13.1)
-    rubocop (1.63.5)
+    rspec-support (3.13.2)
+    rubocop (1.68.0)
       json (~> 2.3)
       language_server-protocol (>= 3.17.0)
       parallel (~> 1.10)
       parser (>= 3.3.0.2)
       rainbow (>= 2.2.2, < 4.0)
-      regexp_parser (>= 1.8, < 3.0)
-      rexml (>= 3.2.5, < 4.0)
-      rubocop-ast (>= 1.31.1, < 2.0)
+      regexp_parser (>= 2.4, < 3.0)
+      rubocop-ast (>= 1.32.2, < 2.0)
       ruby-progressbar (~> 1.7)
       unicode-display_width (>= 2.4.0, < 3.0)
-    rubocop-ast (1.31.3)
+    rubocop-ast (1.36.2)
       parser (>= 3.3.1.0)
-    rubocop-performance (1.21.0)
+    rubocop-performance (1.22.1)
       rubocop (>= 1.48.1, < 2.0)
       rubocop-ast (>= 1.31.1, < 2.0)
     ruby-progressbar (1.13.0)
-    standard (1.36.0)
+    rubyzip (2.3.2)
+    standard (1.42.1)
       language_server-protocol (~> 3.17.0.2)
       lint_roller (~> 1.0)
-      rubocop (~> 1.63.0)
+      rubocop (~> 1.68.0)
       standard-custom (~> 1.0.0)
-      standard-performance (~> 1.4)
+      standard-performance (~> 1.5)
     standard-custom (1.0.2)
       lint_roller (~> 1.0)
       rubocop (~> 1.50)
-    standard-performance (1.4.0)
+    standard-performance (1.5.0)
       lint_roller (~> 1.1)
-      rubocop-performance (~> 1.21.0)
-    strscan (3.1.0)
-    unicode-display_width (2.5.0)
+      rubocop-performance (~> 1.22.0)
+    unicode-display_width (2.6.0)
 
 PLATFORMS
   ruby
@@ -76,6 +71,9 @@ PLATFORMS
 
 DEPENDENCIES
   astronoby!
+  rake (~> 13.0)
+  rspec (~> 3.0)
+  rubyzip (~> 2.3)
   standard (~> 1.3)
 
 BUNDLED WITH

data/README.md

@@ -140,32 +140,37 @@ horizontal_coordinates.altitude.str(:dms)
 
 #### Sunrise and sunset times and azimuths
 
+Only date part of the time is relevant for the calculation. The offset must
+be provided to the observer.
+
 ```rb
-time = Time.new(2015, 2, 5)
+utc_offset = "-05:00"
+time = Time.new(2015, 2, 5, 0, 0, 0, utc_offset)
 observer = Astronoby::Observer.new(
   latitude: Astronoby::Angle.from_degrees(38),
-  longitude: Astronoby::Angle.from_degrees(-78)
+  longitude: Astronoby::Angle.from_degrees(-78),
+  utc_offset: utc_offset
 )
 sun = Astronoby::Sun.new(time: time)
 observation_events = sun.observation_events(observer: observer)
 
-observation_events.rising_time
-# => 2015-02-05 12:12:59 UTC
+observation_events.rising_time.getlocal(utc_offset)
+# => 2015-02-05 07:12:59 -0500
 
 observation_events.rising_azimuth.str(:dms)
-# => "+109° 29′ 34.3674″"
+# => "+109° 29′ 35.5069″"
 
-observation_events.transit_time
-# => 2015-02-05 17:25:59 UTC
+observation_events.transit_time.getlocal(utc_offset)
+# => 2015-02-05 12:25:59 -0500
 
 observation_events.transit_altitude.str(:dms)
-# => "+36° 8′ 15.8197″"
+# => "+36° 8′ 14.9673″"
 
-observation_events.setting_time
-# => 2015-02-05 22:39:27 UTC
+observation_events.setting_time.getlocal(utc_offset)
+# => 2015-02-05 17:39:27 -0500
 
 observation_events.setting_azimuth.str(:dms)
-# => "+250° 40′ 42.8609″"
+# => "+250° 40′ 41.7129″"
 ```
 
 #### Twilight times
@@ -244,6 +249,9 @@ moon = Astronoby::Moon.new(time: time)
 moon.illuminated_fraction.round(2)
 # => 0.31
 
+moon.current_phase_fraction.round(2)
+# => 0.82
+
 moon.distance.km.round
 # => 368409
 
@@ -268,32 +276,37 @@ june_phases.each { puts "#{_1.phase}: #{_1.time}" }
 
 #### Moonrise and moonset times and azimuths
 
+Only date part of the time is relevant for the calculation. The offset must
+be provided to the observer.
+
 ```rb
-time = Time.utc(2024, 6, 1, 10, 0, 0)
+utc_offset = "-10:00"
+time = Time.new(2024, 9, 1, 0, 0, 0, utc_offset)
 observer = Astronoby::Observer.new(
-  latitude: Astronoby::Angle.from_degrees(48.8566),
-  longitude: Astronoby::Angle.from_degrees(2.3522)
+  latitude: Astronoby::Angle.from_degrees(-17.5325),
+  longitude: Astronoby::Angle.from_degrees(-149.5677),
+  utc_offset: utc_offset
 )
 moon = Astronoby::Moon.new(time: time)
 observation_events = moon.observation_events(observer: observer)
 
-observation_events.rising_time
-# => 2024-06-01 00:35:36 UTC
+observation_events.rising_time.getlocal(utc_offset)
+# => 2024-09-01 05:24:55 -1000
 
 observation_events.rising_azimuth.str(:dms)
-# => "+93° 7′ 43.2347″"
+# => "+72° 15′ 19.1814″"
 
-observation_events.transit_time
-# => 2024-06-01 02:42:43 UTC
+observation_events.transit_time.getlocal(utc_offset)
+# => 2024-09-01 11:12:32 -1000
 
 observation_events.transit_altitude.str(:dms)
-# => "+26° 59′ 30.9915″"
+# => "+56° 39′ 59.132″"
 
-observation_events.setting_time
-# => 2024-06-01 16:02:26 UTC
+observation_events.setting_time.getlocal(utc_offset)
+# => 2024-09-01 16:12:08 -1000
 
 observation_events.setting_azimuth.str(:dms)
-# => "+273° 29′ 30.0954″"
+# => "+290° 25′ 42.5421″"
 ```
 
 ## Precision

data/benchmark/README.md

@@ -0,0 +1,131 @@
+# Benchmark
+
+This is a first attempt to benchmark the accuracy of the library. It is not
+very scientific, but it gives a rough idea.
+
+## Method
+
+The goal is to answer these two questions:
+- Is the library accurate enough compared to a source of truth?
+- Is the library accurate enough compared with other Ruby libraries?
+
+The source of truth is the <abbr title="Institut de Mécanique
+Céleste et de Calcul des Éphémérides">IMCCE</abbr>, a French public
+institude attached to the Paris Observatory. Their ephemerides are used by
+governements and public institutions in multiple European countries, their
+precesion is among the highest in the world.
+They also provide web services to easily access all their data. Many thanks
+for providing such high accuracy data for free.
+
+The other Ruby library is [sun_calc](https://github.com/fishbrain/sun_calc).
+
+474,336 combinations of dates, latitudes and longitudes have been used to
+produce time predictions for the following events:
+- sunrise
+- sun's highest point
+- sunset
+- moonrise
+- moon's highest point
+- moonset
+
+For each combination, we first find out which of SunCalc or Astronoby is the
+closest to the IMCCE. Then we calculate the difference between Astronoby and
+the IMCCE, to discover if the difference is larger than the defined
+threshold of 5 minutes.
+
+## Results
+
+The following output has been generated using what will be part of version 0.6.
+
+```
+Unarchiving sun_calc.csv.zip...
+Done unarchiving sun_calc.csv.zip.
+Parsing sun_calc.csv...
+Done parsing sun_calc.csv.
+Unarchiving imcce.csv.zip...
+Done unarchiving imcce.csv.zip.
+Parsing imcce.csv...
+Done parsing imcce.csv.
+Comparing data...
+2024-01-01: Done.
+2024-01-02: Done.
+...
+2024-12-30: Done.
+2024-12-31: Done.
+Done comparing data.
+
+
+Sun rising time:
+astronoby: 295395 (62.28%)
+sun_calc: 99710 (21.02%)
+n/a: 79231 (16.7%)
+
+Sun transit time:
+astronoby: 434495 (91.6%)
+sun_calc: 39769 (8.38%)
+n/a: 72 (0.02%)
+
+Sun setting time:
+astronoby: 358428 (75.56%)
+n/a: 79231 (16.7%)
+sun_calc: 36677 (7.73%)
+
+Moon rising time:
+astronoby: 290866 (61.32%)
+n/a: 113815 (23.99%)
+sun_calc: 69655 (14.68%)
+
+Moon transit time:
+astronoby: 341902 (72.08%)
+n/a: 101916 (21.49%)
+sun_calc: 30518 (6.43%)
+
+Moon setting time:
+astronoby: 327099 (68.96%)
+n/a: 114308 (24.1%)
+sun_calc: 32929 (6.94%)
+
+Moon illuminated fraction:
+astronoby: 474336 (100.0%)
+
+Sun rising time too far:
+false: 452887 (95.48%)
+true: 21449 (4.52%)
+
+Sun transit time too far:
+false: 396617 (83.62%)
+true: 77719 (16.38%)
+
+Sun setting time too far:
+false: 453208 (95.55%)
+true: 21128 (4.45%)
+
+Moon rising time too far:
+false: 459044 (96.78%)
+true: 15292 (3.22%)
+
+Moon transit time too far:
+false: 384516 (81.06%)
+true: 89820 (18.94%)
+
+Moon setting time too far:
+false: 459222 (96.81%)
+true: 15114 (3.19%)
+```
+
+## Conclusion
+
+As we can see, Astronoby is more accurate than SunCalc in a vast majority of
+cases. When it comes to the Moon's illuminated fraction, Astronoby is always
+more accurate than SunCalc.
+
+`n/a` values means that at least one of the three sources don't have a value
+for the combination of date, latitude and longitude. This happens because
+the Moon and the Sun cannot always rise, transit and set everywhere on Earth
+every day of the year. Latitudes close to the poles are more likely to miss
+data.
+
+Astronoby can be considered "good enough" for more around 90% of the cases,
+which means there is still work to do if we want to always be less than 5
+minutes away from the what the IMCCE provides. We can notice that transit
+times are those that experience the most significant differences.

data/benchmark/benchmark.rb

@@ -0,0 +1,259 @@
+require "astronoby"
+require "csv"
+require "zip"
+
+class Source
+  NAMES = [
+    ASTRONOBY = "astronoby",
+    IMCCE = "imcce",
+    SUN_CALC = "sun_calc"
+  ].freeze
+
+  attr_accessor :name,
+    :sun_rising_time,
+    :sun_transit_time,
+    :sun_setting_time,
+    :moon_rising_time,
+    :moon_transit_time,
+    :moon_setting_time,
+    :moon_illuminated_fraction
+end
+
+class Comparison
+  SUN_CALC = "sun_calc"
+  ASTRONOBY = "astronoby"
+  NON_APPLICABLE = "n/a"
+
+  TOO_FAR_THRESHOLD = 60 * 5 # 5 minutes
+
+  attr_accessor :sources, :truth
+
+  def initialize
+    @sources = []
+  end
+
+  %i[
+    sun_rising_time
+    sun_transit_time
+    sun_setting_time
+    moon_rising_time
+    moon_transit_time
+    moon_setting_time
+  ].each do |attribute|
+    define_method(:"closest_#{attribute}") do
+      compare(attribute)
+    end
+
+    define_method(:"#{attribute}_too_far?") do
+      too_far?(attribute)
+    end
+  end
+
+  def closest_moon_illuminated_fraction
+    compare(:moon_illuminated_fraction)
+  end
+
+  private
+
+  def compare(attribute)
+    unless truth.public_send(attribute) && sources.all? { |source| source.public_send(attribute) }
+      return NON_APPLICABLE
+    end
+
+    closest_source = sources.min_by do |source|
+      (truth.public_send(attribute) - source.public_send(attribute)).abs
+    end
+
+    closest_source.name
+  end
+
+  def too_far?(attribute)
+    truth_attribute = truth.public_send(attribute)
+    astronoby_attribute = sources
+      .find { _1.name == Source::ASTRONOBY }
+      .public_send(attribute)
+
+    return false unless truth_attribute && astronoby_attribute
+
+    (truth_attribute - astronoby_attribute).abs > TOO_FAR_THRESHOLD
+  end
+end
+
+class Result
+  def initialize
+    @sun_rising_time = []
+    @sun_transit_time = []
+    @sun_setting_time = []
+    @moon_rising_time = []
+    @moon_transit_time = []
+    @moon_setting_time = []
+    @illuminated_fraction = []
+    @sun_rising_time_too_far = []
+    @sun_transit_time_too_far = []
+    @sun_setting_time_too_far = []
+    @moon_rising_time_too_far = []
+    @moon_transit_time_too_far = []
+    @moon_setting_time_too_far = []
+  end
+
+  def add_comparison(comparison)
+    @sun_rising_time << comparison.closest_sun_rising_time
+    @sun_transit_time << comparison.closest_sun_transit_time
+    @sun_setting_time << comparison.closest_sun_setting_time
+    @moon_rising_time << comparison.closest_moon_rising_time
+    @moon_transit_time << comparison.closest_moon_transit_time
+    @moon_setting_time << comparison.closest_moon_setting_time
+    @illuminated_fraction << comparison.closest_moon_illuminated_fraction
+    @sun_rising_time_too_far << comparison.sun_rising_time_too_far?
+    @sun_transit_time_too_far << comparison.sun_transit_time_too_far?
+    @sun_setting_time_too_far << comparison.sun_setting_time_too_far?
+    @moon_rising_time_too_far << comparison.moon_rising_time_too_far?
+    @moon_transit_time_too_far << comparison.moon_transit_time_too_far?
+    @moon_setting_time_too_far << comparison.moon_setting_time_too_far?
+  end
+
+  def display
+    puts "Sun rising time:"
+    tally(@sun_rising_time)
+    puts "Sun transit time:"
+    tally(@sun_transit_time)
+    puts "Sun setting time:"
+    tally(@sun_setting_time)
+    puts "Moon rising time:"
+    tally(@moon_rising_time)
+    puts "Moon transit time:"
+    tally(@moon_transit_time)
+    puts "Moon setting time:"
+    tally(@moon_setting_time)
+    puts "Moon illuminated fraction:"
+    tally(@illuminated_fraction)
+    puts "Sun rising time too far:"
+    tally(@sun_rising_time_too_far)
+    puts "Sun transit time too far:"
+    tally(@sun_transit_time_too_far)
+    puts "Sun setting time too far:"
+    tally(@sun_setting_time_too_far)
+    puts "Moon rising time too far:"
+    tally(@moon_rising_time_too_far)
+    puts "Moon transit time too far:"
+    tally(@moon_transit_time_too_far)
+    puts "Moon setting time too far:"
+    tally(@moon_setting_time_too_far)
+  end
+
+  private
+
+  def tally(data)
+    t = data.tally
+    t.sort_by { |_key, value| -value }.each do |key, value|
+      puts "#{key}: #{value} (#{(value.to_f / t.values.sum * 100).round(2)}%)"
+    end
+    puts "\n"
+  end
+end
+
+data = {}
+result = Result.new
+
+sun_calc_zip_file = File.join(File.dirname(__FILE__), "data/sun_calc.csv.zip")
+imcce_zip_file = File.join(File.dirname(__FILE__), "data/imcce.csv.zip")
+
+puts "Unarchiving sun_calc.csv.zip..."
+
+Zip::File.open(sun_calc_zip_file) do |zip_file|
+  puts "Done unarchiving sun_calc.csv.zip."
+
+  csv_file = zip_file.find { |entry| entry.name.end_with?(".csv") }
+  break unless csv_file
+
+  puts "Parsing sun_calc.csv..."
+
+  csv_content = csv_file.get_input_stream.read
+  CSV.parse(csv_content, headers: true) do |row|
+    data[row["date"]] ||= {}
+    data[row["date"]][row["latitude"]] ||= {}
+    data[row["date"]][row["latitude"]][row["longitude"]] = Comparison.new.tap do |comparison|
+      source = Source.new.tap do |source|
+        source.name = Source::SUN_CALC
+        source.sun_rising_time = Time.new(row["sun_rising_time"]) if row["sun_rising_time"]
+        source.sun_transit_time = Time.new(row["sun_transit_time"]) if row["sun_transit_time"]
+        source.sun_setting_time = Time.new(row["sun_setting_time"]) if row["sun_setting_time"]
+        source.moon_rising_time = Time.new(row["moon_rising_time"]) if row["moon_rising_time"]
+        source.moon_transit_time = Time.new(row["moon_transit_time"]) if row["moon_transit_time"]
+        source.moon_setting_time = Time.new(row["moon_setting_time"]) if row["moon_setting_time"]
+        source.moon_illuminated_fraction = row["illuminated_fraction"].to_f
+      end
+      comparison.sources << source
+    end
+  end
+
+  puts "Done parsing sun_calc.csv."
+end
+
+puts "Unarchiving imcce.csv.zip..."
+
+Zip::File.open(imcce_zip_file) do |zip_file|
+  puts "Done unarchiving imcce.csv.zip."
+
+  csv_file = zip_file.find { |entry| entry.name.end_with?(".csv") }
+  break unless csv_file
+
+  puts "Parsing imcce.csv..."
+
+  csv_content = csv_file.get_input_stream.read
+  CSV.parse(csv_content, headers: true) do |row|
+    comparison = data[row["date"]][row["latitude"]][row["longitude"]]
+    comparison.truth = Source.new.tap do |source|
+      source.name = Source::IMCCE
+      source.sun_rising_time = Time.new(row["sun_rising_time"] + " UTC") if row["sun_rising_time"]
+      source.sun_transit_time = Time.new(row["sun_transit_time"] + " UTC") if row["sun_transit_time"]
+      source.sun_setting_time = Time.new(row["sun_setting_time"] + " UTC") if row["sun_setting_time"]
+      source.moon_rising_time = Time.new(row["moon_rising_time"] + " UTC") if row["moon_rising_time"]
+      source.moon_transit_time = Time.new(row["moon_transit_time"] + " UTC") if row["moon_transit_time"]
+      source.moon_setting_time = Time.new(row["moon_setting_time"] + " UTC") if row["moon_setting_time"]
+      source.moon_illuminated_fraction = row["illuminated_fraction"].to_f
+    end
+  end
+
+  puts "Done parsing imcce.csv."
+end
+
+puts "Comparing data..."
+
+data.each do |date, latitudes|
+  latitudes.each do |latitude, longitudes|
+    longitudes.each do |longitude, comparison|
+      noon = Time.new("#{date}T12:00:00Z")
+      observer = Astronoby::Observer.new(
+        latitude: Astronoby::Angle.from_degrees(latitude.to_i),
+        longitude: Astronoby::Angle.from_degrees(longitude.to_i)
+      )
+      sun = Astronoby::Sun.new(time: noon)
+      sun_observation_events = sun.observation_events(observer: observer)
+      moon = Astronoby::Moon.new(time: noon)
+      moon_observation_events = moon.observation_events(observer: observer)
+
+      source = Source.new.tap do |source|
+        source.name = Source::ASTRONOBY
+        source.sun_rising_time = sun_observation_events.rising_time
+        source.sun_transit_time = sun_observation_events.transit_time
+        source.sun_setting_time = sun_observation_events.setting_time
+        source.moon_rising_time = moon_observation_events.rising_time
+        source.moon_transit_time = moon_observation_events.transit_time
+        source.moon_setting_time = moon_observation_events.setting_time
+        source.moon_illuminated_fraction = moon.illuminated_fraction
+      end
+
+      comparison.sources << source
+      result.add_comparison(comparison)
+    end
+  end
+
+  puts "#{date}: Done."
+end
+
+puts "Done comparing data."
+puts
+puts
+
+puts result.display

data/lib/astronoby/bodies/moon.rb

@@ -167,6 +167,11 @@ module Astronoby
       @illuminated_fraction ||= (1 + phase_angle.cos) / 2
     end
 
+    # @return [Float] Phase fraction, from 0 to 1
+    def current_phase_fraction
+      mean_elongation.degrees / Constants::DEGREES_PER_CIRCLE
+    end
+
     # @param observer [Astronoby::Observer] Observer of the event
     # @return [Astronoby::Events::ObservationEvents] Moon's observation events
     def observation_events(observer:)

data/lib/astronoby/events/observation_events.rb

@@ -7,6 +7,7 @@ module Astronoby
       RISING_SETTING_HOUR_ANGLE_RATIO_RANGE = (-1..1)
       EARTH_SIDEREAL_ROTATION_RATE = 360.98564736629
       ITERATION_PRECISION = 0.0001
+      ITERATION_LIMIT = 5
 
       attr_reader :rising_time,
         :rising_azimuth,
@@ -53,7 +54,11 @@ module Astronoby
 
       def compute
         @initial_transit = initial_transit
-        @transit_time = Util::Time.decimal_hour_to_time(@date, @initial_transit)
+        @transit_time = Util::Time.decimal_hour_to_time(
+          @date,
+          @observer.utc_offset,
+          @initial_transit
+        )
         @transit_altitude = local_horizontal_altitude_transit
 
         return if h0.nil?
@@ -79,20 +84,33 @@ module Astronoby
           Constants::HOURS_PER_DAY * @final_setting
         )
 
-        @rising_time = Util::Time.decimal_hour_to_time(@date, rationalized_corrected_rising)
+        @rising_time = Util::Time.decimal_hour_to_time(
+          @date,
+          @observer.utc_offset,
+          rationalized_corrected_rising
+        )
         @rising_azimuth = local_horizontal_azimuth_rising
-        @transit_time = Util::Time.decimal_hour_to_time(@date, rationalized_corrected_transit)
+        @transit_time = Util::Time.decimal_hour_to_time(
+          @date,
+          @observer.utc_offset,
+          rationalized_corrected_transit
+        )
         @transit_altitude = local_horizontal_altitude_transit
-        @setting_time = Util::Time.decimal_hour_to_time(@date, rationalized_corrected_setting)
+        @setting_time = Util::Time.decimal_hour_to_time(
+          @date,
+          @observer.utc_offset,
+          rationalized_corrected_setting
+        )
         @setting_azimuth = local_horizontal_azimuth_setting
       end
 
       def iterate(initial_rising, initial_transit, initial_setting)
         delta = 1
+        iteration = 1
         corrected_rising = initial_rising
         corrected_transit = initial_transit
         corrected_setting = initial_setting
-        until delta < ITERATION_PRECISION
+        until delta < ITERATION_PRECISION || iteration > ITERATION_LIMIT
           iterate = RiseTransitSetIteration.new(
             observer: @observer,
             date: @date,
@@ -108,6 +126,7 @@ module Astronoby
           corrected_rising = rationalize_decimal_time corrected_rising + iterate[0]
           corrected_transit = rationalize_decimal_time corrected_transit + iterate[1]
           corrected_setting = rationalize_decimal_time corrected_setting + iterate[2]
+          iteration += 1
         end
         [corrected_rising, corrected_transit, corrected_setting]
       end
@@ -155,11 +174,6 @@ module Astronoby
         )
       end
 
-      def leap_day_portion
-        leap_seconds = Util::Time.terrestrial_universal_time_delta(@date)
-        leap_seconds / Constants::SECONDS_PER_DAY
-      end
-
       def local_hour_angle_transit
         gst_transit - observer_longitude - right_ascension_transit
       end
@@ -168,6 +182,8 @@ module Astronoby
         term1 = declination_rising.sin + (-shift).sin * @observer.latitude.cos
         term2 = (-shift).cos * @observer.latitude.cos
         angle = term1 / term2
+        return nil if angle.abs > 1
+
         Angle.acos(angle)
       end
 
@@ -182,14 +198,16 @@ module Astronoby
         term1 = declination_setting.sin + (-shift).sin * @observer.latitude.cos
         term2 = (-shift).cos * @observer.latitude.cos
         angle = term1 / term2
+        return nil if angle.abs > 1
+
         Angle.from_degrees(
           Constants::DEGREES_PER_CIRCLE - Angle.acos(angle).degrees
         )
       end
 
       def rationalize_decimal_time(decimal_time)
-        decimal_time += 1 if decimal_time.negative?
-        decimal_time -= 1 if decimal_time > 1
+        decimal_time += 1 while decimal_time.negative?
+        decimal_time -= 1 while decimal_time > 1
         decimal_time
       end
 
@@ -202,12 +220,14 @@ module Astronoby
       def right_ascension_transit
         Angle.from_degrees(
           Util::Maths.interpolate(
-            [
-              @coordinates_of_the_previous_day.right_ascension.degrees,
-              @coordinates_of_the_day.right_ascension.degrees,
-              @coordinates_of_the_next_day.right_ascension.degrees
-            ],
-            (@final_transit || @initial_transit) + leap_day_portion
+            Util::Maths.normalize_angles_for_interpolation(
+              [
+                @coordinates_of_the_previous_day.right_ascension.degrees,
+                @coordinates_of_the_day.right_ascension.degrees,
+                @coordinates_of_the_next_day.right_ascension.degrees
+              ]
+            ),
+            @final_transit || @initial_transit
           )
         )
       end
@@ -215,12 +235,14 @@ module Astronoby
       def declination_rising
         Angle.from_degrees(
           Util::Maths.interpolate(
-            [
-              @coordinates_of_the_previous_day.declination.degrees,
-              @coordinates_of_the_day.declination.degrees,
-              @coordinates_of_the_next_day.declination.degrees
-            ],
-            @final_rising + leap_day_portion
+            Util::Maths.normalize_angles_for_interpolation(
+              [
+                @coordinates_of_the_previous_day.declination.degrees,
+                @coordinates_of_the_day.declination.degrees,
+                @coordinates_of_the_next_day.declination.degrees
+              ]
+            ),
+            @final_rising
           )
         )
       end
@@ -228,12 +250,14 @@ module Astronoby
       def declination_transit
         Angle.from_degrees(
           Util::Maths.interpolate(
-            [
-              @coordinates_of_the_previous_day.declination.degrees,
-              @coordinates_of_the_day.declination.degrees,
-              @coordinates_of_the_next_day.declination.degrees
-            ],
-            (@final_transit || @initial_transit) + leap_day_portion
+            Util::Maths.normalize_angles_for_interpolation(
+              [
+                @coordinates_of_the_previous_day.declination.degrees,
+                @coordinates_of_the_day.declination.degrees,
+                @coordinates_of_the_next_day.declination.degrees
+              ]
+            ),
+            @final_transit || @initial_transit
           )
         )
       end
@@ -241,12 +265,14 @@ module Astronoby
       def declination_setting
         Angle.from_degrees(
           Util::Maths.interpolate(
-            [
-              @coordinates_of_the_previous_day.declination.degrees,
-              @coordinates_of_the_day.declination.degrees,
-              @coordinates_of_the_next_day.declination.degrees
-            ],
-            @final_setting + leap_day_portion
+            Util::Maths.normalize_angles_for_interpolation(
+              [
+                @coordinates_of_the_previous_day.declination.degrees,
+                @coordinates_of_the_day.declination.degrees,
+                @coordinates_of_the_next_day.declination.degrees
+              ]
+            ),
+            @final_setting
           )
         )
       end

data/lib/astronoby/events/rise_transit_set_iteration.rb

@@ -112,13 +112,6 @@ module Astronoby
       )
     end
 
-    def leap_day_portion
-      @leap_day_portion ||= begin
-        leap_seconds = Util::Time.terrestrial_universal_time_delta(@date)
-        leap_seconds / Constants::SECONDS_PER_DAY
-      end
-    end
-
     def local_hour_angle_rising
       @local_hour_angle_rising ||=
         gst_rising - observer_longitude - right_ascension_rising
@@ -150,12 +143,14 @@ module Astronoby
     def right_ascension_rising
       Angle.from_degrees(
         Util::Maths.interpolate(
-          [
-            @coordinates_of_the_previous_day.right_ascension.degrees,
-            @coordinates_of_the_day.right_ascension.degrees,
-            @coordinates_of_the_next_day.right_ascension.degrees
-          ],
-          @initial_rising + leap_day_portion
+          Util::Maths.normalize_angles_for_interpolation(
+            [
+              @coordinates_of_the_previous_day.right_ascension.degrees,
+              @coordinates_of_the_day.right_ascension.degrees,
+              @coordinates_of_the_next_day.right_ascension.degrees
+            ]
+          ),
+          @initial_rising
         )
       )
     end
@@ -163,12 +158,14 @@ module Astronoby
     def right_ascension_transit
       Angle.from_degrees(
         Util::Maths.interpolate(
-          [
-            @coordinates_of_the_previous_day.right_ascension.degrees,
-            @coordinates_of_the_day.right_ascension.degrees,
-            @coordinates_of_the_next_day.right_ascension.degrees
-          ],
-          @initial_transit + leap_day_portion
+          Util::Maths.normalize_angles_for_interpolation(
+            [
+              @coordinates_of_the_previous_day.right_ascension.degrees,
+              @coordinates_of_the_day.right_ascension.degrees,
+              @coordinates_of_the_next_day.right_ascension.degrees
+            ]
+          ),
+          @initial_transit
         )
       )
     end
@@ -176,12 +173,14 @@ module Astronoby
     def right_ascension_setting
       Angle.from_degrees(
         Util::Maths.interpolate(
-          [
-            @coordinates_of_the_previous_day.right_ascension.degrees,
-            @coordinates_of_the_day.right_ascension.degrees,
-            @coordinates_of_the_next_day.right_ascension.degrees
-          ],
-          @initial_setting + leap_day_portion
+          Util::Maths.normalize_angles_for_interpolation(
+            [
+              @coordinates_of_the_previous_day.right_ascension.degrees,
+              @coordinates_of_the_day.right_ascension.degrees,
+              @coordinates_of_the_next_day.right_ascension.degrees
+            ]
+          ),
+          @initial_setting
         )
       )
     end
@@ -189,12 +188,14 @@ module Astronoby
     def declination_rising
       Angle.from_degrees(
         Util::Maths.interpolate(
-          [
-            @coordinates_of_the_previous_day.declination.degrees,
-            @coordinates_of_the_day.declination.degrees,
-            @coordinates_of_the_next_day.declination.degrees
-          ],
-          @initial_rising + leap_day_portion
+          Util::Maths.normalize_angles_for_interpolation(
+            [
+              @coordinates_of_the_previous_day.declination.degrees,
+              @coordinates_of_the_day.declination.degrees,
+              @coordinates_of_the_next_day.declination.degrees
+            ]
+          ),
+          @initial_rising
         )
       )
     end
@@ -202,12 +203,14 @@ module Astronoby
     def declination_setting
       Angle.from_degrees(
         Util::Maths.interpolate(
-          [
-            @coordinates_of_the_previous_day.declination.degrees,
-            @coordinates_of_the_day.declination.degrees,
-            @coordinates_of_the_next_day.declination.degrees
-          ],
-          @initial_setting + leap_day_portion
+          Util::Maths.normalize_angles_for_interpolation(
+            [
+              @coordinates_of_the_previous_day.declination.degrees,
+              @coordinates_of_the_day.declination.degrees,
+              @coordinates_of_the_next_day.declination.degrees
+            ]
+          ),
+          @initial_setting
         )
       )
     end

data/lib/astronoby/observer.rb

@@ -10,12 +10,18 @@ module Astronoby
     MOLAR_MASS_OF_AIR = 0.0289644
     UNIVERSAL_GAS_CONSTANT = 8.31432
 
-    attr_reader :latitude, :longitude, :elevation, :temperature, :pressure
+    attr_reader :latitude,
+      :longitude,
+      :elevation,
+      :utc_offset,
+      :temperature,
+      :pressure
 
     # @param latitude [Angle] geographic latitude of the observer
     # @param longitude [Angle] geographic longitude of the observer
     # @param elevation [Astronoby::Distance] geographic elevation (or altitude)
     #   of the observer above sea level
+    # @param utc_offset [Numeric, String] offset from Coordinated Universal Time
     # @param temperature [Numeric] temperature at the observer's location in
     #   kelvins
     # @param pressure [Numeric] atmospheric pressure at the observer's
@@ -24,12 +30,14 @@ module Astronoby
       latitude:,
       longitude:,
       elevation: DEFAULT_ELEVATION,
+      utc_offset: 0,
       temperature: DEFAULT_TEMPERATURE,
       pressure: nil
     )
       @latitude = latitude
       @longitude = longitude
       @elevation = elevation
+      @utc_offset = utc_offset
       @temperature = temperature
       @pressure = pressure || compute_pressure
     end
@@ -40,6 +48,7 @@ module Astronoby
       @latitude == other.latitude &&
         @longitude == other.longitude &&
         @elevation == other.elevation &&
+        @utc_offset == other.utc_offset &&
         @temperature == other.temperature &&
         @pressure == other.pressure
     end
@@ -51,6 +60,7 @@ module Astronoby
         @latitude,
         @longitude,
         @elevation,
+        @utc_offset,
         @temperature,
         @pressure
       ].hash

data/lib/astronoby/time/greenwich_sidereal_time.rb

@@ -65,7 +65,7 @@ module Astronoby
 
       utc = SIDEREAL_MINUTE_IN_UT_MINUTE * a
 
-      Util::Time.decimal_hour_to_time(date, utc)
+      Util::Time.decimal_hour_to_time(date, 0, utc)
     end
 
     def to_lst(longitude:)

data/lib/astronoby/util/maths.rb

@@ -29,6 +29,28 @@ module Astronoby
             "Only 3 or 5 terms are supported for interpolation"
         end
 
+        # Fixes angles forced to be in range [0, 360] or other angle range, for
+        # interpolation use
+        # @param angles [Array<Integer|Float>] Angles values
+        # @param full_circle [Integer] Full circle value
+        # @return [Array<Interger|Float>] Normalized values
+        def normalize_angles_for_interpolation(angles, full_circle: 360)
+          normalized = angles.dup
+
+          (1...normalized.size).each do |i|
+            prev_angle = normalized[i - 1]
+
+            while normalized[i] - prev_angle > full_circle / 2
+              normalized[i] -= full_circle
+            end
+            while normalized[i] - prev_angle < -full_circle / 2
+              normalized[i] += full_circle
+            end
+          end
+
+          normalized
+        end
+
         private
 
         # @return [Float] Interpolated value

data/lib/astronoby/util/time.rb

@@ -6,7 +6,7 @@ module Astronoby
       # @param date [Date]
       # @param decimal [Numeric] Hour of the day, in decimal hours
       # @return [::Time] Date and time
-      def self.decimal_hour_to_time(date, decimal)
+      def self.decimal_hour_to_time(date, utc_offset, decimal)
         absolute_hour = decimal.abs
         hour = absolute_hour.floor
 
@@ -25,6 +25,17 @@ module Astronoby
         second = Constants::SECONDS_PER_MINUTE *
           (absolute_decimal_minute - absolute_decimal_minute.floor)
 
+        date_in_local_time = ::Time
+          .utc(date.year, date.month, date.day, hour, minute, second)
+          .getlocal(utc_offset)
+          .to_date
+
+        if date_in_local_time < date
+          date = date.next_day
+        elsif date_in_local_time > date
+          date = date.prev_day
+        end
+
         ::Time.utc(date.year, date.month, date.day, hour, minute, second).round
       end
 

data/lib/astronoby/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Astronoby
-  VERSION = "0.5.0"
+  VERSION = "0.6.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: astronoby
 version: !ruby/object:Gem::Version
-  version: 0.5.0
+  version: 0.6.0
 platform: ruby
 authors:
 - Rémy Hannequin
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-06-11 00:00:00.000000000 Z
+date: 2024-12-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: matrix
@@ -31,7 +31,7 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '13.0'
-  type: :runtime
+  type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
@@ -45,13 +45,27 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.0'
-  type: :runtime
+  type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: rubyzip
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.3'
 - !ruby/object:Gem::Dependency
   name: standard
   requirement: !ruby/object:Gem::Requirement
@@ -86,6 +100,10 @@ files:
 - README.md
 - Rakefile
 - UPGRADING.md
+- benchmark/README.md
+- benchmark/benchmark.rb
+- benchmark/data/imcce.csv.zip
+- benchmark/data/sun_calc.csv.zip
 - lib/astronoby.rb
 - lib/astronoby/aberration.rb
 - lib/astronoby/angle.rb