astronoby 0.9.0 → 0.10.0

data/lib/astronoby/velocity.rb

@@ -1,19 +1,32 @@
 # frozen_string_literal: true
 
 module Astronoby
+  # Represents a velocity with meters per second as its internal
+  # representation. Provides conversions between m/s, km/s, km/day,
+  # and AU/day.
+  #
+  # @example Create a velocity from km/s
+  #   velocity = Astronoby::Velocity.from_kmps(29.78)
+  #   velocity.aupd  # AU per day
+  #
   class Velocity
     include Comparable
 
     class << self
+      # @return [Astronoby::Velocity] a zero velocity
       def zero
         new(0)
       end
 
+      # @param meters_per_second [Numeric] the velocity in m/s
+      # @return [Astronoby::Velocity] a new Velocity
       def from_meters_per_second(meters_per_second)
         new(meters_per_second)
       end
       alias_method :from_mps, :from_meters_per_second
 
+      # @param kilometers_per_second [Numeric] the velocity in km/s
+      # @return [Astronoby::Velocity] a new Velocity
       def from_kilometers_per_second(kilometers_per_second)
         meters_per_second = kilometers_per_second *
           Constants::KILOMETER_IN_METERS
@@ -21,6 +34,8 @@ module Astronoby
       end
       alias_method :from_kmps, :from_kilometers_per_second
 
+      # @param kilometers_per_day [Numeric] the velocity in km/day
+      # @return [Astronoby::Velocity] a new Velocity
       def from_kilometers_per_day(kilometers_per_day)
         meters_per_second = kilometers_per_day *
           Constants::KILOMETER_IN_METERS / Constants::SECONDS_PER_DAY
@@ -28,6 +43,8 @@ module Astronoby
       end
       alias_method :from_kmpd, :from_kilometers_per_day
 
+      # @param astronomical_units_per_day [Numeric] the velocity in AU/day
+      # @return [Astronoby::Velocity] a new Velocity
       def from_astronomical_units_per_day(astronomical_units_per_day)
         meters_per_second = astronomical_units_per_day *
           Constants::ASTRONOMICAL_UNIT_IN_METERS / Constants::SECONDS_PER_DAY
@@ -35,82 +52,104 @@ module Astronoby
       end
       alias_method :from_aupd, :from_astronomical_units_per_day
 
+      # @param array [Array<Numeric>] array of m/s values
+      # @return [Astronoby::Vector<Astronoby::Velocity>] a vector of Velocities
       def vector_from_meters_per_second(array)
         Vector.elements(array.map { from_mps(_1) })
       end
       alias_method :vector_from_mps, :vector_from_meters_per_second
 
+      # @param array [Array<Numeric>] array of AU/day values
+      # @return [Astronoby::Vector<Astronoby::Velocity>] a vector of Velocities
       def vector_from_astronomical_units_per_day(array)
         Vector.elements(array.map { from_aupd(_1) })
       end
       alias_method :vector_from_aupd, :vector_from_astronomical_units_per_day
 
+      # @return [Astronoby::Velocity] the speed of light in vacuum
       def light_speed
         from_meters_per_second(Constants::LIGHT_SPEED_M_PER_S)
       end
     end
 
+    # @return [Numeric] the velocity in meters per second
     attr_reader :meters_per_second
     alias_method :mps, :meters_per_second
 
+    # @param meters_per_second [Numeric] the velocity in m/s
     def initialize(meters_per_second)
       @meters_per_second = meters_per_second
       freeze
     end
 
+    # @return [Float] the velocity in kilometers per second
     def kilometers_per_second
       @meters_per_second / Constants::KILOMETER_IN_METERS.to_f
     end
     alias_method :kmps, :kilometers_per_second
 
+    # @return [Float] the velocity in kilometers per day
     def kilometers_per_day
       @meters_per_second * Constants::SECONDS_PER_DAY /
         Constants::KILOMETER_IN_METERS
     end
     alias_method :kmpd, :kilometers_per_day
 
+    # @return [Float] the velocity in astronomical units per day
     def astronomical_units_per_day
       @meters_per_second * Constants::SECONDS_PER_DAY /
         Constants::ASTRONOMICAL_UNIT_IN_METERS
     end
     alias_method :aupd, :astronomical_units_per_day
 
