korba 0.1.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9653687d464e692461e7f9d1a02bf22c969b9cbd410be77270f2774f04efde50
-  data.tar.gz: d5d043ecefc767e6ba7c158158065cfc42fc3bcda73b47e6f79315c478733b4a
+  metadata.gz: 5b7470c62a2e8df7ed79ca869272a846fad21bed8794ee2b25deff5448cbfb85
+  data.tar.gz: ee043f86462fe065c95245706174aae8945347d91aba211d3fc7f988975c25a3
 SHA512:
-  metadata.gz: 64c57ea852bd747be82d9c0d42a963c1990167d92316447b6ccf338be2fc8e4c9775fb2155f1372939a1aa5d5a2c554a9e4abb213367e13afd51df5bd51b22a2
-  data.tar.gz: 90e986f11ccfa6f197df247339d39e1c928c788e36c0796027a571e09718c83ac75c4f210104ba5b209bc28c3eb183a021cb00e7c2caf08439082a1468dca97b
+  metadata.gz: '0529630074005be970a0cc52aaa583e357cd856daafbcda8d0db1e074a8f5bbd0ab810edc25e721c6fd5b5b6ba2b97bf398e472d4a0ed77b03a465d40ec4d75d'
+  data.tar.gz: ffda7bb7e72c728ba5e7ef4199d5c00cc8b5102c19fb9af9976c95d7b64158e6f4514d3ea289c32225460bfc91481344b98caab4c34016567af0d7d978a8de23

data/CHANGELOG.md

@@ -1,4 +1,11 @@
-## [Unreleased]
+## [0.3.0] - 2024-12-09
+
+- Enable instance creation without arguments
+
+## [0.2.0] - 2024-12-08
+
+- Enable to create tle object from string
+- Enable to calculate height
 
 ## [0.1.0] - 2024-11-30
 

data/README.md

