ootk 4.0.9 → 5.0.0

package/src/operations/Vector3D.ts

@@ -0,0 +1,289 @@
+/**
+ * @author Theodore Kruczek.
+ * @license MIT
+ * @copyright (c) 2022-2025 Theodore Kruczek Permission is
+ * hereby granted, free of charge, to any person obtaining a copy of this
+ * software and associated documentation files (the "Software"), to deal in the
+ * Software without restriction, including without limitation the rights to use,
+ * copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
+ * the Software, and to permit persons to whom the Software is furnished to do
+ * so, subject to the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be included in
+ * all copies or substantial portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+ * SOFTWARE.
+ */
+
+import { Kilometers, KilometersPerSecond, Radians, linearDistance } from '../main.js';
+import { Matrix } from './Matrix.js';
+import { Vector } from './Vector.js';
+
+// / 3-dimensional vector.
+export class Vector3D<T extends number = number> {
+  constructor(
+    public x: T,
+    public y: T,
+    public z: T,
+  ) {
+    // Nothing to do here.
+  }
+
+  /**
+   * Create a new Vector3D object from the first three elements of a Vector
+   * object.
+   * @param v The Vector object to convert.
+   * @returns A new Vector3D object.
+   */
+  static fromVector<U extends number>(v: Vector<U>): Vector3D<U> {
+    return new Vector3D<U>(v.x as U, v.y as U, v.z as U);
+  }
+
+  // / Origin vector.
+  static readonly origin = new Vector3D<number>(0, 0, 0);
+
+  // / X-axis unit vector.
+  static readonly xAxis = new Vector3D<number>(1, 0, 0);
+
+  // / Y-axis unit vector.
+  static readonly yAxis = new Vector3D<number>(0, 1, 0);
+
+  // / Z-axis unit vector.
+  static readonly zAxis = new Vector3D<number>(0, 0, 1);
+
+  // / Negative x-axis unit vector.
+  static readonly xAxisNeg = new Vector3D<number>(-1, 0, 0);
+
+  // / Negative y-axis unit vector.
+  static readonly yAxisNeg = new Vector3D<number>(0, -1, 0);
+
+  // / Negative z-axis unit vector.
+  static readonly zAxisNeg = new Vector3D<number>(0, 0, -1);
+
+  // / Convert this to a [List] of doubles.
+  toList() {
+    return [this.x, this.y, this.z];
+  }
+
+  // / Convert this to a [Float64List] object.
+  toArray() {
+    return new Float64Array([this.x, this.y, this.z]);
+  }
+
+  /**
+   * Return the Vector3D element at the provided index.
+   * @deprecated don't do this
+   * @param index The index of the element to return.
+   * @returns The element at the provided index.
+   */
+  public getElement(index: number): number {
+    switch (index) {
+      case 0:
+        return this.x;
+      case 1:
+        return this.y;
+      case 2:
+        return this.z;
+      default:
+        throw new Error(`Index ${index} outside 3D vector bounds.`);
+    }
+  }
+
+  // / Convert this to a [Vector] object.
+  toVector() {
+    return new Vector(this.toList());
+  }
+
+  toString(fixed = -1): string {
+    if (fixed < 0) {
+      return `[${this.toList().join(', ')}]`;
+    }
+    const output = this.toList().map((e) => e.toFixed(fixed));
+
+    return `[${output.join(', ')}]`;
+  }
+
+  // / Return the magnitude of this vector.
+  magnitude(): T {
+    return Math.sqrt(this.x * this.x + this.y * this.y + this.z * this.z) as T;
+  }
+
+  // / Return the result of adding this to another [Vector3D].
+  add(v: Vector3D<T>): Vector3D<T> {
+    return new Vector3D<T>((this.x + v.x) as T, (this.y + v.y) as T, (this.z + v.z) as T);
+  }
+
+  // / Return the result of subtracting this and another [Vector3D].
+  subtract(v: Vector3D<T>): Vector3D<T> {
+    return new Vector3D<T>((this.x - v.x) as T, (this.y - v.y) as T, (this.z - v.z) as T);
+  }
+
+  // / Return a copy of this [Vector3D] scaled by [n];
+  scale<U extends number>(n: U): Vector3D<U> {
+    return new Vector3D<U>(this.x * n as U, this.y * n as U, this.z * n as U);
+  }
+
+  // / Return a copy of this [Vector3D] with the elements negated.
+  negate(): Vector3D<T> {
+    return this.scale(-1 as T);
+  }
+
+  /**
+   * Return the Euclidean distance between this and another Vector3D.
+   * @param v The other Vector3D.
+   * @returns The distance between this and the other Vector3D.
+   */
+  distance(v: Vector3D<T>): T {
+    return linearDistance(this, v);
+  }
+
+  /**
+   * Convert this to a unit Vector3D.
+   * @returns A unit Vector3D.
+   */
+  normalize(): Vector3D<T> {
+    const m = this.magnitude();
+
+    if (m === 0) {
+      return Vector3D.origin as Vector3D<T>;
+    }
+
+    return new Vector3D<T>(this.x / m as T, this.y / m as T, this.z / m as T);
+  }
+
+  // Calculate the dot product of this and another [Vector3D].
+  dot<T extends number>(v: Vector3D<T>): T {
+    return this.x * v.x + this.y * v.y + this.z * v.z as T;
+  }
+
+  // Calculate the outer product between this and another [Vector3D].
+  outer(v: Vector3D): Matrix {
+    return new Matrix([
+      [this.x * v.x, this.x * v.y, this.x * v.z],
+      [this.y * v.x, this.y * v.y, this.y * v.z],
+      [this.z * v.x, this.z * v.y, this.z * v.z],
+    ]);
+  }
+
+  // Calculate the cross product of this and another [Vector3D].
+  cross<U extends number>(v: Vector3D<U>): Vector3D<U> {
+    return new Vector3D<U>(
+      (this.y * v.z - this.z * v.y) as U,
+      (this.z * v.x - this.x * v.z) as U,
+      (this.x * v.y - this.y * v.x) as U,
+    );
+  }
+
+  // Calculate the skew-symmetric matrix for this [Vector3D].
+  skewSymmetric(): Matrix {
+    return new Matrix([
+      [0, -this.z, this.y],
+      [this.z, 0, -this.x],
+      [-this.y, this.x, 0],
+    ]);
+  }
+
+  /*
+   * Create a copy of this [Vector3D] rotated in the x-axis by angle [theta]
+   * _(rad)_.
+   */
+  rotX(theta: number): Vector3D {
+    const cosT = Math.cos(theta);
+    const sinT = Math.sin(theta);
+
+    return new Vector3D(this.x, cosT * this.y + sinT * this.z, -sinT * this.y + cosT * this.z);
+  }
+
+  /*
+   * Create a copy of this [Vector3D] rotated in the y-axis by angle [theta]
+   * _(rad)_.
+   */
+  rotY(theta: Radians): Vector3D<T> {
+    const cosT = Math.cos(theta);
+    const sinT = Math.sin(theta);
+
+    return new Vector3D<T>((cosT * this.x + -sinT * this.z) as T, this.y, (sinT * this.x + cosT * this.z) as T);
+  }
+
+  /*
+   * Create a copy of this [Vector3D] rotated in the z-axis by angle [theta]
+   * _(rad)_.
+   */
+  rotZ(theta: Radians): Vector3D<T> {
+    const cosT = Math.cos(theta);
+    const sinT = Math.sin(theta);
+
+    return new Vector3D((cosT * this.x + sinT * this.y) as T, (-sinT * this.x + cosT * this.y) as T, this.z);
+  }
+
+  // Calculate the angle _(rad)_ between this and another [Vector3D].
+  angle<U extends number>(v: Vector3D<U>): Radians {
+    const theta = Math.atan2(this.cross(v).magnitude(), this.dot(v)) as Radians;
+
+    return isNaN(theta) ? 0 as Radians : theta;
+  }
+
+  // Calculate the angle _(°)_ between this and another [Vector3D].
+  angleDegrees(v: Vector3D<T>): number {
+    return this.angle(v) * (180 / Math.PI);
+  }
+
+  /*
+   * Return `true` if line-of-sight exists between this and another [Vector3D]
+   * with a central body of the given [radius].
+   */
+  sight(v: Vector3D<KilometersPerSecond>, radius: Kilometers): boolean {
+    const r1Mag2 = this.magnitude() ** 2;
+    const r2Mag2 = v.magnitude() ** 2;
+    const rDot = this.dot(v);
+    const tMin = (r1Mag2 - rDot) / (r1Mag2 + r2Mag2 - 2 * rDot);
+    let los = false;
+
+    if (tMin < 0 || tMin > 1) {
+      los = true;
+    } else {
+      const c = (1 - tMin) * r1Mag2 + rDot * tMin;
+
+      if (c >= radius * radius) {
+        los = true;
+      }
+    }
+
+    return los;
+  }
+
+  // / Return the unit vector that bisects this and another [Vector3D].
+  bisect(v: Vector3D<T>): Vector3D<T> {
+    return this.scale(v.magnitude()).add(v.scale(this.magnitude())).normalize();
+  }
+
+  // / Convert this [Vector3D] into a row [Matrix].
+  row(): Matrix {
+    return new Matrix([[this.x, this.y, this.z]]);
+  }
+
+  // / Convert this [Vector3D] into a column [Matrix].
+  column(): Matrix {
+    return new Matrix([[this.x], [this.y], [this.z]]);
+  }
+
+  // / Join this and another [Vector3D] into a new [Vector] object.
+  join(v: Vector3D): Vector {
+    const output = new Float64Array(6);
+
+    output[0] = this.x;
+    output[1] = this.y;
+    output[2] = this.z;
+    output[3] = v.x;
+    output[4] = v.y;
+    output[5] = v.z;
+
+    return new Vector(output);
+  }
+}