+    # @param other [Astronoby::Velocity] velocity to add
+    # @return [Astronoby::Velocity] the sum
     def +(other)
       self.class.from_meters_per_second(
         @meters_per_second + other.meters_per_second
       )
     end
 
+    # @param other [Astronoby::Velocity] velocity to subtract
+    # @return [Astronoby::Velocity] the difference
     def -(other)
       self.class.from_meters_per_second(
         @meters_per_second - other.meters_per_second
       )
     end
 
+    # @return [Astronoby::Velocity] the negated velocity
     def -@
       self.class.from_meters_per_second(-@meters_per_second)
     end
 
+    # @return [Boolean] true if the velocity is positive
     def positive?
       @meters_per_second > 0
     end
 
+    # @return [Boolean] true if the velocity is negative
     def negative?
       @meters_per_second < 0
     end
 
+    # @return [Boolean] true if the velocity is zero
     def zero?
       @meters_per_second.zero?
     end
 
+    # @return [Numeric] the square of the velocity in (m/s)^2
     def abs2
       @meters_per_second**2
     end
 
+    # @return [Integer] hash value
     def hash
       [@meters_per_second, self.class].hash
     end
 
+    # @param other [Astronoby::Velocity] velocity to compare with
+    # @return [Integer, nil] -1, 0, or 1; nil if not comparable
     def <=>(other)
       return unless other.is_a?(self.class)
 

data/lib/astronoby/version.rb

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

data/lib/astronoby.rb

@@ -12,6 +12,10 @@ require "astronoby/constellations/repository"
 require "astronoby/constellations/data"
 require "astronoby/constellations/finder"
 require "astronoby/distance"
+require "astronoby/duration"
+require "astronoby/center"
+require "astronoby/body"
+require "astronoby/position"
 require "astronoby/ephem"
 require "astronoby/julian_date"
 require "astronoby/instant"
@@ -31,14 +35,23 @@ require "astronoby/bodies/uranus"
 require "astronoby/bodies/neptune"
 require "astronoby/coordinates/ecliptic"
 require "astronoby/coordinates/equatorial"
+require "astronoby/coordinates/geodetic"
 require "astronoby/coordinates/horizontal"
 require "astronoby/corrections/light_time_delay"
 require "astronoby/aberration"
 require "astronoby/bodies/deep_sky_object"
 require "astronoby/bodies/deep_sky_object_position"
 require "astronoby/deflection"
+require "astronoby/earth_rotation"
 require "astronoby/equinox_solstice"
 require "astronoby/errors"
+require "astronoby/extremum_finder"
+require "astronoby/root_finder"
+require "astronoby/events/conjunction"
+require "astronoby/events/opposition"
+require "astronoby/events/greatest_elongation"
+require "astronoby/events/conjunction_opposition_calculator"
+require "astronoby/events/greatest_elongation_calculator"
 require "astronoby/events/extremum_event"
 require "astronoby/events/extremum_calculator"
 require "astronoby/events/moon_phases"
@@ -48,11 +61,16 @@ require "astronoby/events/rise_transit_set_calculator"
 require "astronoby/events/twilight_event"
 require "astronoby/events/twilight_events"
 require "astronoby/events/twilight_calculator"
+require "astronoby/events/eclipse_phase"
+require "astronoby/events/lunar_eclipse"
+require "astronoby/events/lunar_eclipse_calculator"
 require "astronoby/geocentric_parallax"
+require "astronoby/libration"
 require "astronoby/mean_obliquity"
 require "astronoby/moon_phase"
 require "astronoby/nutation"
 require "astronoby/observer"
+require "astronoby/rotation"
 require "astronoby/precession"
 require "astronoby/reference_frame"
 require "astronoby/reference_frames/geometric"
@@ -60,6 +78,7 @@ require "astronoby/reference_frames/astrometric"
 require "astronoby/reference_frames/mean_of_date"
 require "astronoby/reference_frames/apparent"
 require "astronoby/reference_frames/topocentric"
+require "astronoby/reference_frames/teme"
 require "astronoby/refraction"
 require "astronoby/stellar_propagation"
 require "astronoby/time/sidereal_time"
@@ -73,4 +92,7 @@ require "astronoby/util/maths"
 require "astronoby/util/time"
 require "astronoby/util/trigonometry"
 require "astronoby/true_obliquity"