@@ -1,28 +1,55 @@
-# Korba
+[![Gem Version](https://badge.fury.io/rb/korba.svg)](https://rubygems.org/gems/korba)
 
-TODO: Delete this and the text below, and describe your gem
+# Korba
 
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/korba`. To experiment with that code, run `bin/console` for an interactive prompt.
+An orbital analytics library for ruby.
 
 ## Installation
 
-TODO: Replace `UPDATE_WITH_YOUR_GEM_NAME_IMMEDIATELY_AFTER_RELEASE_TO_RUBYGEMS_ORG` with your gem name right after releasing it to RubyGems.org. Please do not do it earlier due to security reasons. Alternatively, replace this section with instructions to install your gem from git if you don't plan to release to RubyGems.org.
-
 Install the gem and add to the application's Gemfile by executing:
 
 ```bash
-bundle add UPDATE_WITH_YOUR_GEM_NAME_IMMEDIATELY_AFTER_RELEASE_TO_RUBYGEMS_ORG
+bundle add korba
 ```
 
 If bundler is not being used to manage dependencies, install the gem by executing:
 
 ```bash
-gem install UPDATE_WITH_YOUR_GEM_NAME_IMMEDIATELY_AFTER_RELEASE_TO_RUBYGEMS_ORG
+gem install korba
 ```
 
 ## Usage
 
-TODO: Write usage instructions here
+### Create Orbital Elements From TLE(Two Line Elements)
+
+```ruby
+orbit = Korba::Tle.new(<<~TLE)
+      ISS (ZARYA)
+      1 25544U 98067A   24342.85930654  .00018474  00000+0  32681-3 0  9991
+      2 25544  51.6381 174.9565 0006817 314.0303 175.4461 15.50337242485488
+    TLE
+
+orbit.semi_major_axis
+# => 6793877.649839985
+
+orbit.height_at_perigee
+# => 411109.2634460889
+
+orbit.height_at_apogee
+# => 420372.03623388056
+
+orbit.to_kep
+# =>
+# #<Korba::Kep:xxxxxxxxxxxxxxxx
+#  @arg_of_pericenter=314.0303,
+#  @eccentricity=0.0006817,
+#  @epoch="2024-12-07T20:37:24.085055",
+#  @inclination=51.6381,
+#  @mean_anomaly=175.4461,
+#  @object_name="ISS (ZARYA)",
+#  @ra_of_asc_node=174.9565,
+#  @semi_major_axis=6793877.649839985>
+```
 
 ## Development
 
@@ -32,4 +59,4 @@ To install this gem onto your local machine, run `bundle exec rake install`. To
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/korba.
+Bug reports and pull requests are welcome on GitHub at https://github.com/kk0000-kk/korba.

data/lib/korba/constant.rb

@@ -2,7 +2,9 @@
 
 module Korba
   class Constant
-    # 3.986004418(8)×10^14 m3/s2
+    # geocentric gravitational constant in m3/s2
     GME = 3.9860044188e14
+    # nominal equatorial Earth radius in m
+    EARTH_RADIUS = 6378137
   end
 end

data/lib/korba/kep.rb

@@ -1,7 +1,10 @@
 # frozen_string_literal: true
+require_relative "orbit_utils"
 
 module Korba
   class Kep
+    include Korba::OrbitUtils
+
     attr_reader :object_name, :epoch, :semi_major_axis, :eccentricity, :inclination, :ra_of_asc_node, :arg_of_pericenter, :mean_anomaly
 
     def initialize(object_name:, epoch:, semi_major_axis:, eccentricity:, inclination:, ra_of_asc_node:, arg_of_pericenter:, mean_anomaly:)

data/lib/korba/orbit_utils.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module Korba
+  module OrbitUtils
+    def semi_major_axis
+      # a = (μ / n^2)^(1/3) m
+      (Korba::Constant::GME / (mean_motion * 2 * Math::PI / 86400.0) ** 2.0) ** (1.0 / 3.0)
+    end
+
+    def height_at_perigee
+      semi_major_axis * (1 - eccentricity) - Korba::Constant::EARTH_RADIUS
+    end
+
+    def height_at_apogee
+      semi_major_axis * (1 + eccentricity) - Korba::Constant::EARTH_RADIUS
+    end
+  end
+end

data/lib/korba/tle.rb

@@ -1,24 +1,21 @@
 # frozen_string_literal: true
+require_relative "orbit_utils"
+
 module Korba
   class Tle
+    include Korba::OrbitUtils
+
     attr_reader :tle_json, :object_name, :object_id, :epoch, :mean_motion, :eccentricity, :inclination, :ra_of_asc_node, :arg_of_pericenter, :mean_anomaly
 
-    def initialize(tle_json)
-      @tle_json = tle_json
-      @object_name = tle_json[:OBJECT_NAME]
-      @object_id = tle_json[:OBJECT_ID]
-      @epoch = tle_json[:EPOCH]
-      @mean_motion = tle_json[:MEAN_MOTION]
-      @eccentricity = tle_json[:ECCENTRICITY]
-      @inclination = tle_json[:INCLINATION]
-      @ra_of_asc_node = tle_json[:RA_OF_ASC_NODE]
-      @arg_of_pericenter = tle_json[:ARG_OF_PERICENTER]
-      @mean_anomaly = tle_json[:MEAN_ANOMALY]
-    end
+    def initialize(tle = nil, type: :string)
+      return if tle.nil?
 
-    def semi_major_axis
-      # a = (μ / n^2)^(1/3) m
-      (Korba::Constant::GME / (mean_motion * 2 * Math::PI / 86400.0) ** 2.0) ** (1.0 / 3.0)
+      case type
+      when :string
+        initialize_from_string(tle)
+      when :json
+        initialize_from_json(tle)
+      end
     end
 
     def to_kep
@@ -31,5 +28,46 @@ module Korba
                      arg_of_pericenter:,
                      mean_anomaly:)
     end
+
+    private
+
+    def initialize_from_string(tle_string)
+      lines = tle_string.split(/\R/)
+      @object_name = lines.shift if lines.size > 2
+      parse_line1(lines[0].split(" "))
+      parse_line2(lines[1].split(" "))
+    end
+
+    def parse_line1(line1_strings)
+      # TODO: object_id
+      # For now, only supports years after 2000
+      epoch_year = line1_strings[3][0..1].to_i + 2000
+      epoch_day_of_year = line1_strings[3][2..].to_f
+      # Subtract 1 from epoch_day_of_year because January 1st is considered day 1
+      epoch_time = Time.new(epoch_year, 1, 1, 0, 0, 0, "+00:00") + (epoch_day_of_year - 1) * 24 * 60 * 60
+      @epoch = epoch_time.strftime("%Y-%m-%dT%H:%M:%S.%6N")
+    end
+
+    def parse_line2(line2_strings)
+      @inclination = line2_strings[2].to_f
+      @ra_of_asc_node = line2_strings[3].to_f
+      @eccentricity = "0.#{line2_strings[4]}".to_f
+      @arg_of_pericenter = line2_strings[5].to_f
+      @mean_anomaly = line2_strings[6].to_f
+      @mean_motion = line2_strings[7].to_f
+    end
+
+    def initialize_from_json(tle_json)
+      @tle_json = tle_json
+      @object_name = tle_json[:OBJECT_NAME]
+      @object_id = tle_json[:OBJECT_ID]
+      @epoch = tle_json[:EPOCH]
+      @mean_motion = tle_json[:MEAN_MOTION]
+      @eccentricity = tle_json[:ECCENTRICITY]
+      @inclination = tle_json[:INCLINATION]
+      @ra_of_asc_node = tle_json[:RA_OF_ASC_NODE]
+      @arg_of_pericenter = tle_json[:ARG_OF_PERICENTER]
+      @mean_anomaly = tle_json[:MEAN_ANOMALY]
+    end
   end
 end

data/lib/korba/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Korba
-  VERSION = "0.1.0"
+  VERSION = "0.3.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: korba
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.3.0
 platform: ruby
 authors:
 - kk0000-kk
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-12-07 00:00:00.000000000 Z
+date: 2024-12-09 00:00:00.000000000 Z
 dependencies: []
 description: Orbital elements calculation library
 email:
@@ -24,6 +24,7 @@ files:
 - lib/korba.rb
 - lib/korba/constant.rb
 - lib/korba/kep.rb
+- lib/korba/orbit_utils.rb
 - lib/korba/tle.rb
 - lib/korba/version.rb
 - sig/korba.rbs