@neaps/tide-predictor 0.0.4

package/lib/index.js

@@ -0,0 +1,53 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports["default"] = void 0;
+
+var _index = _interopRequireDefault(require("./harmonics/index"));
+
+function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { "default": obj }; }
+
+var tidePredictionFactory = function tidePredictionFactory(constituents, options) {
+  var harmonicsOptions = {
+    harmonicConstituents: constituents,
+    phaseKey: 'phase_GMT',
+    offset: false
+  };
+
+  if (typeof options !== 'undefined') {
+    Object.keys(harmonicsOptions).forEach(function (key) {
+      if (typeof options[key] !== 'undefined') {
+        harmonicsOptions[key] = options[key];
+      }
+    });
+  }
+
+  var tidePrediction = {
+    getTimelinePrediction: function getTimelinePrediction(_ref) {
+      var start = _ref.start,
+          end = _ref.end;
+      return (0, _index["default"])(harmonicsOptions).setTimeSpan(start, end).prediction().getTimelinePrediction();
+    },
+    getExtremesPrediction: function getExtremesPrediction(_ref2) {
+      var start = _ref2.start,
+          end = _ref2.end,
+          labels = _ref2.labels,
+          offsets = _ref2.offsets,
+          timeFidelity = _ref2.timeFidelity;
+      return (0, _index["default"])(harmonicsOptions).setTimeSpan(start, end).prediction({
+        timeFidelity: timeFidelity
+      }).getExtremesPrediction(labels, offsets);
+    },
+    getWaterLevelAtTime: function getWaterLevelAtTime(_ref3) {
+      var time = _ref3.time;
+      var endDate = new Date(time.getTime() + 10 * 60 * 1000);
+      return (0, _index["default"])(harmonicsOptions).setTimeSpan(time, endDate).prediction().getTimelinePrediction()[0];
+    }
+  };
+  return tidePrediction;
+};
+
+var _default = tidePredictionFactory;
+exports["default"] = _default;

package/lib/node-corrections/index.js

