astronoby 0.6.0 → 0.8.0

data/lib/astronoby.rb

@@ -1,35 +1,63 @@
 # frozen_string_literal: true
 
+require "astronoby/cache"
+require "astronoby/configuration"
 require "astronoby/constants"
 require "astronoby/angle"
 require "astronoby/angles/dms"
 require "astronoby/angles/hms"
+require "astronoby/constellation"
+require "astronoby/constellations/repository"
+require "astronoby/constellations/data"
+require "astronoby/constellations/finder"
 require "astronoby/distance"
-require "astronoby/epoch"
-require "astronoby/astronomical_models/ephemeride_lunaire_parisienne"
+require "astronoby/ephem"
+require "astronoby/julian_date"
+require "astronoby/instant"
+require "astronoby/vector"
+require "astronoby/velocity"
 require "astronoby/astronomical_models/moon_phases_periodic_terms"
+require "astronoby/bodies/solar_system_body"
 require "astronoby/bodies/moon"
 require "astronoby/bodies/sun"
+require "astronoby/bodies/mercury"
+require "astronoby/bodies/venus"
+require "astronoby/bodies/earth"
+require "astronoby/bodies/mars"
+require "astronoby/bodies/jupiter"
+require "astronoby/bodies/saturn"
+require "astronoby/bodies/uranus"
+require "astronoby/bodies/neptune"
 require "astronoby/coordinates/ecliptic"
 require "astronoby/coordinates/equatorial"
 require "astronoby/coordinates/horizontal"
+require "astronoby/corrections/light_time_delay"
 require "astronoby/aberration"
+require "astronoby/deflection"
 require "astronoby/equinox_solstice"
 require "astronoby/errors"
 require "astronoby/events/moon_phases"
-require "astronoby/events/observation_events"
-require "astronoby/events/rise_transit_set_iteration"
+require "astronoby/events/rise_transit_set_event"
+require "astronoby/events/rise_transit_set_events"
+require "astronoby/events/rise_transit_set_calculator"
+require "astronoby/events/twilight_event"
 require "astronoby/events/twilight_events"
+require "astronoby/events/twilight_calculator"
 require "astronoby/geocentric_parallax"
 require "astronoby/mean_obliquity"
 require "astronoby/moon_phase"
 require "astronoby/nutation"
 require "astronoby/observer"
 require "astronoby/precession"
+require "astronoby/reference_frame"
+require "astronoby/reference_frames/geometric"
+require "astronoby/reference_frames/astrometric"
+require "astronoby/reference_frames/mean_of_date"
+require "astronoby/reference_frames/apparent"
+require "astronoby/reference_frames/topocentric"
 require "astronoby/refraction"
 require "astronoby/time/greenwich_sidereal_time"
 require "astronoby/time/local_sidereal_time"
-require "astronoby/util/astrodynamics"
 require "astronoby/util/maths"
 require "astronoby/util/time"
 require "astronoby/util/trigonometry"

metadata

@@ -1,15 +1,28 @@
 --- !ruby/object:Gem::Specification
 name: astronoby
 version: !ruby/object:Gem::Version
-  version: 0.6.0
+  version: 0.8.0
 platform: ruby
 authors:
 - Rémy Hannequin
-autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-12-10 00:00:00.000000000 Z
+date: 1980-01-02 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: ephem
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.3'
 - !ruby/object:Gem::Dependency
   name: matrix
   requirement: !ruby/object:Gem::Requirement
@@ -24,6 +37,34 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 0.4.2
+- !ruby/object:Gem::Dependency
+  name: benchmark
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.4'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.4'
+- !ruby/object:Gem::Dependency
+  name: irb
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.14'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.14'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -58,14 +99,28 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.3'
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.22'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.3'
+        version: '0.22'
 - !ruby/object:Gem::Dependency
   name: standard
   requirement: !ruby/object:Gem::Requirement
