ootk 1.0.8 → 1.5.1

package/README.md

@@ -1,11 +1,13 @@
 # ootk
-[![build](https://img.shields.io/github/workflow/status/thkruz/ootk/CI?style=flat-square)](https://github.com/thkruz/ootk/actions?query=workflow%3ACI) ![Size](https://img.shields.io/github/languages/code-size/thkruz/ootk?style=flat-square) [![Release](https://img.shields.io/github/v/release/thkruz/ootk?style=flat-square)](https://www.npmjs.com/package/ootk)  [![Issues](https://img.shields.io/github/issues/thkruz/ootk?style=flat-square)](https://github.com/thkruz/ootk/issues) [![Coverage](https://img.shields.io/codecov/c/github/thkruz/ootk?style=flat-square)](https://codecov.io/gh/thkruz/ootk) [![License](https://img.shields.io/github/license/thkruz/ootk?style=flat-square)](LICENSE.MD)
+
+[![build](https://img.shields.io/github/workflow/status/thkruz/ootk/CI?style=flat-square)](https://github.com/thkruz/ootk/actions?query=workflow%3ACI) ![Size](https://img.shields.io/github/languages/code-size/thkruz/ootk?style=flat-square) [![Release](https://img.shields.io/github/v/release/thkruz/ootk?style=flat-square)](https://www.npmjs.com/package/ootk) [![Issues](https://img.shields.io/github/issues/thkruz/ootk?style=flat-square)](https://github.com/thkruz/ootk/issues) [![Coverage](https://img.shields.io/codecov/c/github/thkruz/ootk?style=flat-square)](https://codecov.io/gh/thkruz/ootk) [![License](https://img.shields.io/github/license/thkruz/ootk?style=flat-square)](LICENSE.MD)
 
 > An Orbital Object Tookit in Your Web Browser
 
 **ootk** is a modular collection of small libraries for doing math related to orbital objects written in TypeScript. ootk was developed to simplify the math and let you focus on using the results.
 
 ## :blue_book: Table of Contents
+
 - [Installation](#Installation)
 - [Usage](#Usage)
 - [Contributing](#Contributing)
@@ -26,7 +28,7 @@ npm i ootk
 ### Common.js ([Node.js](https://nodejs.org))
 
 ```js
-let Ootk = require('dist/ootk.js');
+let Ootk = require('ootk.js');
 ...
 const satrec = Ootk.Sgp4.createSatrec(line1, line2, 'wgs72', 'i');
 ```
@@ -34,17 +36,17 @@ const satrec = Ootk.Sgp4.createSatrec(line1, line2, 'wgs72', 'i');
 ### ES ([Babel.js](https://babeljs.io/))
 
 ```js
-import * as Ootk from 'lib/ootk.es.js';
+import * as Ootk from 'ootk.es.js';
 ...
 const satrec = Ootk.Sgp4.createSatrec(line1, line2, 'wgs72', 'i');
 ```
 
 ### Script tag
 
-Include `dist/ootk.min.js` as a script in your html:
+Include `dist/ootk.js` as a script in your html:
 
 ```html
-<script src="path/to/dist/ootk.min.js"></script>
+<script src="path/to/dist/ootk.js"></script>
 ```
 
 `Ootk` object will be available in global scope:
@@ -61,20 +63,19 @@ The source code is organized as Common.js modules and uses [ES6 syntax](http://e
 
 2. Install all required packages with NPM by running the following command from repository's root directory:
 
-    ```bash
-    npm install
-    ```
+   ```bash
+   npm install
+   ```
 
 3. Run the following NPM script to build everything:
 
-    ```bash
-    npm run build:umd
-    ```
+   ```bash
+   npm run build
+   ```
 
 ## :gem: NPM Scripts
 
-- `build` compiles TypeScript into ES6 Modules
-- `build:umd` compiles TypeScript into ES6 Modules and generates UMD files
+- `build` compiles TypeScript into ES6 Modules and combines them into a single file in the `dist` directory.
 - `lint` lints source code located in `src` directory with [ESLint](http://eslint.org/)
 - `lint:fix` lints tests located in `src` directory with ESLint and attempts to auto-fix errors
 - `lint:test` lints tests located in `test` directory with ESLint
@@ -106,13 +107,6 @@ Check that your code follows the rules established in eslint.rc:
 npm run lint
 ```
 
-Use [commitzen](https://github.com/commitizen/cz-cli) to format your commit messages:
-
-```bash
-git add .
-git cz
-```
-
 ## :man_scientist: Contributors
 
 This whole project is an example of standing on the shoulder's of giants. None of it would have been possible without the previous work of the following:
@@ -121,8 +115,9 @@ This whole project is an example of standing on the shoulder's of giants. None o
 - [davidcalhoun (David Calhoun)](https://github.com/davidcalhoun)
 - [shashwatak (Shashwat Kandadai)](https://github.com/shashwatak)
 - [brandon-rhodes (Brandon Rhodes)](https://github.com/brandon-rhodes)
-
+- [mourner (Volodymyr Agafonkin)](https://github.com/mourner)
+- [Hypnos (Robert Gester)](https://github.com/Hypnos3)
 
 ## :balance_scale: License
 
-In keeping with the tradition of [Shashwat Kandadai's satellite.js](https://github.com/shashwatak/satellite-js/) and [Brandon Rhodes' sgp4](https://pypi.python.org/pypi/sgp4/), I kept this licensed under the [MIT License](LICENSE.md).
+Due to the expanding scope of this project, I have placed the code under the [AGPL License](LICENSE.md) in order to ensure that good ideas can be shared and that the code is open for everyone to use.

package/dist/objects/base-object.d.ts

@@ -0,0 +1,40 @@
+/**
+ * @author Theodore Kruczek.
+ * @description Orbital Object ToolKit (OOTK) is a collection of tools for working
+ * with satellites and other orbital objects.
+ *
+ * @file The BaseObject class is used for creating core properties and methods applicable
+ * to ground and space based objects.
+ *
+ * @license AGPL-3.0-or-later
+ * @Copyright (c) 2020-2022 Theodore Kruczek
+ *
+ * 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/>.
+ */
+import { EciVec3, SpaceObjectType } from '../types/types';
+interface ObjectInfo {
+    name?: string;
+    type?: SpaceObjectType;
+    position?: EciVec3;
+    time?: Date;
+}
+export declare class BaseObject {
+    name: string;
+    type: SpaceObjectType;
+    position: EciVec3;
+    time: Date;
+    constructor(info: ObjectInfo);
+    getName(): string;
+    getType(): SpaceObjectType;
+    getTypeString(): string;
+}
+export {};

package/dist/objects/detailed-sat.d.ts

@@ -0,0 +1,66 @@
+/**
+ * @author Theodore Kruczek.
+ * @description Orbital Object ToolKit (OOTK) is a collection of tools for working
+ * with satellites and other orbital objects.
+ *
+ * @file The DetailedSat class is an extension of the Sat class that provides additional
+ * properties for categorizing and filtering satellites.
+ *
+ * @license AGPL-3.0-or-later
+ * @Copyright (c) 2020-2022 Theodore Kruczek
+ *
+ * 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/>.
+ */
+import { LaunchDetails, OperationsDetails, SpaceCraftDetails, SpaceObjectType } from '../types/types';
+import { Sat } from './sat';
+interface ObjectInfo {
+    name?: string;
+    type?: SpaceObjectType;
+    rcs?: number;
+    vmag?: number;
+    tle1: string;
+    tle2: string;
+}
+export declare class DetailedSat extends Sat {
+    launchDate: string;
+    launchMass: string;
+    launchSite: string;
+    launchVehicle: string;
+    lifetime: string | number;
+    maneuver: string;
+    manufacturer: string;
+    motor: string;
+    power: string;
+    payload: string;
+    purpose: string;
+    shape: string;
+    span: string;
+    user: string;
+    mission: string;
+    owner: string;
+    configuration: string;
+    equipment: string;
+    dryMass: string;
+    country: string;
+    constructor(info: ObjectInfo, options: any, details: {
+        launchDetails: LaunchDetails;
+        spaceCraftDetails: SpaceCraftDetails;
+        operationsDetails: OperationsDetails;
+    });
+    setLaunchDetails(details: LaunchDetails): void;
+    getLaunchDetails(): LaunchDetails;
+    setSpaceCraftDetails(details: SpaceCraftDetails): void;
+    getSpaceCraftDetails(): SpaceCraftDetails;
+    setOperationsDetails(details: OperationsDetails): void;
+    getOperationsDetails(): OperationsDetails;
+}
+export {};

package/dist/objects/index.d.ts

@@ -0,0 +1,4 @@
+export { DetailedSat } from './detailed-sat';
+export { Sat } from './sat';
+export { Sensor } from './sensor';
+export { Star } from './star';

package/dist/objects/sat.d.ts

@@ -0,0 +1,88 @@
+/**
+ * @author Theodore Kruczek.
+ * @description Orbital Object ToolKit (OOTK) is a collection of tools for working
+ * with satellites and other orbital objects.
+ *
+ * @file The Sat class provides functions for calculating satellites positions relative
+ * to earth based sensors and other orbital objects.
+ *
+ * @license AGPL-3.0-or-later
+ * @Copyright (c) 2020-2022 Theodore Kruczek
+ *
+ * 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/>.
+ */
+import { EcfVec3, EciVec3, LlaVec3, RaeVec3, SatelliteRecord, SpaceObjectType, StateVector } from '../types/types';
+import { Sensor } from './sensor';
+import { SpaceObject } from './space-object';
+interface ObjectInfo {
+    name?: string;
+    type?: SpaceObjectType;
+    rcs?: number;
+    vmag?: number;
+    tle1: string;
+    tle2: string;
+}
+export declare class Sat extends SpaceObject {
+    satNum: number;
+    satrec: SatelliteRecord;
+    intlDes: string;
+    epochYear: number;
+    epochDay: number;
+    meanMoDev1: number;
+    meanMoDev2: number;
+    bstar: number;
+    inclination: number;
+    raan: number;
+    eccentricity: number;
+    argOfPerigee: number;
+    meanAnomaly: number;
+    meanMotion: number;
+    period: number;
+    apogee: number;
+    perigee: number;
+    options: any;
+    constructor(info: ObjectInfo, options: any);
+    propagateTo(date: Date): Sat;
+    /**
+     * Calculates position and velocity in ECI coordinates at a given time.
+     * @param {Date} date Date to calculate the state vector for
+     * @returns {StateVector} State vector for the given date
+     */
+    getStateVec(date?: Date): StateVector;
+    /**
+     * Calculates ECI position at a given time.
+     * @param {Date} date Date to calculate
+     * @returns {EciVec3} ECI position vector
+     */
+    getEci(date?: Date): EciVec3;
+    /**
+     * Calculates ECF position at a given time.
+     * @param {Date} date Date to calculate
+     * @returns {EcfVec3} ECF position vector
+     */
+    getEcf(date?: Date): EcfVec3;
+    /**
+     * Calculates LLA position at a given time.
+     * @param {Date} date Date to calculate
+     * @returns {LlaVec3} LLA position vector
+     */
+    getLla(date?: Date): LlaVec3;
+    getRae(sensor: Sensor, date?: Date): RaeVec3;
+    /**
+     * Calculates the time variables for a given date relative to the TLE epoch.
+     * @param {Date} date Date to calculate
+     * @param {SatelliteRecord} satrec Satellite orbital information
+     * @returns {{m: number, gmst: GreenwichMeanSiderealTime, j: number}} Time variables
+     */
+    private static calculateTimeVariables;
+}
+export {};

package/dist/objects/sensor.d.ts

@@ -0,0 +1,40 @@
+/**
+ * @author Theodore Kruczek.
+ * @description Orbital Object ToolKit (OOTK) is a collection of tools for working
+ * with satellites and other orbital objects.
+ *
+ * @file The Sensor class is used for creating ground based observers.
+ *
+ * @license AGPL-3.0-or-later
+ * @Copyright (c) 2020-2022 Theodore Kruczek
+ *
+ * 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/>.
+ */
+import { RaeVec3, SpaceObjectType } from '../types/types';
+import { BaseObject } from './base-object';
+import { Sat } from './sat';
+interface ObjectInfo {
+    name?: string;
+    type?: SpaceObjectType;
+    lat: number;
+    lon: number;
+    alt: number;
+}
+export declare class Sensor extends BaseObject {
+    lat: number;
+    lon: number;
+    alt: number;
+    constructor(info: ObjectInfo);
+    setTime(date: Date): Sensor;
+    getRae(sat: Sat, date?: Date): RaeVec3;
+}
+export {};

package/dist/objects/space-object.d.ts

@@ -0,0 +1,38 @@
+/**
+ * @author Theodore Kruczek.
+ * @description Orbital Object ToolKit (OOTK) is a collection of tools for working
+ * with satellites and other orbital objects.
+ *
+ * @file The SpaceObject class is meant to provide properties to satellites/stars that
+ * do not apply to ground based objects.
+ *
+ * @license AGPL-3.0-or-later
+ * @Copyright (c) 2020-2022 Theodore Kruczek
+ *
+ * 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/>.
+ */
+import { BaseObject } from './base-object';
+import { SpaceObjectType } from '../types/types';
+interface ObjectInfo {
+    name?: string;
+    type?: SpaceObjectType;
+    rcs?: number;
+    vmag?: number;
+}
+export declare class SpaceObject extends BaseObject {
+    rcs: number;
+    vmag: number;
+    constructor(info: ObjectInfo);
+    getRcs(): number;
+    getVmag(): number;
+}
+export {};

package/dist/objects/star.d.ts

@@ -0,0 +1,46 @@
+/**
+ * @author Theodore Kruczek.
+ * @description Orbital Object ToolKit (OOTK) is a collection of tools for working
+ * with satellites and other orbital objects.
+ *
+ * @file The Star class is meant to help with cacluating star positions relative to
+ * satellites and earth based sensors.
+ *
+ * @license AGPL-3.0-or-later
+ * @Copyright (c) 2020-2022 Theodore Kruczek
+ *
+ * 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/>.
+ */
+import { EciVec3, LlaVec3, RaeVec3, SpaceObjectType } from '../types/types';
+import { SpaceObject } from './space-object';
+interface ObjectInfo {
+    name?: string;
+    type?: SpaceObjectType;
+    vmag?: number;
+    ra: number;
+    dec: number;
+    pname?: string;
+    bf?: string;
+    h?: string;
+}
+export declare class Star extends SpaceObject {
+    pname: string;
+    bf: string;
+    h: string;
+    dec: number;
+    ra: number;
+    constructor(info: ObjectInfo);
+    getEci(lla?: LlaVec3, date?: Date): EciVec3;
+    getRae(lla?: LlaVec3, date?: Date): RaeVec3;
+    private static calculateTimeVariables;
+}
+export {};

package/dist/ootk.d.ts

@@ -3,28 +3,23 @@
  * @description Orbital Object ToolKit (OOTK) is a collection of tools for working
  * with satellites and other orbital objects.
  *
- * @copyright MIT License.
- * Copyright (c) 2020-2021 Theodore Kruczek
+ * @license AGPL-3.0-or-later
+ * @Copyright (c) 2020-2022 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:
+ * 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.
  *
- * The above copyright notice and this permission notice shall be included in all
- * copies or substantial portions of the Software.
+ * 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.
  *
- * 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.
+ * 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';
-export { Transforms } from './transforms';
-export { Utils } from './utils';
-export * from './types';
+export { Sgp4 } from './sgp4/sgp4';
+export { Transforms } from './transforms/transforms';
+export { Utils } from './utils/utils';
+export { Tle } from './tle/tle';
+export * from './objects/index';
+export * from './types/types';