@@ -0,0 +1,147 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports["default"] = void 0;
+
+var _constants = require("../astronomy/constants");
+
+var corrections = {
+  fUnity: function fUnity() {
+    return 1;
+  },
+  // Schureman equations 73, 65
+  fMm: function fMm(a) {
+    var omega = _constants.d2r * a.omega.value;
+    var i = _constants.d2r * a.i.value;
+    var I = _constants.d2r * a.I.value;
+    var mean = (2 / 3.0 - Math.pow(Math.sin(omega), 2)) * (1 - 3 / 2.0 * Math.pow(Math.sin(i), 2));
+    return (2 / 3.0 - Math.pow(Math.sin(I), 2)) / mean;
+  },
+  // Schureman equations 74, 66
+  fMf: function fMf(a) {
+    var omega = _constants.d2r * a.omega.value;
+    var i = _constants.d2r * a.i.value;
+    var I = _constants.d2r * a.I.value;
+    var mean = Math.pow(Math.sin(omega), 2) * Math.pow(Math.cos(0.5 * i), 4);
+    return Math.pow(Math.sin(I), 2) / mean;
+  },
+  // Schureman equations 75, 67
+  fO1: function fO1(a) {
+    var omega = _constants.d2r * a.omega.value;
+    var i = _constants.d2r * a.i.value;
+    var I = _constants.d2r * a.I.value;
+    var mean = Math.sin(omega) * Math.pow(Math.cos(0.5 * omega), 2) * Math.pow(Math.cos(0.5 * i), 4);
+    return Math.sin(I) * Math.pow(Math.cos(0.5 * I), 2) / mean;
+  },
+  // Schureman equations 76, 68
+  fJ1: function fJ1(a) {
+    var omega = _constants.d2r * a.omega.value;
+    var i = _constants.d2r * a.i.value;
+    var I = _constants.d2r * a.I.value;
+    var mean = Math.sin(2 * omega) * (1 - 3 / 2.0 * Math.pow(Math.sin(i), 2));
+    return Math.sin(2 * I) / mean;
+  },
+  // Schureman equations 77, 69
+  fOO1: function fOO1(a) {
+    var omega = _constants.d2r * a.omega.value;
+    var i = _constants.d2r * a.i.value;
+    var I = _constants.d2r * a.I.value;
+    var mean = Math.sin(omega) * Math.pow(Math.sin(0.5 * omega), 2) * Math.pow(Math.cos(0.5 * i), 4);
+    return Math.sin(I) * Math.pow(Math.sin(0.5 * I), 2) / mean;
+  },
+  // Schureman equations 78, 70
+  fM2: function fM2(a) {
+    var omega = _constants.d2r * a.omega.value;
+    var i = _constants.d2r * a.i.value;
+    var I = _constants.d2r * a.I.value;
+    var mean = Math.pow(Math.cos(0.5 * omega), 4) * Math.pow(Math.cos(0.5 * i), 4);
+    return Math.pow(Math.cos(0.5 * I), 4) / mean;
+  },
+  // Schureman equations 227, 226, 68
+  // Should probably eventually include the derivations of the magic numbers (0.5023 etc).
+  fK1: function fK1(a) {
+    var omega = _constants.d2r * a.omega.value;
+    var i = _constants.d2r * a.i.value;
+    var I = _constants.d2r * a.I.value;
+    var nu = _constants.d2r * a.nu.value;
+    var sin2IcosnuMean = Math.sin(2 * omega) * (1 - 3 / 2.0 * Math.pow(Math.sin(i), 2));
+    var mean = 0.5023 * sin2IcosnuMean + 0.1681;
+    return Math.pow(0.2523 * Math.pow(Math.sin(2 * I), 2) + 0.1689 * Math.sin(2 * I) * Math.cos(nu) + 0.0283, 0.5) / mean;
+  },
+  // Schureman equations 215, 213, 204
+  // It can be (and has been) confirmed that the exponent for R_a reads 1/2 via Schureman Table 7
+  fL2: function fL2(a) {
+    var P = _constants.d2r * a.P.value;
+    var I = _constants.d2r * a.I.value;
+    var rAInv = Math.pow(1 - 12 * Math.pow(Math.tan(0.5 * I), 2) * Math.cos(2 * P) + 36 * Math.pow(Math.tan(0.5 * I), 4), 0.5);
+    return corrections.fM2(a) * rAInv;
+  },
+  // Schureman equations 235, 234, 71
+  // Again, magic numbers
+  fK2: function fK2(a) {
+    var omega = _constants.d2r * a.omega.value;
+    var i = _constants.d2r * a.i.value;
+    var I = _constants.d2r * a.I.value;
+    var nu = _constants.d2r * a.nu.value;
+    var sinsqIcos2nuMean = Math.pow(Math.sin(omega), 2) * (1 - 3 / 2.0 * Math.pow(Math.sin(i), 2));
+    var mean = 0.5023 * sinsqIcos2nuMean + 0.0365;
+    return Math.pow(0.2523 * Math.pow(Math.sin(I), 4) + 0.0367 * Math.pow(Math.sin(I), 2) * Math.cos(2 * nu) + 0.0013, 0.5) / mean;
+  },
+  // Schureman equations 206, 207, 195
+  fM1: function fM1(a) {
+    var P = _constants.d2r * a.P.value;
+    var I = _constants.d2r * a.I.value;
+    var qAInv = Math.pow(0.25 + 1.5 * Math.cos(I) * Math.cos(2 * P) * Math.pow(Math.cos(0.5 * I), -0.5) + 2.25 * Math.pow(Math.cos(I), 2) * Math.pow(Math.cos(0.5 * I), -4), 0.5);
+    return corrections.fO1(a) * qAInv;
+  },
+  // See e.g. Schureman equation 149
+  fModd: function fModd(a, n) {
+    return Math.pow(corrections.fM2(a), n / 2.0);
+  },
+  // Node factors u, see Table 2 of Schureman.
+  uZero: function uZero(a) {
+    return 0.0;
+  },
+  uMf: function uMf(a) {
+    return -2.0 * a.xi.value;
+  },
+  uO1: function uO1(a) {
+    return 2.0 * a.xi.value - a.nu.value;
+  },
+  uJ1: function uJ1(a) {
+    return -a.nu.value;
+  },
+  uOO1: function uOO1(a) {
+    return -2.0 * a.xi.value - a.nu.value;
+  },
+  uM2: function uM2(a) {
+    return 2.0 * a.xi.value - 2.0 * a.nu.value;
+  },
+  uK1: function uK1(a) {
+    return -a.nup.value;
+  },
+  // Schureman 214
+  uL2: function uL2(a) {
+    var I = _constants.d2r * a.I.value;
+    var P = _constants.d2r * a.P.value;
+    var R = _constants.r2d * Math.atan(Math.sin(2 * P) / (1 / 6.0 * Math.pow(Math.tan(0.5 * I), -2) - Math.cos(2 * P)));
+    return 2.0 * a.xi.value - 2.0 * a.nu.value - R;
+  },
+  uK2: function uK2(a) {
+    return -2.0 * a.nupp.value;
+  },
+  // Schureman 202
+  uM1: function uM1(a) {
+    var I = _constants.d2r * a.I.value;
+    var P = _constants.d2r * a.P.value;
+    var Q = _constants.r2d * Math.atan((5 * Math.cos(I) - 1) / (7 * Math.cos(I) + 1) * Math.tan(P));
+    return a.xi.value - a.nu.value + Q;
+  },
+  uModd: function uModd(a, n) {
+    return n / 2.0 * corrections.uM2(a);
+  }
+};
+var _default = corrections;
+exports["default"] = _default;

