@neaps/tide-predictor 0.0.3 → 0.1.1

package/lib/astronomy/index.js

@@ -1,199 +0,0 @@
-"use strict";
-
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-exports._nupp = exports._nup = exports._nu = exports._xi = exports._I = exports.JD = exports.T = exports.derivativePolynomial = exports.polynomial = exports["default"] = void 0;
-
-var _constants = require("./constants");
-
-var _coefficients = _interopRequireDefault(require("./coefficients"));
-
-function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { "default": obj }; }
-
-// Evaluates a polynomial at argument
-var polynomial = function polynomial(coefficients, argument) {
-  var result = [];
-  coefficients.forEach(function (coefficient, index) {
-    result.push(coefficient * Math.pow(argument, index));
-  });
-  return result.reduce(function (a, b) {
-    return a + b;
-  });
-}; // Evaluates a derivative polynomial at argument
-
-
-exports.polynomial = polynomial;
-
-var derivativePolynomial = function derivativePolynomial(coefficients, argument) {
-  var result = [];
-  coefficients.forEach(function (coefficient, index) {
-    result.push(coefficient * index * Math.pow(argument, index - 1));
-  });
-  return result.reduce(function (a, b) {
-    return a + b;
-  });
-}; // Meeus formula 11.1
-
-
-exports.derivativePolynomial = derivativePolynomial;
-
-var T = function T(t) {
-  return (JD(t) - 2451545.0) / 36525;
-}; // Meeus formula 7.1
-
-
-exports.T = T;
-
-var JD = function JD(t) {
-  var Y = t.getFullYear();
-  var M = t.getMonth() + 1;
-  var D = t.getDate() + t.getHours() / 24.0 + t.getMinutes() / (24.0 * 60.0) + t.getSeconds() / (24.0 * 60.0 * 60.0) + t.getMilliseconds() / (24.0 * 60.0 * 60.0 * 1e6);
-
-  if (M <= 2) {
-    Y = Y - 1;
-    M = M + 12;
-  }
-
-  var A = Math.floor(Y / 100.0);
-  var B = 2 - A + Math.floor(A / 4.0);
-  return Math.floor(365.25 * (Y + 4716)) + Math.floor(30.6001 * (M + 1)) + D + B - 1524.5;
-};
-/**
- * @todo - What's  with the array returned from the arccos?
- * @param {*} N
- * @param {*} i
- * @param {*} omega
- */
-
-
-exports.JD = JD;
-
-var _I = function _I(N, i, omega) {
-  N = _constants.d2r * N;
-  i = _constants.d2r * i;
-  omega = _constants.d2r * omega;
-  var cosI = Math.cos(i) * Math.cos(omega) - Math.sin(i) * Math.sin(omega) * Math.cos(N);
-  return _constants.r2d * Math.acos(cosI);
-};
-
-exports._I = _I;
-
-var _xi = function _xi(N, i, omega) {
-  N = _constants.d2r * N;
-  i = _constants.d2r * i;
-  omega = _constants.d2r * omega;
-  var e1 = Math.cos(0.5 * (omega - i)) / Math.cos(0.5 * (omega + i)) * Math.tan(0.5 * N);
-  var e2 = Math.sin(0.5 * (omega - i)) / Math.sin(0.5 * (omega + i)) * Math.tan(0.5 * N);
-  e1 = Math.atan(e1);
-  e2 = Math.atan(e2);
-  e1 = e1 - 0.5 * N;
-  e2 = e2 - 0.5 * N;
-  return -(e1 + e2) * _constants.r2d;
-};
-
-exports._xi = _xi;
-
-var _nu = function _nu(N, i, omega) {
-  N = _constants.d2r * N;
-  i = _constants.d2r * i;
-  omega = _constants.d2r * omega;
-  var e1 = Math.cos(0.5 * (omega - i)) / Math.cos(0.5 * (omega + i)) * Math.tan(0.5 * N);
-  var e2 = Math.sin(0.5 * (omega - i)) / Math.sin(0.5 * (omega + i)) * Math.tan(0.5 * N);
-  e1 = Math.atan(e1);
-  e2 = Math.atan(e2);
-  e1 = e1 - 0.5 * N;
-  e2 = e2 - 0.5 * N;
-  return (e1 - e2) * _constants.r2d;
-}; // Schureman equation 224
-
-
-exports._nu = _nu;
-
-var _nup = function _nup(N, i, omega) {
-  var I = _constants.d2r * _I(N, i, omega);
-
-  var nu = _constants.d2r * _nu(N, i, omega);
-
-  return _constants.r2d * Math.atan(Math.sin(2 * I) * Math.sin(nu) / (Math.sin(2 * I) * Math.cos(nu) + 0.3347));
-}; // Schureman equation 232
-
-
-exports._nup = _nup;
-
-var _nupp = function _nupp(N, i, omega) {
-  var I = _constants.d2r * _I(N, i, omega);
-
-  var nu = _constants.d2r * _nu(N, i, omega);
-
-  var tan2nupp = Math.pow(Math.sin(I), 2) * Math.sin(2 * nu) / (Math.pow(Math.sin(I), 2) * Math.cos(2 * nu) + 0.0727);
-  return _constants.r2d * 0.5 * Math.atan(tan2nupp);
-};
-
-exports._nupp = _nupp;
-
-var modulus = function modulus(a, b) {
-  return (a % b + b) % b;
-};
-
-var astro = function astro(time) {
-  var result = {};
-  var polynomials = {
-    s: _coefficients["default"].lunarLongitude,
-    h: _coefficients["default"].solarLongitude,
-    p: _coefficients["default"].lunarPerigee,
-    N: _coefficients["default"].lunarNode,
-    pp: _coefficients["default"].solarPerigee,
-    90: [90.0],
-    omega: _coefficients["default"].terrestrialObliquity,
-    i: _coefficients["default"].lunarInclination
-  }; // Polynomials are in T, that is Julian Centuries; we want our speeds to be
-  // in the more convenient unit of degrees per hour.
-
-  var dTdHour = 1 / (24 * 365.25 * 100);
-  Object.keys(polynomials).forEach(function (name) {
-    result[name] = {
-      value: modulus(polynomial(polynomials[name], T(time)), 360.0),
-      speed: derivativePolynomial(polynomials[name], T(time)) * dTdHour
-    };
-  }); // Some other parameters defined by Schureman which are dependent on the
-  // parameters N, i, omega for use in node factor calculations. We don't need
-  // their speeds.
-
-  var functions = {
-    I: _I,
-    xi: _xi,
-    nu: _nu,
-    nup: _nup,
-    nupp: _nupp
-  };
-  Object.keys(functions).forEach(function (name) {
-    var functionCall = functions[name];
-    result[name] = {
-      value: modulus(functionCall(result.N.value, result.i.value, result.omega.value), 360.0),
-      speed: null
-    };
-  }); // We don't work directly with the T (hours) parameter, instead our spanning
-  // set for equilibrium arguments #is given by T+h-s, s, h, p, N, pp, 90.
-  // This is in line with convention.
-
-  var hour = {
-    value: (JD(time) - Math.floor(JD(time))) * 360.0,
-    speed: 15.0
-  };
-  result['T+h-s'] = {
-    value: hour.value + result.h.value - result.s.value,
-    speed: hour.speed + result.h.speed - result.s.speed
-  }; // It is convenient to calculate Schureman's P here since several node
-  // factors need it, although it could be argued that these
-  // (along with I, xi, nu etc) belong somewhere else.
-
-  result.P = {
-    value: result.p.value - result.xi.value % 360.0,
-    speed: null
-  };
-  return result;
-};
-
-var _default = astro;
-exports["default"] = _default;