@@ -80,65 +135,105 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.3'
-description: Ruby version of the calculations from various books like Celestial Calculations
-  by J. L. Lawrence, Practical Astronomy with your Calculator or Spreadsheet by Peter
-  Duffett-Smith and Jonathan Zwart, or Astronomical Algorithms by Jean Meeus
+description: Astronomy and astrometry Ruby library for astronomical data and events.
 email:
-- hello@rhannequ.in
+- remy.hannequin@gmail.com
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
 - ".rspec"
-- ".tool-versions"
+- ".ruby-version"
+- ".standard.yml"
 - CHANGELOG.md
 - CODE_OF_CONDUCT.md
 - CONTRIBUTING.md
-- Gemfile
-- Gemfile.lock
 - LICENSE.txt
 - README.md
 - Rakefile
 - UPGRADING.md
-- benchmark/README.md
-- benchmark/benchmark.rb
-- benchmark/data/imcce.csv.zip
-- benchmark/data/sun_calc.csv.zip
+- docs/README.md
+- docs/angles.md
+- docs/celestial_bodies.md
+- docs/configuration.md
+- docs/coordinates.md
+- docs/ephem.md
+- docs/equinoxes_solstices_times.md
+- docs/glossary.md
+- docs/instant.md
+- docs/moon_phases.md
+- docs/observer.md
+- docs/reference_frames.md
+- docs/rise_transit_set_times.md
+- docs/twilight_times.md
 - lib/astronoby.rb
 - lib/astronoby/aberration.rb
 - lib/astronoby/angle.rb
 - lib/astronoby/angles/dms.rb
 - lib/astronoby/angles/hms.rb
-- lib/astronoby/astronomical_models/ephemeride_lunaire_parisienne.rb
 - lib/astronoby/astronomical_models/moon_phases_periodic_terms.rb
+- lib/astronoby/bodies/earth.rb
+- lib/astronoby/bodies/jupiter.rb
+- lib/astronoby/bodies/mars.rb
+- lib/astronoby/bodies/mercury.rb
 - lib/astronoby/bodies/moon.rb
+- lib/astronoby/bodies/neptune.rb
+- lib/astronoby/bodies/saturn.rb
+- lib/astronoby/bodies/solar_system_body.rb
 - lib/astronoby/bodies/sun.rb
+- lib/astronoby/bodies/uranus.rb
+- lib/astronoby/bodies/venus.rb
+- lib/astronoby/cache.rb
+- lib/astronoby/configuration.rb
 - lib/astronoby/constants.rb
+- lib/astronoby/constellation.rb
+- lib/astronoby/constellations/data.rb
+- lib/astronoby/constellations/finder.rb
+- lib/astronoby/constellations/repository.rb
 - lib/astronoby/coordinates/ecliptic.rb
 - lib/astronoby/coordinates/equatorial.rb
 - lib/astronoby/coordinates/horizontal.rb
+- lib/astronoby/corrections/light_time_delay.rb
+- lib/astronoby/data/constellations/constellation_names.dat
+- lib/astronoby/data/constellations/indexed_abbreviations.dat
+- lib/astronoby/data/constellations/radec_to_index.dat
+- lib/astronoby/data/constellations/sorted_declinations.dat
+- lib/astronoby/data/constellations/sorted_right_ascensions.dat
+- lib/astronoby/deflection.rb
 - lib/astronoby/distance.rb
-- lib/astronoby/epoch.rb
+- lib/astronoby/ephem.rb
 - lib/astronoby/equinox_solstice.rb
 - lib/astronoby/errors.rb
 - lib/astronoby/events/moon_phases.rb
-- lib/astronoby/events/observation_events.rb
-- lib/astronoby/events/rise_transit_set_iteration.rb
+- lib/astronoby/events/rise_transit_set_calculator.rb
+- lib/astronoby/events/rise_transit_set_event.rb
+- lib/astronoby/events/rise_transit_set_events.rb
+- lib/astronoby/events/twilight_calculator.rb
+- lib/astronoby/events/twilight_event.rb
 - lib/astronoby/events/twilight_events.rb
 - lib/astronoby/geocentric_parallax.rb
