ootk 4.0.9 → 5.1.0

package/src/propagator/DormandPrince54Propagator.ts

@@ -1,7 +1,7 @@
 /**
  * @author @thkruz Theodore Kruczek
  * @license AGPL-3.0-or-later
- * @copyright (c) 2020-2024 Theodore Kruczek
+ * @copyright (c) 2025 Kruczek Labs LLC
  *
  * Orbital Object ToolKit is free software: you can redistribute it and/or modify it under the
  * terms of the GNU Affero General Public License as published by the Free Software
@@ -19,9 +19,9 @@
 import { RungeKuttaAdaptive } from './RungeKuttaAdaptive.js';
 
 export class DormandPrince54Propagator extends RungeKuttaAdaptive {
-  private _a: Float64Array = Float64Array.from([0.0, 1.0 / 5.0, 3.0 / 10.0, 4.0 / 5.0, 8.0 / 9.0, 1.0, 1.0]);
+  private readonly a_: Float64Array = Float64Array.from([0.0, 1.0 / 5.0, 3.0 / 10.0, 4.0 / 5.0, 8.0 / 9.0, 1.0, 1.0]);
 
-  private _b: Float64Array[] = [
+  private readonly b_: Float64Array[] = [
     new Float64Array(),
     Float64Array.from([1.0 / 5.0]),
     Float64Array.from([3.0 / 40.0, 9.0 / 40.0]),
@@ -31,7 +31,7 @@ export class DormandPrince54Propagator extends RungeKuttaAdaptive {
     Float64Array.from([35.0 / 384.0, 0.0, 500.0 / 1113.0, 125.0 / 192.0, -2187.0 / 6784.0, 11.0 / 84.0]),
   ];
 
-  private _ch: Float64Array = Float64Array.from([
+  private readonly ch_: Float64Array = Float64Array.from([
     35.0 / 384.0,
     0.0,
     500.0 / 1113.0,
@@ -41,7 +41,7 @@ export class DormandPrince54Propagator extends RungeKuttaAdaptive {
     0.0,
   ]);
 
-  private _c: Float64Array = Float64Array.from([
+  private readonly c_: Float64Array = Float64Array.from([
     5179.0 / 57600.0,
     0.0,
     7571.0 / 16695.0,
@@ -52,19 +52,19 @@ export class DormandPrince54Propagator extends RungeKuttaAdaptive {
   ]);
 
   get a(): Float64Array {
-    return this._a;
+    return this.a_;
   }
 
   get b(): Float64Array[] {
-    return this._b;
+    return this.b_;
   }
 
   get ch(): Float64Array {
-    return this._ch;
+    return this.ch_;
   }
 
   get c(): Float64Array {
-    return this._c;
+    return this.c_;
   }
 
   get order(): number {

package/src/propagator/KeplerPropagator.ts

@@ -1,7 +1,7 @@
 /**
  * @author @thkruz Theodore Kruczek
  * @license AGPL-3.0-or-later
- * @copyright (c) 2020-2024 Theodore Kruczek
+ * @copyright (c) 2025 Kruczek Labs LLC
  *
  * Orbital Object ToolKit is free software: you can redistribute it and/or modify it under the
  * terms of the GNU Affero General Public License as published by the Free Software
@@ -15,47 +15,47 @@
  * Orbital Object ToolKit. If not, see <http://www.gnu.org/licenses/>.
  */
 