package/lib/constituents/compound-constituent.js

@@ -1,67 +0,0 @@
-"use strict";
-
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-exports["default"] = void 0;
-
-var compoundConstituentFactory = function compoundConstituentFactory(name, members) {
-  var coefficients = [];
-  members.forEach(function (_ref) {
-    var constituent = _ref.constituent,
-        factor = _ref.factor;
-    constituent.coefficients.forEach(function (coefficient, index) {
-      if (typeof coefficients[index] === 'undefined') {
-        coefficients[index] = 0;
-      }
-
-      coefficients[index] += coefficient * factor;
-    });
-  });
-  var compoundConstituent = {
-    name: name,
-    coefficients: coefficients,
-    speed: function speed(astro) {
-      var speed = 0;
-      members.forEach(function (_ref2) {
-        var constituent = _ref2.constituent,
-            factor = _ref2.factor;
-        speed += constituent.speed(astro) * factor;
-      });
-      return speed;
-    },
-    value: function value(astro) {
-      var value = 0;
-      members.forEach(function (_ref3) {
-        var constituent = _ref3.constituent,
-            factor = _ref3.factor;
-        value += constituent.value(astro) * factor;
-      });
-      return value;
-    },
-    u: function u(astro) {
-      var u = 0;
-      members.forEach(function (_ref4) {
-        var constituent = _ref4.constituent,
-            factor = _ref4.factor;
-        u += constituent.u(astro) * factor;
-      });
-      return u;
-    },
-    f: function f(astro) {
-      var f = [];
-      members.forEach(function (_ref5) {
-        var constituent = _ref5.constituent,
-            factor = _ref5.factor;
-        f.push(Math.pow(constituent.f(astro), Math.abs(factor)));
-      });
-      return f.reduce(function (previous, value) {
-        return previous * value;
-      });
-    }
-  };
-  return Object.freeze(compoundConstituent);
-};
-
-var _default = compoundConstituentFactory;
-exports["default"] = _default;