+- lib/astronoby/instant.rb
+- lib/astronoby/julian_date.rb
 - lib/astronoby/mean_obliquity.rb
 - lib/astronoby/moon_phase.rb
 - lib/astronoby/nutation.rb
 - lib/astronoby/observer.rb
 - lib/astronoby/precession.rb
+- lib/astronoby/reference_frame.rb
+- lib/astronoby/reference_frames/apparent.rb
+- lib/astronoby/reference_frames/astrometric.rb
+- lib/astronoby/reference_frames/geometric.rb
+- lib/astronoby/reference_frames/mean_of_date.rb
+- lib/astronoby/reference_frames/topocentric.rb
 - lib/astronoby/refraction.rb
 - lib/astronoby/time/greenwich_sidereal_time.rb
 - lib/astronoby/time/local_sidereal_time.rb
 - lib/astronoby/true_obliquity.rb
-- lib/astronoby/util/astrodynamics.rb
 - lib/astronoby/util/maths.rb
 - lib/astronoby/util/time.rb
 - lib/astronoby/util/trigonometry.rb
+- lib/astronoby/vector.rb
+- lib/astronoby/velocity.rb
 - lib/astronoby/version.rb
 homepage: https://github.com/rhannequin/astronoby
 licenses:
@@ -147,7 +242,6 @@ metadata:
   homepage_uri: https://github.com/rhannequin/astronoby
   source_code_uri: https://github.com/rhannequin/astronoby
   changelog_uri: https://github.com/rhannequin/astronoby/blob/main/CHANGELOG.md
-post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -162,8 +256,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.3
-signing_key:
+rubygems_version: 3.7.1
 specification_version: 4
 summary: Astronomical calculations
 test_files: []

data/.tool-versions

@@ -1 +0,0 @@
-ruby 3.2.2

data/Gemfile

@@ -1,5 +0,0 @@
-# frozen_string_literal: true
-
-source "https://rubygems.org"
-
-gemspec

data/Gemfile.lock

@@ -1,80 +0,0 @@
-PATH
-  remote: .
-  specs:
-    astronoby (0.6.0)
-      matrix (~> 0.4.2)
-
-GEM
-  remote: https://rubygems.org/
-  specs:
-    ast (2.4.2)
-    diff-lcs (1.5.1)
-    json (2.9.0)
-    language_server-protocol (3.17.0.3)
-    lint_roller (1.1.0)
-    matrix (0.4.2)
-    parallel (1.26.3)
-    parser (3.3.6.0)
-      ast (~> 2.4.1)
-      racc
-    racc (1.8.1)
-    rainbow (3.1.1)
-    rake (13.2.1)
-    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.2)
-      rspec-support (~> 3.13.0)
-    rspec-expectations (3.13.3)
-      diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.13.0)
-    rspec-mocks (3.13.2)
-      diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.13.0)
-    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 (>= 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.36.2)
-      parser (>= 3.3.1.0)
-    rubocop-performance (1.22.1)
-      rubocop (>= 1.48.1, < 2.0)
-      rubocop-ast (>= 1.31.1, < 2.0)
-    ruby-progressbar (1.13.0)
-    rubyzip (2.3.2)
-    standard (1.42.1)
-      language_server-protocol (~> 3.17.0.2)
-      lint_roller (~> 1.0)
-      rubocop (~> 1.68.0)
-      standard-custom (~> 1.0.0)
-      standard-performance (~> 1.5)
-    standard-custom (1.0.2)
-      lint_roller (~> 1.0)
-      rubocop (~> 1.50)
-    standard-performance (1.5.0)
-      lint_roller (~> 1.1)
-      rubocop-performance (~> 1.22.0)
-    unicode-display_width (2.6.0)
-
-PLATFORMS
-  ruby
-  x86_64-linux
-
-DEPENDENCIES
-  astronoby!
-  rake (~> 13.0)
-  rspec (~> 3.0)
-  rubyzip (~> 2.3)
-  standard (~> 1.3)
-
-BUNDLED WITH
-   2.5.7

data/benchmark/README.md

@@ -1,131 +0,0 @@
-# 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.