package/src/operations/operations.ts

@@ -0,0 +1,27 @@
+/**
+ * @author Theodore Kruczek.
+ * @license MIT
+ * @copyright (c) 2022-2025 Theodore Kruczek Permission is
+ * hereby granted, free of charge, to any person obtaining a copy of this
+ * software and associated documentation files (the "Software"), to deal in the
+ * Software without restriction, including without limitation the rights to use,
+ * copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
+ * the Software, and to permit persons to whom the Software is furnished to do
+ * so, subject to the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be included in
+ * all copies or substantial portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+ * SOFTWARE.
+ */
+
+export { Matrix } from './Matrix.js';
+export { Random } from './Random.js';
+export { Vector } from './Vector.js';
+export { Vector3D } from './Vector3D.js';

package/src/optimize/ChebyshevCompressor.ts

@@ -15,7 +15,7 @@
  * Orbital Object ToolKit. If not, see <http://www.gnu.org/licenses/>.
  */
 
-import { EpochUTC, Seconds, Vector3D } from 'ootk-core';
+import { EpochUTC, Seconds, Vector3D } from '../main.js';
 import { StateInterpolator } from '../interpolator/StateInterpolator.js';
 import { ChebyshevCoefficients } from './../interpolator/ChebyshevCoefficients.js';
 import { ChebyshevInterpolator } from './../interpolator/ChebyshevInterpolator.js';