-import { ClassicalElements, EpochUTC, J2000, Seconds } from 'ootk-core';
+import { ClassicalElements, EpochUTC, J2000, Seconds } from '../main.js';
 import { Thrust } from '../force/Thrust.js';
 import { VerletBlendInterpolator } from '../interpolator/VerletBlendInterpolator.js';
 import { Propagator } from './Propagator.js';
 
 // / Kepler analytical two-body propagator.
 export class KeplerPropagator extends Propagator {
-  private _initElements: ClassicalElements;
-  private _elements: ClassicalElements;
-  private _cacheState: J2000;
-  private _checkpoints: J2000[];
+  private readonly initElements_: ClassicalElements;
+  private elements_: ClassicalElements;
+  private cacheState_: J2000;
+  private checkpoints_: J2000[];
 
   constructor(initElements: ClassicalElements) {
     super();
-    this._initElements = initElements;
-    this._elements = initElements;
-    this._cacheState = J2000.fromClassicalElements(initElements);
-    this._checkpoints = [];
+    this.initElements_ = initElements;
+    this.elements_ = initElements;
+    this.cacheState_ = J2000.fromClassicalElements(initElements);
+    this.checkpoints_ = [];
   }
 
   get state(): J2000 {
-    return this._cacheState;
+    return this.cacheState_;
   }
 
   propagate(epoch: EpochUTC): J2000 {
-    this._cacheState = J2000.fromClassicalElements(this._elements.propagate(epoch));
+    this.cacheState_ = J2000.fromClassicalElements(this.elements_.propagate(epoch));
 
-    return this._cacheState;
+    return this.cacheState_;
   }
 
   reset(): void {
-    this._elements = this._initElements;
-    this._cacheState = J2000.fromClassicalElements(this._elements);
+    this.elements_ = this.initElements_;
+    this.cacheState_ = J2000.fromClassicalElements(this.elements_);
   }
 
   // eslint-disable-next-line @typescript-eslint/no-unused-vars
   maneuver(maneuver: Thrust, interval = 60): J2000[] {
-    this._cacheState = maneuver.apply(this.propagate(maneuver.center));
-    this._elements = this._cacheState.toClassicalElements();
+    this.cacheState_ = maneuver.apply(this.propagate(maneuver.center));
+    this.elements_ = this.cacheState_.toClassicalElements();
 
-    return [this._cacheState];
+    return [this.cacheState_];
   }
 
   ephemerisManeuver(start: EpochUTC, finish: EpochUTC, maneuvers: Thrust[], interval = 60.0): VerletBlendInterpolator {
@@ -66,37 +66,37 @@ export class KeplerPropagator extends Propagator {
       ephemeris.push(this.propagate(start));
     }
     for (const mvr of tMvr) {
-      while (this._cacheState.epoch < mvr.center) {
-        const step = Math.min(mvr.center.difference(this._cacheState.epoch), interval) as Seconds;
+      while (this.cacheState_.epoch < mvr.center) {
+        const step = Math.min(mvr.center.difference(this.cacheState_.epoch), interval) as Seconds;
 
-        this.propagate(this._cacheState.epoch.roll(step));
-        if (this._cacheState.epoch.posix !== mvr.center.posix) {
-          ephemeris.push(this._cacheState);
+        this.propagate(this.cacheState_.epoch.roll(step));
+        if (this.cacheState_.epoch.posix !== mvr.center.posix) {
+          ephemeris.push(this.cacheState_);
         }
       }
       ephemeris.push(...this.maneuver(mvr, interval));
     }
-    while (this._cacheState.epoch < finish) {
-      const step = Math.min(finish.difference(this._cacheState.epoch), interval) as Seconds;
+    while (this.cacheState_.epoch < finish) {
+      const step = Math.min(finish.difference(this.cacheState_.epoch), interval) as Seconds;
 
-      this.propagate(this._cacheState.epoch.roll(step));
-      ephemeris.push(this._cacheState);
+      this.propagate(this.cacheState_.epoch.roll(step));
+      ephemeris.push(this.cacheState_);
     }
 
     return new VerletBlendInterpolator(ephemeris);
   }
 
   checkpoint(): number {
-    this._checkpoints.push(this._cacheState);
+    this.checkpoints_.push(this.cacheState_);
 
-    return this._checkpoints.length - 1;
+    return this.checkpoints_.length - 1;
   }
 
   clearCheckpoints(): void {
-    this._checkpoints = [];
+    this.checkpoints_ = [];
   }
 
   restore(index: number): void {
-    this._cacheState = this._checkpoints[index];
+    this.cacheState_ = this.checkpoints_[index];
   }
 }

package/src/propagator/Propagator.ts

@@ -1,7 +1,7 @@
 /**
  * @author @thkruz Theodore Kruczek
  * @license AGPL-3.0-or-later
- * @copyright (c) 2020-2024 Theodore Kruczek
+ * @copyright (c) 2025 Kruczek Labs LLC
  *
  * Orbital Object ToolKit is free software: you can redistribute it and/or modify it under the
  * terms of the GNU Affero General Public License as published by the Free Software
@@ -15,7 +15,7 @@
  * Orbital Object ToolKit. If not, see <http://www.gnu.org/licenses/>.
  */
 
-import { EpochUTC, J2000, Seconds } from 'ootk-core';
+import { EpochUTC, J2000, Seconds } from '../main.js';
 import { Thrust } from '../force/Thrust.js';
 import { VerletBlendInterpolator } from '../interpolator/VerletBlendInterpolator.js';
 import { GoldenSection } from './../optimize/GoldenSection.js';

package/src/propagator/RkCheckpoint.ts

@@ -1,7 +1,7 @@
 /**
  * @author @thkruz Theodore Kruczek
  * @license AGPL-3.0-or-later
- * @copyright (c) 2020-2024 Theodore Kruczek
+ * @copyright (c) 2025 Kruczek Labs LLC
  *
  * Orbital Object ToolKit is free software: you can redistribute it and/or modify it under the
  * terms of the GNU Affero General Public License as published by the Free Software
@@ -15,7 +15,7 @@
  * Orbital Object ToolKit. If not, see <http://www.gnu.org/licenses/>.
  */
 
-import { J2000 } from 'ootk-core';
+import { J2000 } from '../main.js';
 
 // / Runge-Kutta adaptive state checkpoint.
 export class RkCheckpoint {

package/src/propagator/RkResult.ts

@@ -1,7 +1,7 @@
 /**
  * @author @thkruz Theodore Kruczek
  * @license AGPL-3.0-or-later
- * @copyright (c) 2020-2024 Theodore Kruczek
+ * @copyright (c) 2025 Kruczek Labs LLC
  *
  * Orbital Object ToolKit is free software: you can redistribute it and/or modify it under the
  * terms of the GNU Affero General Public License as published by the Free Software
@@ -15,7 +15,7 @@
  * Orbital Object ToolKit. If not, see <http://www.gnu.org/licenses/>.
  */
 
-import { J2000 } from 'ootk-core';
+import { J2000 } from '../main.js';
 
 // / Result of adaptive numerical integration.
 export class RkResult {

package/src/propagator/RungeKutta4Propagator.ts

@@ -1,7 +1,7 @@
 /**
  * @author @thkruz Theodore Kruczek
  * @license AGPL-3.0-or-later
- * @copyright (c) 2020-2024 Theodore Kruczek
+ * @copyright (c) 2025 Kruczek Labs LLC
  *
  * Orbital Object ToolKit is free software: you can redistribute it and/or modify it under the
  * terms of the GNU Affero General Public License as published by the Free Software
@@ -15,7 +15,7 @@
  * Orbital Object ToolKit. If not, see <http://www.gnu.org/licenses/>.
  */
 
-import { EpochUTC, J2000, Kilometers, KilometersPerSecond, Seconds, Vector, Vector3D } from 'ootk-core';
+import { EpochUTC, J2000, Kilometers, KilometersPerSecond, Seconds, Vector, Vector3D } from '../main.js';
 import { ForceModel } from '../force/ForceModel.js';
 import { Thrust } from '../force/Thrust.js';
 import { VerletBlendInterpolator } from '../interpolator/VerletBlendInterpolator.js';
@@ -33,7 +33,7 @@ export class RungeKutta4Propagator extends Propagator {
    * @param checkpoints_ Cached state vector checkpoints.
    */
   constructor(
-    private initState_: J2000,
+    private readonly initState_: J2000,
     private forceModel_: ForceModel = new ForceModel().setGravity(),
     private stepSize_: number = 15.0,
     private cacheState_: J2000 = initState_,

package/src/propagator/RungeKutta89Propagator.ts

@@ -1,7 +1,7 @@
 /**
  * @author @thkruz Theodore Kruczek
  * @license AGPL-3.0-or-later
- * @copyright (c) 2020-2024 Theodore Kruczek
+ * @copyright (c) 2025 Kruczek Labs LLC
  *
  * Orbital Object ToolKit is free software: you can redistribute it and/or modify it under the
  * terms of the GNU Affero General Public License as published by the Free Software
@@ -21,12 +21,12 @@ import { RungeKuttaAdaptive } from './RungeKuttaAdaptive.js';
 
 // / Runge-Kutta 8(9) adaptive numerical propagator.
 export class RungeKutta89Propagator extends RungeKuttaAdaptive {
-  private a_ = Float64Array.from([
+  private readonly a_ = Float64Array.from([
     0.0, 0.3462e-1, 0.9702435063878044594828361677100617517633e-1, 0.1455365259581706689224254251565092627645, 0.561,
     0.2290079115904850126662751771814700052182, 0.5449920884095149873337248228185299947818, 0.645, 0.48375, 0.6757e-1,
     0.25, 0.6590650618730998549405331618649220295334, 0.8206, 0.9012, 1.0, 1.0,
   ]);
-  private b_ = [
+  private readonly b_ = [
     new Float64Array(0),
     Float64Array.from([0.3462e-1]),
     Float64Array.from([-0.389335438857287327017042687229284478532e-1, 0.1359578945245091786499878854939346230295]),
@@ -95,14 +95,14 @@ export class RungeKutta89Propagator extends RungeKuttaAdaptive {
       1.264756521695642578827783499806516664686, 0.0, 0.0,
     ]),
   ];
-  private ch_ = Float64Array.from([
+  private readonly ch_ = Float64Array.from([
     0.1996996514886773085518508418098868756464e-1, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0,
     2.191499304949330054530747099310837524864, 0.8857071848208438030833722031786358862953e-1,
     0.1140560234865965622484956605091432032674, 0.2533163805345107065564577734569651977347,
     -2.056564386240941011158999594595981300493, 0.340809679901311993516009489422454381283, 0.0, 0.0,
     0.4834231373823958314376726739772871714902e-1,
   ]);
-  private c_ = Float64Array.from([
+  private readonly c_ = Float64Array.from([
     0.1461197685842315252051541915018784713459e-1, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0,
     -0.391521186233133908941022826728824203081, 0.2310932500289506415909675644868993669908,
     0.1274766769992852382560589467488989175618, 0.2246434176204157731566981937082069688984,

package/src/propagator/RungeKuttaAdaptive.ts

@@ -1,7 +1,7 @@
 /**
  * @author @thkruz Theodore Kruczek
  * @license AGPL-3.0-or-later
- * @copyright (c) 2020-2024 Theodore Kruczek
+ * @copyright (c) 2025 Kruczek Labs LLC
  *
  * Orbital Object ToolKit is free software: you can redistribute it and/or modify it under the
  * terms of the GNU Affero General Public License as published by the Free Software
@@ -15,7 +15,7 @@
  * Orbital Object ToolKit. If not, see <http://www.gnu.org/licenses/>.
  */
 
-import { EpochUTC, J2000, Kilometers, KilometersPerSecond, Seconds, Vector, Vector3D } from 'ootk-core';
+import { EpochUTC, J2000, Kilometers, KilometersPerSecond, Seconds, Vector, Vector3D } from '../main.js';
 import { ForceModel } from '../force/ForceModel.js';
 import { Thrust } from '../force/Thrust.js';
 import { VerletBlendInterpolator } from './../interpolator/VerletBlendInterpolator.js';
@@ -33,9 +33,9 @@ export abstract class RungeKuttaAdaptive extends Propagator {
    * @param tolerance_ Minimum allowable local error tolerance.
    */
   constructor(
-    private initState_: J2000,
+    private readonly initState_: J2000,
     private forceModel_: ForceModel = new ForceModel().setGravity(),
-    private tolerance_: number = 1e-9,
+    private readonly tolerance_: number = 1e-9,
   ) {
     super();
     this._cacheState = this.initState_;

package/src/propagator/Sgp4Propagator.ts

@@ -1,7 +1,7 @@
 /**
  * @author @thkruz Theodore Kruczek
  * @license AGPL-3.0-or-later
- * @copyright (c) 2020-2024 Theodore Kruczek
+ * @copyright (c) 2025 Kruczek Labs LLC
  *
  * Orbital Object ToolKit is free software: you can redistribute it and/or modify it under the
  * terms of the GNU Affero General Public License as published by the Free Software
@@ -17,7 +17,7 @@
 
 /* eslint-disable @typescript-eslint/no-unused-vars */
 /* eslint-disable class-methods-use-this */
-import { EpochUTC, J2000, Tle } from 'ootk-core';
+import { EpochUTC, J2000, Tle } from '../main.js';
 import { Thrust } from '../force/Thrust.js';
 import { VerletBlendInterpolator } from '../interpolator/VerletBlendInterpolator.js';
 import { Propagator } from './Propagator.js';
@@ -28,20 +28,20 @@ import { Propagator } from './Propagator.js';
  * state of the TLE at different epochs.
  */
 export class Sgp4Propagator extends Propagator {
-  constructor(private tle: Tle) {
+  constructor(private readonly tle_: Tle) {
     super();
-    this._cacheState = tle.state.toJ2000();
+    this.cacheState_ = tle_.state.toJ2000();
   }
 
-  private _cacheState: J2000;
-  private _checkpoints: J2000[] = [];
+  private cacheState_: J2000;
+  private checkpoints_: J2000[] = [];
 
   /**
    * Gets the state of the propagator in the J2000 coordinate system.
    * @returns The J2000 state of the propagator.
    */
   get state(): J2000 {
-    return this._cacheState;
+    return this.cacheState_;
   }
 
   /**
@@ -71,9 +71,9 @@ export class Sgp4Propagator extends Propagator {
    * @returns The propagated state in J2000 coordinates.
    */
   propagate(epoch: EpochUTC): J2000 {
-    this._cacheState = this.tle.propagate(epoch).toJ2000();
+    this.cacheState_ = this.tle_.propagate(epoch).toJ2000();
 
-    return this._cacheState;
+    return this.cacheState_;
   }
 
   /**
@@ -81,7 +81,7 @@ export class Sgp4Propagator extends Propagator {
    * to the current J2000 state of the TLE.
    */
   reset(): void {
-    this._cacheState = this.tle.state.toJ2000();
+    this.cacheState_ = this.tle_.state.toJ2000();
   }
 
   /**
@@ -89,16 +89,16 @@ export class Sgp4Propagator extends Propagator {
    * @returns The index of the checkpoint.
    */
   checkpoint(): number {
-    this._checkpoints.push(this._cacheState);
+    this.checkpoints_.push(this.cacheState_);
 
-    return this._checkpoints.length - 1;
+    return this.checkpoints_.length - 1;
   }
 
   /**
    * Clears all the checkpoints in the propagator.
    */
   clearCheckpoints(): void {
-    this._checkpoints = [];
+    this.checkpoints_ = [];
   }
 
   /**
@@ -106,6 +106,6 @@ export class Sgp4Propagator extends Propagator {
    * @param index - The index of the checkpoint to restore.
    */
   restore(index: number): void {
-    this._cacheState = this._checkpoints[index];
+    this.cacheState_ = this.checkpoints_[index];
   }
 }

package/src/sgp4/index.ts

@@ -0,0 +1,24 @@
+/**
+ * @author @thkruz Theodore Kruczek
+ * @description Orbital Object ToolKit (ootk) is a collection of tools for working
+ * with satellites and other orbital objects.
+ * @license AGPL-3.0-or-later
+ * @copyright (c) 2025 Kruczek Labs LLC
+ *
+ * Many of the classes are based off of the work of @david-rc-dayton and his
+ * Pious Squid library (https://github.com/david-rc-dayton/pious_squid) which
+ * is licensed under the MIT license.
+ *
+ * Orbital Object ToolKit is free software: you can redistribute it and/or modify it under the
+ * terms of the GNU Affero General Public License as published by the Free Software
+ * Foundation, either version 3 of the License, or (at your option) any later version.
+ *
+ * Orbital Object ToolKit is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY;
+ * without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
+ * See the GNU Affero General Public License for more details.
+ *
+ * You should have received a copy of the GNU Affero General Public License along with
+ * Orbital Object ToolKit. If not, see <http://www.gnu.org/licenses/>.
+ */
+
+export { Sgp4 } from './sgp4.js';

package/src/sgp4/sgp4-error.ts

@@ -0,0 +1,53 @@
+/**
+ * Improved error handling for SGP4
+ */
+
+// Define specific error types
+export enum Sgp4ErrorCode {
+  NO_ERROR = 0,
+  MEAN_ELEMENTS_INVALID = 1, // ecc >= 1.0 or ecc < -0.001 or a < 0.95 er
+  MEAN_MOTION_NEGATIVE = 2, // mean motion less than 0.0
+  PERT_ELEMENTS_INVALID = 3, // pert elements, ecc < 0.0 or ecc > 1.0
+  SEMI_LATUS_RECTUM_NEGATIVE = 4, // semi-latus rectum < 0.0
+  EPOCH_ELEMENTS_SUBORBITAL = 5, // epoch elements are sub-orbital
+  SATELLITE_DECAYED = 6 // satellite has decayed
+}
+
+// Error class for SGP4 errors
+export class Sgp4Error extends Error {
+  code: Sgp4ErrorCode;
+
+  constructor(code: Sgp4ErrorCode, message?: string) {
+    super(message ?? Sgp4Error.getDefaultMessage(code));
+    this.name = 'Sgp4Error';
+    this.code = code;
+  }
+
+  static getDefaultMessage(code: Sgp4ErrorCode): string {
+    switch (code) {
+      case Sgp4ErrorCode.NO_ERROR:
+        return 'No error';
+      case Sgp4ErrorCode.MEAN_ELEMENTS_INVALID:
+        return 'Mean elements invalid: eccentricity out of range or semi-major axis too small';
+      case Sgp4ErrorCode.MEAN_MOTION_NEGATIVE:
+        return 'Mean motion is negative';
+      case Sgp4ErrorCode.PERT_ELEMENTS_INVALID:
+        return 'Perturbed elements invalid: eccentricity out of range';
+      case Sgp4ErrorCode.SEMI_LATUS_RECTUM_NEGATIVE:
+        return 'Semi-latus rectum is negative';
+      case Sgp4ErrorCode.EPOCH_ELEMENTS_SUBORBITAL:
+        return 'Epoch elements are sub-orbital';
+      case Sgp4ErrorCode.SATELLITE_DECAYED:
+        return 'Satellite has decayed';
+      default:
+        return `Unknown error code: ${code}`;
+    }
+  }
+}
+
+// Result type that includes error information
+export interface Sgp4Result<T> {
+  success: boolean;
+  value?: T;
+  error?: Sgp4Error;
+}

package/src/sgp4/sgp4.LICENSE.md

@@ -0,0 +1,28 @@
+# Revisiting Spacetrack Report #3 AIAA 2006-6753
+
+Over a quarter century ago, the United States Department of Defense (DoD) released the equations and source code used to
+predict satellite positions through SpaceTrack Report Number 3 (STR#3). Because the DoD's two-line element sets (TLEs)
+were the only source of orbital data, widely available through NASA, this code became commonplace among users needing
+accurate results. However, end users made code changes to correct the implementation of the equations and to handle rare
+ cases encountered in operations. These changes migrated into numerous new versions and compiled programs outside the
+ DoD. Changes made to the original STR#3 code have not been released in a comprehensive form to the public, so the code
+ available to the public no longer matches the code used by DoD to produce the TLEs. Fortunately, independent efforts,
+ technical papers, and source code enabled us to synthesize a non-proprietary version which we believe is up-to-date and
+ accurate. This paper provides source code, test cases, results, and analysis of a version of SGP4 theory designed to be
+ highly compatible with recent DoD versions.
+
+## Are there any Licenses required to use the SGP4 code?
+
+There is no license associated with the code and you may use it for any purpose—personal or commercial—as you wish. We
+ask only that you include citations in your documentation and source code to show the source of the code and provide
+links to the main page, to facilitate communications regarding any questions on the theory or source code.
+
+[https://celestrak.org/publications/AIAA/2006-6753/faq.php](Link to Source)
+
+## ootk Notes
+
+Since the original authors do not have a license file, this file is to document the permission granted to use the code
+to develop a TypeScript implementation.
+
+The ootk TypeScript implementation is licensed under the AGPL 3.0 License. ootk is not affiliated with the original
+authors.