package/lib/constituents/constituent.js

@@ -1,74 +0,0 @@
-"use strict";
-
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-exports.astronomicValues = exports.astronomicSpeed = exports.astronimicDoodsonNumber = exports["default"] = void 0;
-
-var _index = _interopRequireDefault(require("../node-corrections/index"));
-
-function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { "default": obj }; }
-
-/**
- * Computes the dot notation of two arrays
- * @param {*} a
- * @param {*} b
- */
-var dotArray = function dotArray(a, b) {
-  var results = [];
-  a.forEach(function (value, index) {
-    results.push(value * b[index]);
-  });
-  return results.reduce(function (total, value) {
-    return total + value;
-  });
-};
-
-var astronimicDoodsonNumber = function astronimicDoodsonNumber(astro) {
-  return [astro['T+h-s'], astro.s, astro.h, astro.p, astro.N, astro.pp, astro['90']];
-};
-
-exports.astronimicDoodsonNumber = astronimicDoodsonNumber;
-
-var astronomicSpeed = function astronomicSpeed(astro) {
-  var results = [];
-  astronimicDoodsonNumber(astro).forEach(function (number) {
-    results.push(number.speed);
-  });
-  return results;
-};
-
-exports.astronomicSpeed = astronomicSpeed;
-
-var astronomicValues = function astronomicValues(astro) {
-  var results = [];
-  astronimicDoodsonNumber(astro).forEach(function (number) {
-    results.push(number.value);
-  });
-  return results;
-};
-
-exports.astronomicValues = astronomicValues;
-
-var constituentFactory = function constituentFactory(name, coefficients, u, f) {
-  if (!coefficients) {
-    throw new Error('Coefficient must be defined for a constituent');
-  }
-
-  var constituent = {
-    name: name,
-    coefficients: coefficients,
-    value: function value(astro) {
-      return dotArray(coefficients, astronomicValues(astro));
-    },
-    speed: function speed(astro) {
-      return dotArray(coefficients, astronomicSpeed(astro));
-    },
-    u: typeof u !== 'undefined' ? u : _index["default"].uZero,
-    f: typeof f !== 'undefined' ? f : _index["default"].fUnity
-  };
-  return Object.freeze(constituent);
-};
-
-var _default = constituentFactory;
-exports["default"] = _default;

package/lib/constituents/index.js