package/src/optimize/PolynomialRegression.ts

@@ -17,7 +17,7 @@
 
 /* eslint-disable require-jsdoc */
 /* eslint-disable func-style */
-import { evalPoly } from 'ootk-core';
+import { evalPoly } from '../main.js';
 import { DownhillSimplex } from './DownhillSimplex.js';
 import { PolynomicalRegressionResult } from './PolynomicalRegressionResult.js';
 // / Polynomial regression optimizer.

package/src/optimize/SimplexEntry.ts

@@ -15,7 +15,7 @@
  * Orbital Object ToolKit. If not, see <http://www.gnu.org/licenses/>.
  */
 
-import { Vector } from 'ootk-core';
+import { Vector } from '../main.js';
 
 /**
  * Optimization cost function that takes in parameter array [xs] and returns

package/src/orbit_determination/BatchLeastSquaresOD.ts

@@ -15,7 +15,7 @@
  * Orbital Object ToolKit. If not, see <http://www.gnu.org/licenses/>.
  */
 
-import { concat, EpochUTC, J2000, Kilometers, KilometersPerSecond, Matrix, Vector, Vector3D } from 'ootk-core';
+import { concat, EpochUTC, J2000, Kilometers, KilometersPerSecond, Matrix, Vector, Vector3D } from '../main.js';
 import { Observation } from '../observation/Observation.js';
 import { PropagatorPairs } from '../observation/PropagatorPairs.js';
 import { Propagator } from '../propagator/Propagator.js';

package/src/orbit_determination/BatchLeastSquaresResult.ts

@@ -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';
 import { StateCovariance } from './../covariance/StateCovariance.js';
 
 // / Batch least squares orbit determination result.

package/src/orbit_determination/GibbsIOD.ts

@@ -15,7 +15,9 @@
  * Orbital Object ToolKit. If not, see <http://www.gnu.org/licenses/>.
  */
 