package/package.json

@@ -0,0 +1,45 @@
+{
+  "name": "@neaps/tide-predictor",
+  "version": "0.0.4",
+  "description": "Tide predictor",
+  "main": "",
+  "repository": "https://github.com/neaps/tide-predictor",
+  "author": "Kevin Miller <keveemiller@gmail.com>",
+  "license": "MIT",
+  "module": "./lib/index.es6.js",
+  "browser": "./dist/tide-predictor.js",
+  "dependencies": {},
+  "devDependencies": {
+    "@babel/core": "^7.6.2",
+    "@babel/preset-env": "^7.6.2",
+    "babel-jest": "^27.2.0",
+    "babel-preset-env": "^1.7.0",
+    "eslint": "^7.10.0",
+    "eslint-config-standard": "^14.1.0",
+    "eslint-plugin-import": "^2.18.2",
+    "eslint-plugin-jest": "^24.0.2",
+    "eslint-plugin-node": "^11.1.0",
+    "eslint-plugin-promise": "^4.2.1",
+    "eslint-plugin-standard": "^4.0.1",
+    "grunt": "^1.4.1",
+    "grunt-babel": "^8.0.0",
+    "grunt-contrib-clean": "^2.0.0",
+    "grunt-contrib-uglify": "^5.0.0",
+    "grunt-contrib-watch": "^1.1.0",
+    "grunt-coveralls": "^2.0.0",
+    "grunt-eslint": "^23.0.0",
+    "grunt-exec": "^3.0.0",
+    "jest": "^27.2.0",
+    "jest-junit": "^11.0.1",
+    "kind-of": "^6.0.3",
+    "node-fetch": "^2.6.0",
+    "rollup-plugin-babel": "^4.3.3",
+    "rollup-plugin-node-resolve": "^5.2.0"
+  },
+  "scripts": {
+    "test": "BABEL_ENV=test jest",
+    "coverage": "jest --coverage; grunt coveralls;",
+    "lint": "eslint ./src",
+    "ci": "yarn run lint; jest --ci --runInBand --reporters=default --reporters=jest-junit"
+  }
+}

package/rollup.config.js

@@ -0,0 +1,21 @@
+import pkg from './package.json'
+import resolve from 'rollup-plugin-node-resolve'
+
+export default {
+  input: './src/index.js',
+  output: [
+    {
+      name: 'tidePredictor',
+      file: pkg.browser,
+      format: 'umd'
+    },
+    { file: pkg.module, format: 'es' }
+  ],
+  plugins: [
+    resolve({
+      mainFields: ['module', 'main'],
+
+      jail: '/src' // Default: '/'
+    })
+  ]
+}

package/src/__mocks__/constituents.js