+require "astronoby/orientation"
+require "astronoby/moon_physical_ephemeris"
+require "astronoby/moon_orientation_ephemeris"
 require "astronoby/version"

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: astronoby
 version: !ruby/object:Gem::Version
-  version: 0.9.0
+  version: 0.10.0
 platform: ruby
 authors:
 - Rémy Hannequin
@@ -15,14 +15,28 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.3'
+        version: '0.5'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.3'
+        version: '0.5'
+- !ruby/object:Gem::Dependency
+  name: iers
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.1'
 - !ruby/object:Gem::Dependency
   name: matrix
   requirement: !ruby/object:Gem::Requirement
@@ -160,9 +174,13 @@ files:
 - docs/ephem.md
 - docs/equinoxes_solstices_times.md
 - docs/glossary.md
+- docs/iers.md
 - docs/instant.md
+- docs/lunar_eclipses.md
+- docs/lunar_observation.md
 - docs/moon_phases.md
 - docs/observer.md
+- docs/planetary_phenomena.md
 - docs/reference_frames.md
 - docs/rise_transit_set_times.md
 - docs/solar_system_bodies.md
@@ -187,7 +205,9 @@ files:
 - lib/astronoby/bodies/sun.rb
 - lib/astronoby/bodies/uranus.rb
 - lib/astronoby/bodies/venus.rb
+- lib/astronoby/body.rb
 - lib/astronoby/cache.rb
+- lib/astronoby/center.rb
 - lib/astronoby/configuration.rb
 - lib/astronoby/constants.rb
 - lib/astronoby/constellation.rb
@@ -196,6 +216,7 @@ files:
 - lib/astronoby/constellations/repository.rb
 - lib/astronoby/coordinates/ecliptic.rb
 - lib/astronoby/coordinates/equatorial.rb
+- lib/astronoby/coordinates/geodetic.rb
 - lib/astronoby/coordinates/horizontal.rb
 - lib/astronoby/corrections/light_time_delay.rb
 - lib/astronoby/data/constellations/constellation_names.dat
@@ -205,33 +226,52 @@ files:
 - lib/astronoby/data/constellations/sorted_right_ascensions.dat
 - lib/astronoby/deflection.rb
 - lib/astronoby/distance.rb
+- lib/astronoby/duration.rb
+- lib/astronoby/earth_rotation.rb
 - lib/astronoby/ephem.rb
 - lib/astronoby/equinox_solstice.rb
 - lib/astronoby/errors.rb
+- lib/astronoby/events/conjunction.rb
+- lib/astronoby/events/conjunction_opposition_calculator.rb
+- lib/astronoby/events/eclipse_phase.rb
 - lib/astronoby/events/extremum_calculator.rb
 - lib/astronoby/events/extremum_event.rb
+- lib/astronoby/events/greatest_elongation.rb
+- lib/astronoby/events/greatest_elongation_calculator.rb
+- lib/astronoby/events/lunar_eclipse.rb
+- lib/astronoby/events/lunar_eclipse_calculator.rb
 - lib/astronoby/events/moon_phases.rb
+- lib/astronoby/events/opposition.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/extremum_finder.rb
 - lib/astronoby/geocentric_parallax.rb
 - lib/astronoby/instant.rb
 - lib/astronoby/julian_date.rb
+- lib/astronoby/libration.rb
 - lib/astronoby/mean_obliquity.rb
+- lib/astronoby/moon_orientation_ephemeris.rb
 - lib/astronoby/moon_phase.rb
+- lib/astronoby/moon_physical_ephemeris.rb
 - lib/astronoby/nutation.rb
 - lib/astronoby/observer.rb
+- lib/astronoby/orientation.rb
+- lib/astronoby/position.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/teme.rb
 - lib/astronoby/reference_frames/topocentric.rb
 - lib/astronoby/refraction.rb
+- lib/astronoby/root_finder.rb
+- lib/astronoby/rotation.rb
 - lib/astronoby/stellar_propagation.rb
 - lib/astronoby/time/greenwich_apparent_sidereal_time.rb
 - lib/astronoby/time/greenwich_mean_sidereal_time.rb
@@ -261,14 +301,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 3.0.0
+      version: 3.2.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.7.1
+rubygems_version: 4.0.10
 specification_version: 4
 summary: Astronomical calculations
 test_files: []