-import { DEG2RAD, Earth, EpochUTC, halfPi, J2000, Kilometers, KilometersPerSecond, Radians, Vector3D } from 'ootk-core';
+import {
+  DEG2RAD, Earth, EpochUTC, halfPi, J2000, Kilometers, KilometersPerSecond, Radians, Vector3D,
+} from '../main.js';
 import { ForceModel } from './../force/ForceModel.js';
 import { RungeKutta89Propagator } from './../propagator/RungeKutta89Propagator.js';
 

package/src/orbit_determination/GoodingIOD.ts

@@ -15,7 +15,7 @@
  * Orbital Object ToolKit. If not, see <http://www.gnu.org/licenses/>.
  */
 
-import { Earth, J2000, Kilometers, KilometersPerSecond, Seconds, TAU, Vector3D } from 'ootk-core';
+import { Earth, J2000, Kilometers, KilometersPerSecond, Seconds, TAU, Vector3D } from '../main.js';
 import { ForceModel } from '../force/ForceModel.js';
 import { RungeKutta89Propagator } from '../propagator/RungeKutta89Propagator.js';
 import { ObservationOptical } from './../observation/ObservationOptical.js';

package/src/orbit_determination/HerrickGibbsIOD.ts

@@ -15,7 +15,7 @@
  * Orbital Object ToolKit. If not, see <http://www.gnu.org/licenses/>.
  */
 
-import { Earth, EpochUTC, J2000, Kilometers, KilometersPerSecond, Vector3D } from 'ootk-core';
+import { Earth, EpochUTC, J2000, Kilometers, KilometersPerSecond, Vector3D } from '../main.js';
 
 /**
  * Herrik-Gibbs 3-position initial orbit determination.

package/src/orbit_determination/LambertIOD.ts

@@ -15,7 +15,7 @@
  * Orbital Object ToolKit. If not, see <http://www.gnu.org/licenses/>.
  */
 
-import { Earth, EpochUTC, J2000, Kilometers, KilometersPerSecond, Radians, Vector3D } from 'ootk-core';
+import { Earth, EpochUTC, J2000, Kilometers, KilometersPerSecond, Radians, Vector3D } from '../main.js';
 
 // / Lambert two-position and time initial orbit determination.
 export class LambertIOD {

package/src/orbit_determination/ModifiedGoodingIOD.ts

@@ -15,7 +15,7 @@
  * Orbital Object ToolKit. If not, see <http://www.gnu.org/licenses/>.
  */
 
-import { Earth, EpochUTC, J2000, Kilometers, KilometersPerSecond, RadecTopocentric, Vector3D } from 'ootk-core';
+import { Earth, EpochUTC, J2000, Kilometers, KilometersPerSecond, RadecTopocentric, Vector3D } from '../main.js';
 import { ForceModel } from '../force/ForceModel.js';
 import { RungeKutta89Propagator } from '../propagator/RungeKutta89Propagator.js';
 import { ObservationOptical } from './../observation/ObservationOptical.js';

package/src/orbit_determination/index.ts

@@ -0,0 +1,7 @@
+export { BatchLeastSquaresOD } from './BatchLeastSquaresOD.js';
+export { BatchLeastSquaresResult } from './BatchLeastSquaresResult.js';
+export { GibbsIOD } from './GibbsIOD.js';
+export { GoodingIOD } from './GoodingIOD.js';
+export { HerrickGibbsIOD } from './HerrickGibbsIOD.js';
+export { LambertIOD } from './LambertIOD.js';
+export { ModifiedGoodingIOD } from './ModifiedGoodingIOD.js';

package/src/propagator/KeplerPropagator.ts

@@ -15,7 +15,7 @@
  * 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';

package/src/propagator/Propagator.ts

@@ -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

@@ -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

@@ -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

@@ -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';

package/src/propagator/RungeKuttaAdaptive.ts

@@ -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';

package/src/propagator/Sgp4Propagator.ts

@@ -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';

package/src/sgp4/index.ts

@@ -0,0 +1,24 @@
+/**
+ * @author Theodore Kruczek.
+ * @license MIT
+ * @copyright (c) 2022-2025 Theodore Kruczek Permission is
+ * hereby granted, free of charge, to any person obtaining a copy of this
+ * software and associated documentation files (the "Software"), to deal in the
+ * Software without restriction, including without limitation the rights to use,
+ * copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
+ * the Software, and to permit persons to whom the Software is furnished to do
+ * so, subject to the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be included in
+ * all copies or substantial portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+ * SOFTWARE.
+ */
+
+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-core 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-core TypeScript implementation is licensed under the MIT License. ootk-core is not affiliated with the original
+authors.