@@ -0,0 +1,335 @@
+export default [
+  {
+    number: 1,
+    name: 'M2',
+    description: 'Principal lunar semidiurnal constituent',
+    amplitude: 1.61,
+    phase_GMT: 181.3,
+    phase_local: 309.4,
+    speed: 28.984104
+  },
+  {
+    number: 2,
+    name: 'S2',
+    description: 'Principal solar semidiurnal constituent',
+    amplitude: 0.43,
+    phase_GMT: 180.1,
+    phase_local: 300.1,
+    speed: 30.0
+  },
+  {
+    number: 3,
+    name: 'N2',
+    description: 'Larger lunar elliptic semidiurnal constituent',
+    amplitude: 0.37,
+    phase_GMT: 155.0,
+    phase_local: 287.4,
+    speed: 28.43973
+  },
+  {
+    number: 4,
+    name: 'K1',
+    description: 'Lunar diurnal constituent',
+    amplitude: 1.2,
+    phase_GMT: 219.6,
+    phase_local: 99.2,
+    speed: 15.041069
+  },
+  {
+    number: 5,
+    name: 'M4',
+    description: 'Shallow water overtides of principal lunar constituent',
+    amplitude: 0.0,
+    phase_GMT: 272.7,
+    phase_local: 168.9,
+    speed: 57.96821
+  },
+  {
+    number: 6,
+    name: 'O1',
+    description: 'Lunar diurnal constituent',
+    amplitude: 0.75,
+    phase_GMT: 203.5,
+    phase_local: 91.9,
+    speed: 13.943035
+  },
+  {
+    number: 7,
+    name: 'M6',
+    description: 'Shallow water overtides of principal lunar constituent',
+    amplitude: 0.0,
+    phase_GMT: 0.0,
+    phase_local: 0.0,
+    speed: 86.95232
+  },
+  {
+    number: 8,
+    name: 'MK3',
+    description: 'Shallow water terdiurnal',
+    amplitude: 0.0,
+    phase_GMT: 0.0,
+    phase_local: 0.0,
+    speed: 44.025173
+  },
+  {
+    number: 9,
+    name: 'S4',
+    description: 'Shallow water overtides of principal solar constituent',
+    amplitude: 0.0,
+    phase_GMT: 343.5,
+    phase_local: 223.5,
+    speed: 60.0
+  },
+  {
+    number: 10,
+    name: 'MN4',
+    description: 'Shallow water quarter diurnal constituent',
+    amplitude: 0.0,
+    phase_GMT: 233.4,
+    phase_local: 134.0,
+    speed: 57.423832
+  },
+  {
+    number: 11,
+    name: 'NU2',
+    description: 'Larger lunar evectional constituent',
+    amplitude: 0.07,
+    phase_GMT: 160.9,
+    phase_local: 292.8,
+    speed: 28.512583
+  },
+  {
+    number: 12,
+    name: 'S6',
+    description: 'Shallow water overtides of principal solar constituent',
+    amplitude: 0.0,
+    phase_GMT: 0.0,
+    phase_local: 0.0,
+    speed: 90.0
+  },
+  {
+    number: 13,
+    name: 'MU2',
+    description: 'Variational constituent',
+    amplitude: 0.04,
+    phase_GMT: 114.7,
+    phase_local: 250.9,
+    speed: 27.968208
+  },
+  {
+    number: 14,
+    name: '2N2',
+    description: 'Lunar elliptical semidiurnal second-order constituent',
+    amplitude: 0.05,
+    phase_GMT: 125.4,
+    phase_local: 262.2,
+    speed: 27.895355
+  },
+  {
+    number: 15,
+    name: 'OO1',
+    description: 'Lunar diurnal',
+    amplitude: 0.04,
+    phase_GMT: 246.4,
+    phase_local: 117.3,
+    speed: 16.139101
+  },
+  {
+    number: 16,
+    name: 'LAM2',
+    description: 'Smaller lunar evectional constituent',
+    amplitude: 0.01,
+    phase_GMT: 213.6,
+    phase_local: 337.9,
+    speed: 29.455626
+  },
+  {
+    number: 17,
+    name: 'S1',
+    description: 'Solar diurnal constituent',
+    amplitude: 0.03,
+    phase_GMT: 317.1,
+    phase_local: 197.1,
+    speed: 15.0
+  },
+  {
+    number: 18,
+    name: 'M1',
+    description: 'Smaller lunar elliptic diurnal constituent',
+    amplitude: 0.04,
+    phase_GMT: 224.9,
+    phase_local: 108.9,
+    speed: 14.496694
+  },
+  {
+    number: 19,
+    name: 'J1',
+    description: 'Smaller lunar elliptic diurnal constituent',
+    amplitude: 0.07,
+    phase_GMT: 232.3,
+    phase_local: 107.5,
+    speed: 15.5854435
+  },
+  {
+    number: 20,
+    name: 'MM',
+    description: 'Lunar monthly constituent',
+    amplitude: 0.0,
+    phase_GMT: 0.0,
+    phase_local: 0.0,
+    speed: 0.5443747
+  },
+  {
+    number: 21,
+    name: 'SSA',
+    description: 'Solar semiannual constituent',
+    amplitude: 0.07,
+    phase_GMT: 264.6,
+    phase_local: 263.9,
+    speed: 0.0821373
+  },
+  {
+    number: 22,
+    name: 'SA',
+    description: 'Solar annual constituent',
+    amplitude: 0.2,
+    phase_GMT: 198.5,
+    phase_local: 198.1,
+    speed: 0.0410686
+  },
+  {
+    number: 23,
+    name: 'MSF',
+    description: 'Lunisolar synodic fortnightly constituent',
+    amplitude: 0.0,
+    phase_GMT: 0.0,
+    phase_local: 0.0,
+    speed: 1.0158958
+  },
+  {
+    number: 24,
+    name: 'MF',
+    description: 'Lunisolar fortnightly constituent',
+    amplitude: 0.04,
+    phase_GMT: 138.1,
+    phase_local: 129.3,
+    speed: 1.0980331
+  },
+  {
+    number: 25,
+    name: 'RHO',
+    description: 'Larger lunar evectional diurnal constituent',
+    amplitude: 0.02,
+    phase_GMT: 197.0,
+    phase_local: 89.2,
+    speed: 13.471515
+  },
+  {
+    number: 26,
+    name: 'Q1',
+    description: 'Larger lunar elliptic diurnal constituent',
+    amplitude: 0.13,
+    phase_GMT: 194.8,
+    phase_local: 87.5,
+    speed: 13.398661
+  },
+  {
+    number: 27,
+    name: 'T2',
+    description: 'Larger solar elliptic constituent',
+    amplitude: 0.02,
+    phase_GMT: 165.3,
+    phase_local: 285.6,
+    speed: 29.958933
+  },
+  {
+    number: 28,
+    name: 'R2',
+    description: 'Smaller solar elliptic constituent',
+    amplitude: 0.0,
+    phase_GMT: 163.2,
+    phase_local: 282.9,
+    speed: 30.041067
+  },
+  {
+    number: 29,
+    name: '2Q1',
+    description: 'Larger elliptic diurnal',
+    amplitude: 0.02,
+    phase_GMT: 191.7,
+    phase_local: 88.8,
+    speed: 12.854286
+  },
+  {
+    number: 30,
+    name: 'P1',
+    description: 'Solar diurnal constituent',
+    amplitude: 0.38,
+    phase_GMT: 215.8,
+    phase_local: 96.1,
+    speed: 14.958931
+  },
+  {
+    number: 31,
+    name: '2SM2',
+    description: 'Shallow water semidiurnal constituent',
+    amplitude: 0.0,
+    phase_GMT: 348.1,
+    phase_local: 99.9,
+    speed: 31.015896
+  },
+  {
+    number: 32,
+    name: 'M3',
+    description: 'Lunar terdiurnal constituent',
+    amplitude: 0.01,
+    phase_GMT: 7.0,
+    phase_local: 19.1,
+    speed: 43.47616
+  },
+  {
+    number: 33,
+    name: 'L2',
+    description: 'Smaller lunar elliptic semidiurnal constituent',
+    amplitude: 0.04,
+    phase_GMT: 213.4,
+    phase_local: 337.1,
+    speed: 29.528479
+  },
+  {
+    number: 34,
+    name: '2MK3',
+    description: 'Shallow water terdiurnal constituent',
+    amplitude: 0.0,
+    phase_GMT: 126.8,
+    phase_local: 143.4,
+    speed: 42.92714
+  },
+  {
+    number: 35,
+    name: 'K2',
+    description: 'Lunisolar semidiurnal constituent',
+    amplitude: 0.12,
+    phase_GMT: 170.6,
+    phase_local: 289.9,
+    speed: 30.082138
+  },
+  {
+    number: 36,
+    name: 'M8',
+    description: 'Shallow water eighth diurnal constituent',
+    amplitude: 0.0,
+    phase_GMT: 0.0,
+    phase_local: 0.0,
+    speed: 115.93642
+  },
+  {
+    number: 37,
+    name: 'MS4',
+    description: 'Shallow water quarter diurnal constituent',
+    amplitude: 0.0,
+    phase_GMT: 264.0,
+    phase_local: 152.1,
+    speed: 58.984104
+  }
+]