npm - @neaps/tide-predictor - Versions diffs - 0.0.4 - Mend

@neaps/tide-predictor 0.0.4

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (46) hide show

package/.eslintrc.js +22 -0
package/.github/workflows/test.yml +15 -0
package/.prettierrc +4 -0
package/Gruntfile.js +87 -0
package/LICENSE +21 -0
package/README.md +199 -0
package/babel.config.js +9 -0
package/dist/tide-predictor.js +1013 -0
package/examples/browser/index.html +51 -0
package/jest.config.js +14 -0
package/lib/astronomy/coefficients.js +31 -0
package/lib/astronomy/constants.js +10 -0
package/lib/astronomy/index.js +199 -0
package/lib/constituents/compound-constituent.js +67 -0
package/lib/constituents/constituent.js +74 -0
package/lib/constituents/index.js +140 -0
package/lib/harmonics/index.js +113 -0
package/lib/harmonics/prediction.js +195 -0
package/lib/index.es6.js +1005 -0
package/lib/index.js +53 -0
package/lib/node-corrections/index.js +147 -0
package/package.json +45 -0
package/rollup.config.js +21 -0
package/src/__mocks__/constituents.js +335 -0
package/src/__mocks__/secondary-station.js +11 -0
package/src/__tests__/index.js +81 -0
package/src/__tests__/noaa.js +92 -0
package/src/astronomy/__tests__/coefficients.js +12 -0
package/src/astronomy/__tests__/index.js +96 -0
package/src/astronomy/coefficients.js +72 -0
package/src/astronomy/constants.js +4 -0
package/src/astronomy/index.js +201 -0
package/src/constituents/__tests__/compound-constituent.js +44 -0
package/src/constituents/__tests__/constituent.js +65 -0
package/src/constituents/__tests__/index.js +34 -0
package/src/constituents/compound-constituent.js +55 -0
package/src/constituents/constituent.js +74 -0
package/src/constituents/index.js +119 -0
package/src/harmonics/__mocks__/water-levels.js +0 -0
package/src/harmonics/__tests__/index.js +123 -0
package/src/harmonics/__tests__/prediction.js +148 -0
package/src/harmonics/index.js +87 -0
package/src/harmonics/prediction.js +175 -0
package/src/index.js +45 -0
package/src/node-corrections/__tests__/index.js +114 -0
package/src/node-corrections/index.js +208 -0

package/examples/browser/index.html ADDED Viewed

@@ -0,0 +1,51 @@
+<!DOCTYPE html>
+<html>
+  <head>
+    <title>Tide Predictor in the browser</title>
+    <link rel="stylesheet" href="https://stackpath.bootstrapcdn.com/bootstrap/4.3.1/css/bootstrap.min.css"/>
+  </head>
+  <body>
+    <div class="container">
+      <h1>High/low tides for Monterey, CA</h1>
+      <table class="table">
+        <thead>
+          <tr>
+            <th>Time</th>
+            <th>High/Low</th>
+            <th>Level (meters)</th>
+          </tr>
+          <tbody id="tides">
+          </tbody>
+        </thead>
+      </table>
+    </div>
+    <script src="../../dist/tide-predictor.js"></script>
+    <script>
+      (()=> {
+        fetch(
+          'https://tidesandcurrents.noaa.gov/mdapi/v1.0/webapi/stations/9413450/harcon.json?units=metric'
+        )
+        .then(response => {
+          return response.json()
+        }).then(harmonics => {
+          const start = new Date()
+          const end = new Date(start.getTime() + (10 * 24 * 60 * 60 * 1000))
+          const highLow = tidePredictor(harmonics.HarmonicConstituents).getExtremesPrediction(start, end)
+          highLow.forEach(level => {
+            const tableRow = document.createElement('tr')
+            tableRow.innerHTML = `
+              <td>${level.time}</td>
+              <td>${level.label}</td>
+              <td>${level.level}</td>
+            `
+            document.getElementById('tides').appendChild(tableRow)
+          })
+        })
+      })()
+    </script>
+  </body>
+</html>

package/jest.config.js ADDED Viewed

@@ -0,0 +1,14 @@
+module.exports = {
+  verbose: false,
+  reporters: ['default', 'jest-junit'],
+  testPathIgnorePatterns: [
+    `<rootDir>/examples/`,
+    `<rootDir>/lib/`,
+    `<rootDir>/www/`,
+    `<rootDir>/dist/`,
+    `<rootDir>/node_modules/`
+  ],
+  transform: {
+    '^.+\\.jsx?$': 'babel-jest'
+  }
+}

package/lib/astronomy/coefficients.js ADDED Viewed

@@ -0,0 +1,31 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.sexagesimalToDecimal = exports["default"] = void 0;
+// Convert a sexagesimal angle into decimal degrees
+var sexagesimalToDecimal = function sexagesimalToDecimal(degrees, arcmins, arcsecs, mas, muas) {
+  arcmins = typeof arcmins !== 'undefined' ? arcmins : 0;
+  arcsecs = typeof arcsecs !== 'undefined' ? arcsecs : 0;
+  mas = typeof mas !== 'undefined' ? mas : 0;
+  muas = typeof muas !== 'undefined' ? muas : 0;
+  return degrees + arcmins / 60.0 + arcsecs / (60.0 * 60.0) + mas / (60.0 * 60.0 * 1e3) + muas / (60.0 * 60.0 * 1e6);
+};
+exports.sexagesimalToDecimal = sexagesimalToDecimal;
+var coefficients = {
+  // Meeus formula 21.3
+  terrestrialObliquity: [sexagesimalToDecimal(23, 26, 21.448), -sexagesimalToDecimal(0, 0, 4680.93), -sexagesimalToDecimal(0, 0, 1.55), sexagesimalToDecimal(0, 0, 1999.25), -sexagesimalToDecimal(0, 0, 51.38), -sexagesimalToDecimal(0, 0, 249.67), -sexagesimalToDecimal(0, 0, 39.05), sexagesimalToDecimal(0, 0, 7.12), sexagesimalToDecimal(0, 0, 27.87), sexagesimalToDecimal(0, 0, 5.79), sexagesimalToDecimal(0, 0, 2.45)].map(function (number, index) {
+    return number * Math.pow(1e-2, index);
+  }),
+  solarPerigee: [280.46645 - 357.5291, 36000.76932 - 35999.0503, 0.0003032 + 0.0001559, 0.00000048],
+  solarLongitude: [280.46645, 36000.76983, 0.0003032],
+  lunarInclination: [5.145],
+  lunarLongitude: [218.3164591, 481267.88134236, -0.0013268, 1 / 538841.0 - 1 / 65194000.0],
+  lunarNode: [125.044555, -1934.1361849, 0.0020762, 1 / 467410.0, -1 / 60616000.0],
+  lunarPerigee: [83.353243, 4069.0137111, -0.0103238, -1 / 80053.0, 1 / 18999000.0]
+};
+var _default = coefficients;
+exports["default"] = _default;

package/lib/astronomy/constants.js ADDED Viewed

@@ -0,0 +1,10 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.r2d = exports.d2r = void 0;
+var d2r = Math.PI / 180.0;
+exports.d2r = d2r;
+var r2d = 180.0 / Math.PI;
+exports.r2d = r2d;

package/lib/astronomy/index.js ADDED Viewed

@@ -0,0 +1,199 @@
+"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 ADDED Viewed

@@ -0,0 +1,67 @@
+"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 ADDED Viewed

@@ -0,0 +1,74 @@
+"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;