kerbaldyn 0.7.0

data/.rspec

@@ -0,0 +1,2 @@
+--colour
+--format documentation

data/Gemfile

@@ -0,0 +1,11 @@
+source 'https://rubygems.org'
+
+gemspec
+
+gem 'rake'
+gem 'rdoc'
+
+group :test do
+  gem 'rspec'
+  gem 'debugger'
+end

data/README.rdoc

@@ -0,0 +1,57 @@
+= Overview
+
+A library for Kerbal Space Program (KSP) calculation and simulation tools.
+
+<b>All units are mks (meters-kilograms-seconds) and all angles are radians.</b>
+
+= Major Classes
+
+[Planetoid] - Encapsulates parameters relating to suns, planets, and moons, such as Kerbal and Mun.
+[Orbit] - Encapsulates parameters relating to orbits about a body.
+[Maneuver] - Encapsulates parameters for orbit changes.
+
+= Author
+
+Jeff Reinecke
+jeff@paploo.net
+
+= TODO
+
+* Refactor planetoid and orbit tests to use a JSON data file from a game dump.
+* Add bielliptic transfer and tests.
+* Build a tool for calculating lead angles: kerbaldyn leadangle kerbin@100a mun
+* Build a tool for outputting body information in standard units: kerbaldyn info minmus
+* Build a tool for calculating the delta-v of hohmann vs various bielliptic transfers: kerbaldyn transfer kerbin@900r minmus
+* Build a tool for listing parts of a type with important specs, sorted in useful ways: kerbaldyn partlist --type liquidfuelengine --sort isp
+
+Notes:
+* Remember that bielliptic transfer high altitudes are theoretically limited by the SOI.
+* Can specify orbits by planet@400a or planet@400r for 400km alt or 400km radius respectively.
+
+= License
+
+  Copyright (c) 2012, Jeffrey C. Reinecke
+  All rights reserved.
+
+  Redistribution and use in source and binary forms, with or without
+  modification, are permitted provided that the following conditions are met:
+      * Redistributions of source code must retain the above copyright
+        notice, this list of conditions and the following disclaimer.
+      * Redistributions in binary form must reproduce the above copyright
+        notice, this list of conditions and the following disclaimer in the
+        documentation and/or other materials provided with the distribution.
+      * Neither the name of the copyright holders nor the
+        names of its contributors may be used to endorse or promote products
+        derived from this software without specific prior written permission.
+
+  THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
+  ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
+  WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+  DISCLAIMED. IN NO EVENT SHALL JEFFREY REINECKE BE LIABLE FOR ANY
+  DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
+  (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
+  LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
+  ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
+  (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
+  SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+

data/Rakefile

@@ -0,0 +1,23 @@
+require 'pathname'
+require 'rdoc/task'
+require 'rspec/core/rake_task'
+
+
+RDoc::Task.new do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.rdoc_files.add 'README.rdoc', 'LICENSE.txt', 'lib/**/*.rb'
+end
+
+RSpec::Core::RakeTask.new do |spec|
+end
+
+
+desc 'List all code todo lines'
+task :todo do
+  project_path = Pathname.new(__FILE__).dirname.expand_path
+  search_paths = ['bin', 'lib', 'spec', 'util', 'Gemfile', 'kerbaldyn.gemspec']
+  cmd = "grep --color -REn 'TODO' #{search_paths.map {|sp| project_path+sp}.join(' ')}"
+  puts cmd
+  puts '-' * 72
+  exec(cmd)
+end

data/kerbaldyn.gemspec

@@ -0,0 +1,30 @@
+require File.join(File.dirname(__FILE__), 'lib', 'kerbaldyn', 'version')
+
+Gem::Specification.new do |s|
+  s.name = 'kerbaldyn'
+  s.version = KerbalDyn::VERSION
+
+  s.authors = ['Jeff Reinecke']
+  s.email = 'jeff@paploo.net'
+  s.homepage = 'http://www.github.com/paploo/kerbal-dyn'
+  s.summary = 'A library for Kerbal Space Program (KSP) calculation and simulation tools.'
+  s.description = 'A library for Kerbal Space Program (KSP) calculation and simulation tools.'
+  s.licenses = ['BSD']
+
+  s.required_ruby_version = '>=1.9.0'
+  s.require_paths = ['lib']
+  s.files = Dir[
+    'README.rdoc',
+    'Rakefile',
+    'Gemfile',
+    'LICENSE',
+    'lib/**/*',
+    'bin/**/*',
+    'spec/**/*',
+    '.rspec',
+    '*.gemspec'
+  ]
+
+  s.has_rdoc = true
+  s.extra_rdoc_files = ['README.rdoc']
+end

data/lib/kerbaldyn.rb

@@ -0,0 +1,14 @@
+require_relative 'kerbaldyn/version'
+
+require_relative 'kerbaldyn/data'
+
+require_relative 'kerbaldyn/constants'
+require_relative 'kerbaldyn/mixin'
+
+require_relative 'kerbaldyn/part'
+require_relative 'kerbaldyn/part_library'
+
+require_relative 'kerbaldyn/body'
+require_relative 'kerbaldyn/planetoid'
+require_relative 'kerbaldyn/orbit'
+require_relative 'kerbaldyn/orbital_maneuver'

data/lib/kerbaldyn/body.rb

@@ -0,0 +1,48 @@
+module KerbalDyn
+  # The superclass for all Planetoid and Satellite instances.
+  class Body
+    include Mixin::ParameterAttributes
+    include Mixin::OptionsProcessor
+    
+    # Options default.  (Unlisted options will be nil)
+    DEFAULT_OPTIONS = {
+      :mass => 0.0,
+      :bounding_sphere_radius => 0.0,
+      :angular_velocity => 0.0
+    }
+
+    def self.test_particle
+      return self.new("Test Particle", :mass => 0.0, :bounding_sphere_radius => 0.0)
+    end
+
+    # Create a body with the given name and options.
+    #
+    # The options are:
+    # [mass] The mass of the body.
+    # [bounding_sphere_radius] The bounding sphere radius.
+    # [angular_velocity] The angular velocity around the axis of rotation.
+    def initialize(name, options={})
+      @name = name
+      process_options(options, DEFAULT_OPTIONS)
+    end
+
+    # The mass of the body.
+    attr_parameter :mass
+
+    # The bounding sphere radius
+    attr_parameter :bounding_sphere_radius
+
+    # The angluar velocity around the axis of rotation.
+    attr_parameter :angular_velocity
+
+    # The name of the body.
+    attr_accessor :name
+
+    # Sets the name of the body.
+    def name=(name)
+      @name = name && name.to_s
+    end
+
+    TEST_PARTICLE = self.test_particle
+  end
+end

data/lib/kerbaldyn/constants.rb

@@ -0,0 +1,12 @@
+module KerbalDyn
+  # Definition of Physical constants.
+  #
+  # Note that known planetoid and orbital parameters are created via factory
+  # methods on the appropriate class.
+  module Constants
+
+    # Newton's gravitational constant.
+    G = 6.67300e-11
+
+  end
+end

data/lib/kerbaldyn/data.rb

@@ -0,0 +1,56 @@
+require 'pathname'
+
+module KerbalDyn
+  # :nodoc: all
+  #
+  # A class for doing the work of getting and maintaining singletons of data resources.
+  #
+  # NOTE: There is NO reason a client to the library shoudl be in here; indeed, this
+  # is likely to drastically change, so using this class directly will result in
+  # trouble later.
+  class Data
+    # Files added here are automatically recognized by the fetch method.
+    # Files must be in the data directory.
+    FILE_MAP = {
+      :planet_data => 'planet_data.json'
+    }
+
+    # Fetch a data singleton by the stored key.
+    #
+    # If the key is unknown, then it attempts to fetch the data from disk.
+    def self.fetch(key)
+      registry = self.registry
+      data_obj = registry.include?(key) ? registry[key] : registry[key]=self.new(key, FILE_MAP[key])
+      return data_obj.data
+    end
+
+    # A method for directly getting the registry; this shoudl typically be treated as private.
+    def self.registry
+      return @registry ||= {}
+    end
+
+    # Initialize with the given key and data file name (in the data directory).
+    # This does NOT auto-add to the registry.  Fetch will do so for entries in
+    # FILE_MAP.
+    def initialize(key, data_file_name)
+      # Get a handle on the file.
+      data_file = Pathname.new(__FILE__).dirname + 'data' + data_file_name.to_s
+      raise ArgumentError, "No such file #{data_file.to_s}" unless data_file.exist?
+
+      # Parse
+      @data = case data_file.extname
+              when '.json'
+                JSON.parse( data_file.read, :symbolize_names => true )
+              else
+                raise ArgumentError "Cannot parse files of type #{data_file.extname}"
+              end
+
+      # Set key and freeze
+      @key = key.freeze
+      @data.freeze
+    end
+
+    attr_reader :key, :data
+
+  end
+end

data/lib/kerbaldyn/data/planet_data.json

@@ -0,0 +1,249 @@
+{
+  "kerbin": {
+    "planetoid": {
+      "name": "Kerbin",
+      "gravitational_parameter": 3531600000000.0,
+      "radius": 600000.0,
+      "rotational_period": 21600.0
+    },
+    "orbit": {
+      "primary_body": "kerbol",
+      "secondary_body": "kerbin",
+      "semimajor_axis": 13599840256.0,
+      "eccentricity": 0.0,
+      "mean_anomaly": 3.1400001049041752,
+      "inclination": 0.0,
+      "longitude_of_ascending_node": 0.0,
+      "argument_of_periapsis": 0.0,
+      "epoch": 0.0
+    }
+  },
+  "mun": {
+    "planetoid": {
+      "name": "Mun",
+      "gravitational_parameter": 65138397520.7806,
+      "radius": 200000.0,
+      "rotational_period": 138984.376574476
+    },
+    "orbit": {
+      "primary_body": "kerbin",
+      "secondary_body": "mun",
+      "semimajor_axis": 12000000.0,
+      "eccentricity": 0.0,
+      "mean_anomaly": 1.7000000476837156,
+      "inclination": 0.0,
+      "longitude_of_ascending_node": 0.0,
+      "argument_of_periapsis": 0.0,
+      "epoch": 0.0
+    }
+  },
+  "minmus": {
+    "planetoid": {
+      "name": "Minmus",
+      "gravitational_parameter": 1765800026.31247,
+      "radius": 60000.0,
+      "rotational_period": 40400.0
+    },
+    "orbit": {
+      "primary_body": "kerbin",
+      "secondary_body": "minmus",
+      "semimajor_axis": 47000000.0,
+      "eccentricity": 0.0,
+      "mean_anomaly": 0.8999999761581429,
+      "inclination": 0.10471975511965977,
+      "longitude_of_ascending_node": 1.361356816555577,
+      "argument_of_periapsis": 0.6632251157578452,
+      "epoch": 0.0
+    }
+  },
+  "duna": {
+    "planetoid": {
+      "name": "Duna",
+      "gravitational_parameter": 301363211975.098,
+      "radius": 320000.0,
+      "rotational_period": 65517.859375
+    },
+    "orbit": {
+      "primary_body": "kerbol",
+      "secondary_body": "duna",
+      "semimajor_axis": 20726155264.0,
+      "eccentricity": 0.0509999990463257,
+      "mean_anomaly": 3.1400001049041752,
+      "inclination": 0.0010471975277899085,
+      "longitude_of_ascending_node": 2.3649211364523164,
+      "argument_of_periapsis": 0.0,
+      "epoch": 0.0
+    }
+  },
+  "ike": {
+    "planetoid": {
+      "name": "Ike",
+      "gravitational_parameter": 18568368573.1441,
+      "radius": 130000.0,
+      "rotational_period": 65517.8621348081
+    },
+    "orbit": {
+      "primary_body": "duna",
+      "secondary_body": "ike",
+      "semimajor_axis": 3200000.0,
+      "eccentricity": 0.0299999993294477,
+      "mean_anomaly": 1.7000000476837156,
+      "inclination": 0.00349065855600352,
+      "longitude_of_ascending_node": 0.0,
+      "argument_of_periapsis": 0.0,
+      "epoch": 0.0
+    }
+  },
+  "moho": {
+    "planetoid": {
+      "name": "Moho",
+      "gravitational_parameter": 245250003654.51,
+      "radius": 250000.0,
+      "rotational_period": 2215754.21968432
+    },
+    "orbit": {
+      "primary_body": "kerbol",
+      "secondary_body": "moho",
+      "semimajor_axis": 5263138304.0,
+      "eccentricity": 0.200000002980232,
+      "mean_anomaly": 3.1400001049041752,
+      "inclination": 0.12217304763960307,
+      "longitude_of_ascending_node": 1.2217304763960306,
+      "argument_of_periapsis": 0.2617993877991494,
+      "epoch": 0.0
+    }
+  },
+  "eve": {
+    "planetoid": {
+      "name": "Eve",
+      "gravitational_parameter": 8171730229210.85,
+      "radius": 700000.0,
+      "rotational_period": 80500.0
+    },
+    "orbit": {
+      "primary_body": "kerbol",
+      "secondary_body": "eve",
+      "semimajor_axis": 9832684544.0,
+      "eccentricity": 0.00999999977648258,
+      "mean_anomaly": 3.1400001049041752,
+      "inclination": 0.03665191262740527,
+      "longitude_of_ascending_node": 0.2617993877991494,
+      "argument_of_periapsis": 0.0,
+      "epoch": 0.0
+    }
+  },
+  "gilly": {
+    "planetoid": {
+      "name": "Gilly",
+      "gravitational_parameter": 8289449.81471635,
+      "radius": 13000.0,
+      "rotational_period": 28255.0
+    },
+    "orbit": {
+      "primary_body": "eve",
+      "secondary_body": "gilly",
+      "semimajor_axis": 31500000.0,
+      "eccentricity": 0.550000011920929,
+      "mean_anomaly": 0.8999999761581429,
+      "inclination": 0.20943951023931953,
+      "longitude_of_ascending_node": 1.3962634015954636,
+      "argument_of_periapsis": 0.17453292519943295,
+      "epoch": 0.0
+    }
+  },
+  "jool": {
+    "planetoid": {
+      "name": "Jool",
+      "gravitational_parameter": 282528004209995.0,
+      "radius": 6000000.0,
+      "rotational_period": 36000.0
+    },
+    "orbit": {
+      "primary_body": "kerbol",
+      "secondary_body": "jool",
+      "semimajor_axis": 68773560320.0,
+      "eccentricity": 0.0500000007450581,
+      "mean_anomaly": 0.10000000149011617,
+      "inclination": 0.022759093795545936,
+      "longitude_of_ascending_node": 0.9075712110370514,
+      "argument_of_periapsis": 0.0,
+      "epoch": 0.0
+    }
+  },
+  "vall": {
+    "planetoid": {
+      "name": "Vall",
+      "gravitational_parameter": 207481499473.751,
+      "radius": 300000.0,
+      "rotational_period": 105962.088893924
+    },
+    "orbit": {
+      "primary_body": "jool",
+      "secondary_body": "vall",
+      "semimajor_axis": 43152000.0,
+      "eccentricity": 0.0,
+      "mean_anomaly": 0.8999999761581429,
+      "inclination": 0.0,
+      "longitude_of_ascending_node": 0.0,
+      "argument_of_periapsis": 0.0,
+      "epoch": 0.0
+    }
+  },
+  "laythe": {
+    "planetoid": {
+      "name": "Laythe",
+      "gravitational_parameter": 1962000029236.08,
+      "radius": 500000.0,
+      "rotational_period": 52980.8790593796
+    },
+    "orbit": {
+      "primary_body": "jool",
+      "secondary_body": "laythe",
+      "semimajor_axis": 27184000.0,
+      "eccentricity": 0.0,
+      "mean_anomaly": 3.1400001049041752,
+      "inclination": 0.0,
+      "longitude_of_ascending_node": 0.0,
+      "argument_of_periapsis": 0.0,
+      "epoch": 0.0
+    }
+  },
+  "tylo": {
+    "planetoid": {
+      "name": "Tylo",
+      "gravitational_parameter": 2825280042099.95,
+      "radius": 600000.0,
+      "rotational_period": 211926.35802123
+    },
+    "orbit": {
+      "primary_body": "jool",
+      "secondary_body": "tylo",
+      "semimajor_axis": 68500000.0,
+      "eccentricity": 0.0,
+      "mean_anomaly": 3.1400001049041752,
+      "inclination": 0.00043633231950044,
+      "longitude_of_ascending_node": 0.0,
+      "argument_of_periapsis": 0.0,
+      "epoch": 0.0
+    }
+  },
+  "bop": {
+    "planetoid": {
+      "name": "Bop",
+      "gravitational_parameter": 2486834944.41491,
+      "radius": 65000.0,
+      "rotational_period": 12950.0
+    },
+    "orbit": {
+      "primary_body": "jool",
+      "secondary_body": "bop",
+      "semimajor_axis": 104500000.0,
+      "eccentricity": 0.234999999403954,
+      "mean_anomaly": 0.8999999761581429,
+      "inclination": 0.2617993877991494,
+      "longitude_of_ascending_node": 0.17453292519943295,
+      "argument_of_periapsis": 0.4363323129985824,
+      "epoch": 0.0
+    }
+  }
+}