@@ -1,140 +0,0 @@
-"use strict";
-
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-exports["default"] = void 0;
-
-var _constituent = _interopRequireDefault(require("./constituent"));
-
-var _compoundConstituent = _interopRequireDefault(require("./compound-constituent"));
-
-var _index = _interopRequireDefault(require("../node-corrections/index"));
-
-function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { "default": obj }; }
-
-var constituents = {}; // Long Term
-
-constituents.Z0 = (0, _constituent["default"])('Z0', [0, 0, 0, 0, 0, 0, 0], _index["default"].uZero, _index["default"].fUnity);
-constituents.SA = (0, _constituent["default"])('Sa', [0, 0, 1, 0, 0, 0, 0], _index["default"].uZero, _index["default"].fUnity);
-constituents.SSA = (0, _constituent["default"])('Ssa', [0, 0, 2, 0, 0, 0, 0], _index["default"].uZero, _index["default"].fUnity);
-constituents.MM = (0, _constituent["default"])('MM', [0, 1, 0, -1, 0, 0, 0], _index["default"].uZero, _index["default"].fMm);
-constituents.MF = (0, _constituent["default"])('MF', [0, 2, 0, 0, 0, 0, 0], _index["default"].uMf, _index["default"].fMf); // Diurnals
-
-constituents.Q1 = (0, _constituent["default"])('Q1', [1, -2, 0, 1, 0, 0, 1], _index["default"].uO1, _index["default"].fO1);
-constituents.O1 = (0, _constituent["default"])('O1', [1, -1, 0, 0, 0, 0, 1], _index["default"].uO1, _index["default"].fO1);
-constituents.K1 = (0, _constituent["default"])('K1', [1, 1, 0, 0, 0, 0, -1], _index["default"].uK1, _index["default"].fK1);
-constituents.J1 = (0, _constituent["default"])('J1', [1, 2, 0, -1, 0, 0, -1], _index["default"].uJ1, _index["default"].fJ1);
-constituents.M1 = (0, _constituent["default"])('M1', [1, 0, 0, 0, 0, 0, 1], _index["default"].uM1, _index["default"].fM1);
-constituents.P1 = (0, _constituent["default"])('P1', [1, 1, -2, 0, 0, 0, 1], _index["default"].uZero, _index["default"].fUnity);
-constituents.S1 = (0, _constituent["default"])('S1', [1, 1, -1, 0, 0, 0, 0], _index["default"].uZero, _index["default"].fUnity);
-constituents.OO1 = (0, _constituent["default"])('OO1', [1, 3, 0, 0, 0, 0, -1], _index["default"].uOO1, _index["default"].fOO1); // Semi diurnals
-
-constituents['2N2'] = (0, _constituent["default"])('2N2', [2, -2, 0, 2, 0, 0, 0], _index["default"].uM2, _index["default"].fM2);
-constituents.N2 = (0, _constituent["default"])('N2', [2, -1, 0, 1, 0, 0, 0], _index["default"].uM2, _index["default"].fM2);
-constituents.NU2 = (0, _constituent["default"])('NU2', [2, -1, 2, -1, 0, 0, 0], _index["default"].uM2, _index["default"].fM2);
-constituents.M2 = (0, _constituent["default"])('M2', [2, 0, 0, 0, 0, 0, 0], _index["default"].uM2, _index["default"].fM2);
-constituents.LAM2 = (0, _constituent["default"])('LAM2', [2, 1, -2, 1, 0, 0, 2], _index["default"].uM2, _index["default"].fM2);
-constituents.L2 = (0, _constituent["default"])('L2', [2, 1, 0, -1, 0, 0, 2], _index["default"].uL2, _index["default"].fL2);
-constituents.T2 = (0, _constituent["default"])('T2', [2, 2, -3, 0, 0, 1, 0], _index["default"].uZero, _index["default"].fUnity);
-constituents.S2 = (0, _constituent["default"])('S2', [2, 2, -2, 0, 0, 0, 0], _index["default"].uZero, _index["default"].fUnity);
-constituents.R2 = (0, _constituent["default"])('R2', [2, 2, -1, 0, 0, -1, 2], _index["default"].uZero, _index["default"].fUnity);
-constituents.K2 = (0, _constituent["default"])('K2', [2, 2, 0, 0, 0, 0, 0], _index["default"].uK2, _index["default"].fK2); // Third diurnal
-
-constituents.M3 = (0, _constituent["default"])('M3', [3, 0, 0, 0, 0, 0, 0], function (a) {
-  return _index["default"].uModd(a, 3);
-}, function (a) {
-  return _index["default"].fModd(a, 3);
-}); // Compound
-
-constituents.MSF = (0, _compoundConstituent["default"])('MSF', [{
-  constituent: constituents.S2,
-  factor: 1
-}, {
-  constituent: constituents.M2,
-  factor: -1
-}]); // Diurnal
-
-constituents['2Q1'] = (0, _compoundConstituent["default"])('2Q1', [{
-  constituent: constituents.N2,
-  factor: 1
-}, {
-  constituent: constituents.J1,
-  factor: -1
-}]);
-constituents.RHO = (0, _compoundConstituent["default"])('RHO', [{
-  constituent: constituents.NU2,
-  factor: 1
-}, {
-  constituent: constituents.K1,
-  factor: -1
-}]); // Semi-Diurnal
-
-constituents.MU2 = (0, _compoundConstituent["default"])('MU2', [{
-  constituent: constituents.M2,
-  factor: 2
-}, {
-  constituent: constituents.S2,
-  factor: -1
-}]);
-constituents['2SM2'] = (0, _compoundConstituent["default"])('2SM2', [{
-  constituent: constituents.S2,
-  factor: 2
-}, {
-  constituent: constituents.M2,
-  factor: -1
-}]); // Third-Diurnal
-
-constituents['2MK3'] = (0, _compoundConstituent["default"])('2MK3', [{
-  constituent: constituents.M2,
-  factor: 1
-}, {
-  constituent: constituents.O1,
-  factor: 1
-}]);
-constituents.MK3 = (0, _compoundConstituent["default"])('MK3', [{
-  constituent: constituents.M2,
-  factor: 1
-}, {
-  constituent: constituents.K1,
-  factor: 1
-}]); // Quarter-Diurnal
-
-constituents.MN4 = (0, _compoundConstituent["default"])('MN4', [{
-  constituent: constituents.M2,
-  factor: 1
-}, {
-  constituent: constituents.N2,
-  factor: 1
-}]);
-constituents.M4 = (0, _compoundConstituent["default"])('M4', [{
-  constituent: constituents.M2,
-  factor: 2
-}]);
-constituents.MS4 = (0, _compoundConstituent["default"])('MS4', [{
-  constituent: constituents.M2,
-  factor: 1
-}, {
-  constituent: constituents.S2,
-  factor: 1
-}]);
-constituents.S4 = (0, _compoundConstituent["default"])('S4', [{
-  constituent: constituents.S2,
-  factor: 2
-}]); // Sixth-Diurnal
-
-constituents.M6 = (0, _compoundConstituent["default"])('M6', [{
-  constituent: constituents.M2,
-  factor: 3
-}]);
-constituents.S6 = (0, _compoundConstituent["default"])('S6', [{
-  constituent: constituents.S2,
-  factor: 3
-}]); // Eighth-Diurnals
-
-constituents.M8 = (0, _compoundConstituent["default"])('M8', [{
-  constituent: constituents.M2,
-  factor: 4
-}]);
-var _default = constituents;
-exports["default"] = _default;

