@neaps/tide-predictor 0.0.5 → 0.1.1

package/.eslintrc.cjs

@@ -0,0 +1,18 @@
+module.exports = {
+  env: {
+    browser: true,
+    es2021: true,
+    node: true
+  },
+  extends: 'eslint:recommended',
+  parserOptions: {
+    ecmaVersion: 'latest',
+    sourceType: 'module'
+  },
+  rules: {
+    indent: ['error', 2],
+    'linebreak-style': ['error', 'unix'],
+    quotes: ['error', 'single'],
+    semi: ['error', 'never']
+  }
+}

package/.github/workflows/test.yml

@@ -9,7 +9,13 @@ jobs:
       - uses: actions/checkout@v2
 
       - name: Install modules
-        run: yarn
+        run: npm install
+
+      - name: Install codecov
+        run: npm install -g codecov
 
       - name: Test
-        run: yarn ci
+        run: npm run ci
+
+      - name: Test build
+        run: npm run build

package/.prettierrc

@@ -1,4 +1,5 @@
 {
   "semi": false,
-  "singleQuote": true
+  "singleQuote": true,
+  "trailingComma": "none"
 }

package/README.md

@@ -1,4 +1,4 @@
-![example workflow](https://github.com/neaps/tide-predictor/actions/workflows/test.yml/badge.svg) [![FOSSA Status](https://app.fossa.com/api/projects/git%2Bgithub.com%2Fneaps%2Ftide-predictor.svg?type=shield)](https://app.fossa.com/projects/git%2Bgithub.com%2Fneaps%2Ftide-predictor?ref=badge_shield)
+![example workflow](https://github.com/neaps/tide-predictor/actions/workflows/test.yml/badge.svg) [![FOSSA Status](https://app.fossa.com/api/projects/git%2Bgithub.com%2Fneaps%2Ftide-predictor.svg?type=shield)](https://app.fossa.com/projects/git%2Bgithub.com%2Fneaps%2Ftide-predictor?ref=badge_shield) [![codecov](https://codecov.io/gh/neaps/tide-predictor/branch/main/graph/badge.svg?token=KEJK5NQR5H)](https://codecov.io/gh/neaps/tide-predictor)
 
 # Tide predictor
 
@@ -17,13 +17,25 @@ The tide predictions do not factor events such as storm surge, wind waves, uplif
 # Installation
 
 ```
+#npm
+npm install @neaps/tide-prediction
+
 # yarn
-yarn install @neaps/tide-prediction
+yarn add @neaps/tide-prediction
 
-#npm
-npm install --save @neaps/tide-prediction
 ```
 
+## Importing
+
+You can import the module using Ecmascript, or CommonJS. Note that the CommonJS export is transpiled, so deep debugging the module that way will be difficult.
+
+```js
+import TidePrediction from '@neaps/tide-prediction'
+const TidePrediction = require('@neaps/tide-prediction')
+```
+
+There are also packaged and minified versions for the browser in `dist/web`.
+
 # Usage
 
 Neaps requires that you [provide your own tidal harmonics information](#constituent-object) to generate a prediction.
@@ -34,20 +46,24 @@ Note that, for now, Neaps **will not** do any timezone corrections. This means y
 
 ```javascript
 import TidePrediction from '@neaps/tide-prediction'
+
 const constituents = [
   {
     phase_GMT: 98.7,
     phase_local: 313.7,
     amplitude: 2.687,
     name: 'M2',
-    speed: 28.984104,
-  },
+    speed: 28.984104
+  }
   //....there are usually many, read the docs
 ]
 
 const highLowTides = tidePrediction(constituents, {
-  phaseKey: 'phase_GMT',
-}).getExtremesPrediction(new Date('2019-01-01'), new Date('2019-01-10'))
+  phaseKey: 'phase_GMT'
+}).getExtremesPrediction({
+  start: new Date('2019-01-01'),
+  end: new Date('2019-01-10')
+})
 ```
 
 ## Tide prediction object
@@ -76,8 +92,8 @@ const tides = tidePrediction(constituents).getExtremesPrediction({
   labels: {
     //optional human-readable labels
     high: 'High tide',
-    low: 'Low tide',
-  },
+    low: 'Low tide'
+  }
 })
 ```
 
@@ -90,13 +106,13 @@ const tides = tidePrediction(constituents).getExtremesPrediction({
   offset: {
     height_offset: {
       high: 1,
-      low: 2,
+      low: 2
     },
     time_offset: {
       high: 1,
-      low: 2,
-    },
-  },
+      low: 2
+    }
+  }
 })
 ```
 
@@ -128,7 +144,7 @@ Gives you the predicted water level at a specific time.
 
 ```javascript
 const waterLevel = tidePrediction(constituents).getWaterLevelAtTime({
-  time: new Date(),
+  time: new Date()
 })
 ```
 

package/{lib/index.es6.js → dist/commonjs/index.js}

@@ -1,3 +1,5 @@
+'use strict';
+
 const d2r = Math.PI / 180.0;
 const r2d = 180.0 / Math.PI;
 
@@ -30,7 +32,7 @@ const coefficients = {
     sexagesimalToDecimal(0, 0, 7.12),
     sexagesimalToDecimal(0, 0, 27.87),
     sexagesimalToDecimal(0, 0, 5.79),
-    sexagesimalToDecimal(0, 0, 2.45)
+    sexagesimalToDecimal(0, 0, 2.45),
   ].map((number, index) => {
     return number * Math.pow(1e-2, index)
   }),
@@ -39,7 +41,7 @@ const coefficients = {
     280.46645 - 357.5291,
     36000.76932 - 35999.0503,
     0.0003032 + 0.0001559,
-    0.00000048
+    0.00000048,
   ],
 
   solarLongitude: [280.46645, 36000.76983, 0.0003032],
@@ -50,7 +52,7 @@ const coefficients = {
     218.3164591,
     481267.88134236,
     -0.0013268,
-    1 / 538841.0 - 1 / 65194000.0
+    1 / 538841.0 - 1 / 65194000.0,
   ],
 
   lunarNode: [
@@ -58,7 +60,7 @@ const coefficients = {
     -1934.1361849,
     0.0020762,
     1 / 467410.0,
-    -1 / 60616000.0
+    -1 / 60616000.0,
   ],
 
   lunarPerigee: [
@@ -66,8 +68,8 @@ const coefficients = {
     4069.0137111,
     -0.0103238,
     -1 / 80053.0,
-    1 / 18999000.0
-  ]
+    1 / 18999000.0,
+  ],
 };
 
 // Evaluates a polynomial at argument
@@ -93,12 +95,12 @@ const derivativePolynomial = (coefficients, argument) => {
 };
 
 // Meeus formula 11.1
-const T = t => {
+const T = (t) => {
   return (JD(t) - 2451545.0) / 36525
 };
 
 // Meeus formula 7.1
-const JD = t => {
+const JD = (t) => {
   let Y = t.getFullYear();
   let M = t.getMonth() + 1;
   const D =
@@ -194,11 +196,11 @@ const _nupp = (N, i, omega) => {
   return r2d * 0.5 * Math.atan(tan2nupp)
 };
 
-const modulus = (a, b) => {
+const modulus$1 = (a, b) => {
   return ((a % b) + b) % b
 };
 
-const astro = time => {
+const astro = (time) => {
   const result = {};
   const polynomials = {
     s: coefficients.lunarLongitude,
@@ -214,9 +216,9 @@ const astro = time => {
   // Polynomials are in T, that is Julian Centuries; we want our speeds to be
   // in the more convenient unit of degrees per hour.
   const dTdHour = 1 / (24 * 365.25 * 100);
-  Object.keys(polynomials).forEach(name => {
+  Object.keys(polynomials).forEach((name) => {
     result[name] = {
-      value: modulus(polynomial(polynomials[name], T(time)), 360.0),
+      value: modulus$1(polynomial(polynomials[name], T(time)), 360.0),
       speed: derivativePolynomial(polynomials[name], T(time)) * dTdHour
     };
   });
@@ -231,10 +233,10 @@ const astro = time => {
     nup: _nup,
     nupp: _nupp
   };
-  Object.keys(functions).forEach(name => {
+  Object.keys(functions).forEach((name) => {
     const functionCall = functions[name];
     result[name] = {
-      value: modulus(
+      value: modulus$1(
         functionCall(result.N.value, result.i.value, result.omega.value),
         360.0
       ),
@@ -266,7 +268,7 @@ const astro = time => {
   return result
 };
 
-const modulus$1 = (a, b) => {
+const modulus = (a, b) => {
   return ((a % b) + b) % b
 };
 
@@ -312,7 +314,7 @@ const predictionFactory = ({ timeline, constituents, start }) => {
     const amplitudes = [];
     let result = 0;
 
-    constituents.forEach(constituent => {
+    constituents.forEach((constituent) => {
       const amplitude = constituent.amplitude;
       const phase = constituent._phase;
       const f = modelF[constituent.name];
@@ -322,7 +324,7 @@ const predictionFactory = ({ timeline, constituents, start }) => {
       amplitudes.push(amplitude * f * Math.cos(speed * hour + (V0 + u) - phase));
     });
     // sum up each row
-    amplitudes.forEach(item => {
+    amplitudes.forEach((item) => {
       result += item;
     });
     return result
@@ -330,7 +332,7 @@ const predictionFactory = ({ timeline, constituents, start }) => {
 
   const prediction = {};
 
-  prediction.getExtremesPrediction = options => {
+  prediction.getExtremesPrediction = (options) => {
     const { labels, offsets } = typeof options !== 'undefined' ? options : {};
     const results = [];
     const { baseSpeed, u, f, baseValue } = prepare();
@@ -389,8 +391,8 @@ const predictionFactory = ({ timeline, constituents, start }) => {
     timeline.items.forEach((time, index) => {
       const hour = timeline.hours[index];
       const prediction = {
-        time: time,
-        hour: hour,
+        time,
+        hour,
         level: getLevel(hour, baseSpeed, u[index], f[index], baseValue)
       };
 
@@ -406,31 +408,31 @@ const predictionFactory = ({ timeline, constituents, start }) => {
     const baseSpeed = {};
     const u = [];
     const f = [];
-    constituents.forEach(constituent => {
+    constituents.forEach((constituent) => {
       const value = constituent._model.value(baseAstro);
       const speed = constituent._model.speed(baseAstro);
       baseValue[constituent.name] = d2r * value;
       baseSpeed[constituent.name] = d2r * speed;
     });
-    timeline.items.forEach(time => {
+    timeline.items.forEach((time) => {
       const uItem = {};
       const fItem = {};
       const itemAstro = astro(time);
-      constituents.forEach(constituent => {
-        const constituentU = modulus$1(constituent._model.u(itemAstro), 360);
+      constituents.forEach((constituent) => {
+        const constituentU = modulus(constituent._model.u(itemAstro), 360);
 
         uItem[constituent.name] = d2r * constituentU;
-        fItem[constituent.name] = modulus$1(constituent._model.f(itemAstro), 360);
+        fItem[constituent.name] = modulus(constituent._model.f(itemAstro), 360);
       });
       u.push(uItem);
       f.push(fItem);
     });
 
     return {
-      baseValue: baseValue,
-      baseSpeed: baseSpeed,
-      u: u,
-      f: f
+      baseValue,
+      baseSpeed,
+      u,
+      f
     }
   };
 
@@ -582,7 +584,7 @@ const corrections = {
 
   // Node factors u, see Table 2 of Schureman.
 
-  uZero(a) {
+  uZero() {
     return 0.0
   },
 
@@ -657,7 +659,7 @@ const dotArray = (a, b) => {
   })
 };
 
-const astronimicDoodsonNumber = astro => {
+const astronimicDoodsonNumber = (astro) => {
   return [
     astro['T+h-s'],
     astro.s,
@@ -669,17 +671,17 @@ const astronimicDoodsonNumber = astro => {
   ]
 };
 
-const astronomicSpeed = astro => {
+const astronomicSpeed = (astro) => {
   const results = [];
-  astronimicDoodsonNumber(astro).forEach(number => {
+  astronimicDoodsonNumber(astro).forEach((number) => {
     results.push(number.speed);
   });
   return results
 };
 
-const astronomicValues = astro => {
+const astronomicValues = (astro) => {
   const results = [];
-  astronimicDoodsonNumber(astro).forEach(number => {
+  astronimicDoodsonNumber(astro).forEach((number) => {
     results.push(number.value);
   });
   return results
@@ -691,11 +693,10 @@ const constituentFactory = (name, coefficients, u, f) => {
   }
 
   const constituent = {
-    name: name,
+    name,
+    coefficients,
 
-    coefficients: coefficients,
-
-    value: astro => {
+    value: (astro) => {
       return dotArray(coefficients, astronomicValues(astro))
     },
 
@@ -723,11 +724,10 @@ const compoundConstituentFactory = (name, members) => {
   });
 
   const compoundConstituent = {
-    name: name,
-
-    coefficients: coefficients,
+    name,
+    coefficients,
 
-    speed: astro => {
+    speed: (astro) => {
       let speed = 0;
       members.forEach(({ constituent, factor }) => {
         speed += constituent.speed(astro) * factor;
@@ -735,7 +735,7 @@ const compoundConstituentFactory = (name, members) => {
       return speed
     },
 
-    value: astro => {
+    value: (astro) => {
       let value = 0;
       members.forEach(({ constituent, factor }) => {
         value += constituent.value(astro) * factor;
@@ -743,7 +743,7 @@ const compoundConstituentFactory = (name, members) => {
       return value
     },
 
-    u: astro => {
+    u: (astro) => {
       let u = 0;
       members.forEach(({ constituent, factor }) => {
         u += constituent.u(astro) * factor;
@@ -751,7 +751,7 @@ const compoundConstituentFactory = (name, members) => {
       return u
     },
 
-    f: astro => {
+    f: (astro) => {
       const f = [];
       members.forEach(({ constituent, factor }) => {
         f.push(Math.pow(constituent.f(astro), Math.abs(factor)));
@@ -806,10 +806,10 @@ constituents.K2 = constituentFactory('K2', [2, 2, 0, 0, 0, 0, 0], corrections.uK
 constituents.M3 = constituentFactory(
   'M3',
   [3, 0, 0, 0, 0, 0, 0],
-  a => {
+  (a) => {
     return corrections.uModd(a, 3)
   },
-  a => {
+  (a) => {
     return corrections.fModd(a, 3)
   }
 );
@@ -879,7 +879,7 @@ constituents.M8 = compoundConstituentFactory('M8', [
   { constituent: constituents.M2, factor: 4 }
 ]);
 
-const getDate = time => {
+const getDate = (time) => {
   if (time instanceof Date) {
     return time
   }
@@ -891,20 +891,20 @@ const getDate = time => {
 
 const getTimeline = (start, end, seconds) => {
   seconds = typeof seconds !== 'undefined' ? seconds : 10 * 60;
-  const timeline = [];
+  const items = [];
   const endTime = end.getTime() / 1000;
   let lastTime = start.getTime() / 1000;
   const startTime = lastTime;
   const hours = [];
   while (lastTime <= endTime) {
-    timeline.push(new Date(lastTime * 1000));
+    items.push(new Date(lastTime * 1000));
     hours.push((lastTime - startTime) / (60 * 60));
     lastTime += seconds;
   }
 
   return {
-    items: timeline,
-    hours: hours
+    items,
+    hours
   }
 };
 
@@ -913,7 +913,7 @@ const harmonicsFactory = ({ harmonicConstituents, phaseKey, offset }) => {
     throw new Error('Harmonic constituents are not an array')
   }
   const constituents$1 = [];
-  harmonicConstituents.forEach((constituent, index) => {
+  harmonicConstituents.forEach((constituent) => {
     if (typeof constituent.name === 'undefined') {
       throw new Error('Harmonic constituents must have a name property')
     }
@@ -947,13 +947,13 @@ const harmonicsFactory = ({ harmonicConstituents, phaseKey, offset }) => {
     return harmonics
   };
 
-  harmonics.prediction = options => {
+  harmonics.prediction = (options) => {
     options =
       typeof options !== 'undefined' ? options : { timeFidelity: 10 * 60 };
     return predictionFactory({
       timeline: getTimeline(start, end, options.timeFidelity),
       constituents: constituents$1,
-      start: start
+      start
     })
   };
 
@@ -968,7 +968,7 @@ const tidePredictionFactory = (constituents, options) => {
   };
 
   if (typeof options !== 'undefined') {
-    Object.keys(harmonicsOptions).forEach(key => {
+    Object.keys(harmonicsOptions).forEach((key) => {
       if (typeof options[key] !== 'undefined') {
         harmonicsOptions[key] = options[key];
       }
@@ -986,7 +986,7 @@ const tidePredictionFactory = (constituents, options) => {
     getExtremesPrediction: ({ start, end, labels, offsets, timeFidelity }) => {
       return harmonicsFactory(harmonicsOptions)
         .setTimeSpan(start, end)
-        .prediction({ timeFidelity: timeFidelity })
+        .prediction({ timeFidelity })
         .getExtremesPrediction(labels, offsets)
     },
 
@@ -1002,4 +1002,4 @@ const tidePredictionFactory = (constituents, options) => {
   return tidePrediction
 };
 
-export default tidePredictionFactory;
+module.exports = tidePredictionFactory;

package/dist/commonjs/package.json

@@ -0,0 +1 @@
+{"type":"commonjs"}