package/lib/harmonics/index.js

@@ -1,113 +0,0 @@
-"use strict";
-
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-exports.getTimeline = exports.getDate = exports["default"] = void 0;
-
-var _prediction = _interopRequireDefault(require("./prediction"));
-
-var _index = _interopRequireDefault(require("../constituents/index"));
-
-var _constants = require("../astronomy/constants");
-
-function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { "default": obj }; }
-
-var getDate = function getDate(time) {
-  if (time instanceof Date) {
-    return time;
-  }
-
-  if (typeof time === 'number') {
-    return new Date(time * 1000);
-  }
-
-  throw new Error('Invalid date format, should be a Date object, or timestamp');
-};
-
-exports.getDate = getDate;
-
-var getTimeline = function getTimeline(start, end, seconds) {
-  seconds = typeof seconds !== 'undefined' ? seconds : 10 * 60;
-  var timeline = [];
-  var endTime = end.getTime() / 1000;
-  var lastTime = start.getTime() / 1000;
-  var startTime = lastTime;
-  var hours = [];
-
-  while (lastTime <= endTime) {
-    timeline.push(new Date(lastTime * 1000));
-    hours.push((lastTime - startTime) / (60 * 60));
-    lastTime += seconds;
-  }
-
-  return {
-    items: timeline,
-    hours: hours
-  };
-};
-
-exports.getTimeline = getTimeline;
-
-var harmonicsFactory = function harmonicsFactory(_ref) {
-  var harmonicConstituents = _ref.harmonicConstituents,
-      phaseKey = _ref.phaseKey,
-      offset = _ref.offset;
-
-  if (!Array.isArray(harmonicConstituents)) {
-    throw new Error('Harmonic constituents are not an array');
-  }
-
-  var constituents = [];
-  harmonicConstituents.forEach(function (constituent, index) {
-    if (typeof constituent.name === 'undefined') {
-      throw new Error('Harmonic constituents must have a name property');
-    }
-
-    if (typeof _index["default"][constituent.name] !== 'undefined') {
-      constituent._model = _index["default"][constituent.name];
-      constituent._phase = _constants.d2r * constituent[phaseKey];
-      constituents.push(constituent);
-    }
-  });
-
-  if (offset !== false) {
-    constituents.push({
-      name: 'Z0',
-      _model: _index["default"].Z0,
-      _phase: 0,
-      amplitude: offset
-    });
-  }
-
-  var start = new Date();
-  var end = new Date();
-  var harmonics = {};
-
-  harmonics.setTimeSpan = function (startTime, endTime) {
-    start = getDate(startTime);
-    end = getDate(endTime);
-
-    if (start.getTime() >= end.getTime()) {
-      throw new Error('Start time must be before end time');
-    }
-
-    return harmonics;
-  };
-
-  harmonics.prediction = function (options) {
-    options = typeof options !== 'undefined' ? options : {
-      timeFidelity: 10 * 60
-    };
-    return (0, _prediction["default"])({
-      timeline: getTimeline(start, end, options.timeFidelity),
-      constituents: constituents,
-      start: start
-    });
-  };
-
-  return Object.freeze(harmonics);
-};
-
-var _default = harmonicsFactory;
-exports["default"] = _default;