@zac-apps/helium 1.3.0-beta.2 → 1.3.0-beta.4

package/dist/index.js

@@ -28,11 +28,11 @@ import Checkbox from '@mui/material/Checkbox';
 import Button from '@mui/material/Button';
 import moment$1 from 'moment/moment.js';
 import Typography from '@mui/material/Typography';
-import { LineChart, Line, CartesianGrid, XAxis, Label, YAxis, ReferenceLine, ReferenceArea, Tooltip } from 'recharts';
-import Grid2 from '@mui/material/Grid2';
 import Paper from '@mui/material/Paper';
+import { LineChart, Line, CartesianGrid, XAxis, Label, YAxis, ReferenceLine, ReferenceArea, Tooltip } from 'recharts';
 import ButtonGroup from '@mui/material/ButtonGroup';
 import Switch from '@mui/material/Switch';
+import regression from 'regression';
 
 function NumField(_ref) {
   var input = _ref.input,
@@ -377,8 +377,8 @@ function SelectSpecs(_ref) {
   });
 }
 
-function ownKeys$3(e, r) { var t = Object.keys(e); if (Object.getOwnPropertySymbols) { var o = Object.getOwnPropertySymbols(e); r && (o = o.filter(function (r) { return Object.getOwnPropertyDescriptor(e, r).enumerable; })), t.push.apply(t, o); } return t; }
-function _objectSpread$3(e) { for (var r = 1; r < arguments.length; r++) { var t = null != arguments[r] ? arguments[r] : {}; r % 2 ? ownKeys$3(Object(t), true).forEach(function (r) { _defineProperty(e, r, t[r]); }) : Object.getOwnPropertyDescriptors ? Object.defineProperties(e, Object.getOwnPropertyDescriptors(t)) : ownKeys$3(Object(t)).forEach(function (r) { Object.defineProperty(e, r, Object.getOwnPropertyDescriptor(t, r)); }); } return e; }
+function ownKeys$5(e, r) { var t = Object.keys(e); if (Object.getOwnPropertySymbols) { var o = Object.getOwnPropertySymbols(e); r && (o = o.filter(function (r) { return Object.getOwnPropertyDescriptor(e, r).enumerable; })), t.push.apply(t, o); } return t; }
+function _objectSpread$5(e) { for (var r = 1; r < arguments.length; r++) { var t = null != arguments[r] ? arguments[r] : {}; r % 2 ? ownKeys$5(Object(t), true).forEach(function (r) { _defineProperty(e, r, t[r]); }) : Object.getOwnPropertyDescriptors ? Object.defineProperties(e, Object.getOwnPropertyDescriptors(t)) : ownKeys$5(Object(t)).forEach(function (r) { Object.defineProperty(e, r, Object.getOwnPropertyDescriptor(t, r)); }); } return e; }
 
 // Admonition colors
 
@@ -441,7 +441,7 @@ function HePrognosisSum(_ref2) {
   var boilOff = heliumLookupData.boilOff;
   var boilData = {};
   Object.keys(heliumData).map(function (spec) {
-    boilData = _objectSpread$3(_objectSpread$3({}, boilData), {}, _defineProperty({}, spec, Math.round(heliumData[spec] + days * boilOff[spec])));
+    boilData = _objectSpread$5(_objectSpread$5({}, boilData), {}, _defineProperty({}, spec, Math.round(heliumData[spec] + days * boilOff[spec])));
     return null;
   });
   var toMaxSum = Object.keys(boilData).reduce(function (total, current) {
@@ -610,7 +610,7 @@ function HePrognosis(_ref6) {
   var specDefault = {};
   var specList = Object.keys(heliumData.helium);
   specList.map(function (spec) {
-    return specDefault = _objectSpread$3(_objectSpread$3({}, specDefault), {}, _defineProperty({}, spec, true));
+    return specDefault = _objectSpread$5(_objectSpread$5({}, specDefault), {}, _defineProperty({}, spec, true));
   });
   var _useImmer = useImmer(specDefault),
     _useImmer2 = _slicedToArray(_useImmer, 2),
@@ -624,13 +624,13 @@ function HePrognosis(_ref6) {
   Object.keys(specs).filter(function (spec) {
     return specs[spec];
   }).map(function (spec) {
-    return currHeliumData = _objectSpread$3(_objectSpread$3({}, currHeliumData), {}, _defineProperty({}, spec, heliumData.helium[spec]));
+    return currHeliumData = _objectSpread$5(_objectSpread$5({}, currHeliumData), {}, _defineProperty({}, spec, heliumData.helium[spec]));
   });
   var dates = {};
   for (var i in increments) {
     var d = new Date();
     d.setDate(d.getDate() + increments[i]);
-    dates = _objectSpread$3(_objectSpread$3({}, dates), {}, _defineProperty({}, increments[i], moment(d).format("ll")));
+    dates = _objectSpread$5(_objectSpread$5({}, dates), {}, _defineProperty({}, increments[i], moment(d).format("ll")));
   }
   return /*#__PURE__*/jsxs(Grid, {
     container: true,
@@ -921,8 +921,8 @@ function FindTriple(_ref2) {
   return minTriple;
 }
 
-function ownKeys$2(e, r) { var t = Object.keys(e); if (Object.getOwnPropertySymbols) { var o = Object.getOwnPropertySymbols(e); r && (o = o.filter(function (r) { return Object.getOwnPropertyDescriptor(e, r).enumerable; })), t.push.apply(t, o); } return t; }
-function _objectSpread$2(e) { for (var r = 1; r < arguments.length; r++) { var t = null != arguments[r] ? arguments[r] : {}; r % 2 ? ownKeys$2(Object(t), true).forEach(function (r) { _defineProperty(e, r, t[r]); }) : Object.getOwnPropertyDescriptors ? Object.defineProperties(e, Object.getOwnPropertyDescriptors(t)) : ownKeys$2(Object(t)).forEach(function (r) { Object.defineProperty(e, r, Object.getOwnPropertyDescriptor(t, r)); }); } return e; }
+function ownKeys$4(e, r) { var t = Object.keys(e); if (Object.getOwnPropertySymbols) { var o = Object.getOwnPropertySymbols(e); r && (o = o.filter(function (r) { return Object.getOwnPropertyDescriptor(e, r).enumerable; })), t.push.apply(t, o); } return t; }
+function _objectSpread$4(e) { for (var r = 1; r < arguments.length; r++) { var t = null != arguments[r] ? arguments[r] : {}; r % 2 ? ownKeys$4(Object(t), true).forEach(function (r) { _defineProperty(e, r, t[r]); }) : Object.getOwnPropertyDescriptors ? Object.defineProperties(e, Object.getOwnPropertyDescriptors(t)) : ownKeys$4(Object(t)).forEach(function (r) { Object.defineProperty(e, r, Object.getOwnPropertyDescriptor(t, r)); }); } return e; }
 function TupleResult(_ref) {
   var children = _ref.children,
     title = _ref.title;
@@ -1007,7 +1007,7 @@ function PairWizard(_ref4) {
   var boilOff = heliumLookupData.boilOff;
   var defaultSpecs = {};
   Object.keys(boilOff).map(function (spec) {
-    return defaultSpecs = _objectSpread$2(_objectSpread$2({}, defaultSpecs), {}, _defineProperty({}, spec, true));
+    return defaultSpecs = _objectSpread$4(_objectSpread$4({}, defaultSpecs), {}, _defineProperty({}, spec, true));
   });
   var _useImmer = useImmer(defaultSpecs),
     _useImmer2 = _slicedToArray(_useImmer, 2),
@@ -1024,13 +1024,13 @@ function PairWizard(_ref4) {
     _useState4 = _slicedToArray(_useState3, 2),
     limit = _useState4[0],
     SetLimit = _useState4[1];
-  var minPair = FindPair(_objectSpread$2({}, {
+  var minPair = FindPair(_objectSpread$4({}, {
     currSpecs: currSpecs,
     heliumData: heliumData,
     boilOff: boilOff,
     limit: limit
   }));
-  var minTriple = FindTriple(_objectSpread$2({}, {
+  var minTriple = FindTriple(_objectSpread$4({}, {
     currSpecs: currSpecs,
     heliumData: heliumData,
     boilOff: boilOff,
@@ -1236,8 +1236,8 @@ function FillTarget(_ref) {
   });
 }
 
-function ownKeys$1(e, r) { var t = Object.keys(e); if (Object.getOwnPropertySymbols) { var o = Object.getOwnPropertySymbols(e); r && (o = o.filter(function (r) { return Object.getOwnPropertyDescriptor(e, r).enumerable; })), t.push.apply(t, o); } return t; }
-function _objectSpread$1(e) { for (var r = 1; r < arguments.length; r++) { var t = null != arguments[r] ? arguments[r] : {}; r % 2 ? ownKeys$1(Object(t), true).forEach(function (r) { _defineProperty(e, r, t[r]); }) : Object.getOwnPropertyDescriptors ? Object.defineProperties(e, Object.getOwnPropertyDescriptors(t)) : ownKeys$1(Object(t)).forEach(function (r) { Object.defineProperty(e, r, Object.getOwnPropertyDescriptor(t, r)); }); } return e; }
+function ownKeys$3(e, r) { var t = Object.keys(e); if (Object.getOwnPropertySymbols) { var o = Object.getOwnPropertySymbols(e); r && (o = o.filter(function (r) { return Object.getOwnPropertyDescriptor(e, r).enumerable; })), t.push.apply(t, o); } return t; }
+function _objectSpread$3(e) { for (var r = 1; r < arguments.length; r++) { var t = null != arguments[r] ? arguments[r] : {}; r % 2 ? ownKeys$3(Object(t), true).forEach(function (r) { _defineProperty(e, r, t[r]); }) : Object.getOwnPropertyDescriptors ? Object.defineProperties(e, Object.getOwnPropertyDescriptors(t)) : ownKeys$3(Object(t)).forEach(function (r) { Object.defineProperty(e, r, Object.getOwnPropertyDescriptor(t, r)); }); } return e; }
 function EstimateConsumption() {
   // Get data
 
@@ -1263,7 +1263,7 @@ function EstimateConsumption() {
   // Calculate consumption per day, month, year from values above
 
   specCons = specCons.map(function (spec) {
-    return _objectSpread$1(_objectSpread$1({}, spec), {}, {
+    return _objectSpread$3(_objectSpread$3({}, spec), {}, {
       perDay: spec.liters / spec.days,
       perMonth: (spec.liters / spec.days * 30).toFixed(1),
       perYear: (spec.liters / spec.days * 365).toFixed(1)
@@ -1331,6 +1331,130 @@ function EstimateConsumption() {
   });
 }
 
+function EstimateSlope(_ref) {
+  var data = _ref.data;
+  // define slope and intercept
+
+  var slope = 0;
+  var intercept = 0;
+
+  // find last time when spectrometer was filled - for this start from last point and go back until the first maximum is found
+
+  var firstMax = Number(data[data.length - 1].level);
+  var firstMaxIndex = data.length - 1;
+  for (var i = data.length - 2; i >= 0; i--) {
+    var level = Number(data[i].level);
+    if (level > firstMax) {
+      firstMax = level;
+      firstMaxIndex = i;
+    }
+
+    // stop if level decreases from maximum
+
+    if (level < firstMax) {
+      break;
+    }
+  }
+
+  // minimum level is the level at firstMaxIndex
+
+  var minLevelIndex = firstMaxIndex - 1;
+
+  // find previous time when spectrometer was filled - for this start from lastMinimumIndex and go back until a maximum is found or until level reaches 90%
+
+  var maxLevel = Number(data[minLevelIndex].level);
+  var maxLevelIndex = minLevelIndex;
+  for (var _i = minLevelIndex - 1; _i >= 0; _i--) {
+    var _level = Number(data[_i].level);
+    if (_level > maxLevel) {
+      maxLevel = _level;
+      maxLevelIndex = _i;
+    }
+
+    // stop if level is decreases from maximum or if level is above 90%
+
+    if (_level < maxLevel - 1 || _level >= 90) {
+      break;
+    }
+  }
+
+  // Create an array of points between maximum and minimum in the form [[x1, y1], [x2, y2], ...]
+
+  var points = [];
+  for (var _i2 = maxLevelIndex; _i2 <= minLevelIndex; _i2++) {
+    points.push([_i2, Number(data[_i2].level)]);
+  }
+
+  // Perform linear regression on the points
+
+  var result = regression.linear(points, {
+    precision: 3
+  });
+  slope = result.equation[0];
+  intercept = result.equation[1];
+  return {
+    slope: slope,
+    intercept: intercept
+  };
+}
+
+function ownKeys$2(e, r) { var t = Object.keys(e); if (Object.getOwnPropertySymbols) { var o = Object.getOwnPropertySymbols(e); r && (o = o.filter(function (r) { return Object.getOwnPropertyDescriptor(e, r).enumerable; })), t.push.apply(t, o); } return t; }
+function _objectSpread$2(e) { for (var r = 1; r < arguments.length; r++) { var t = null != arguments[r] ? arguments[r] : {}; r % 2 ? ownKeys$2(Object(t), true).forEach(function (r) { _defineProperty(e, r, t[r]); }) : Object.getOwnPropertyDescriptors ? Object.defineProperties(e, Object.getOwnPropertyDescriptors(t)) : ownKeys$2(Object(t)).forEach(function (r) { Object.defineProperty(e, r, Object.getOwnPropertyDescriptor(t, r)); }); } return e; }
+function ShowEstimate(_ref) {
+  var data = _ref.data,
+    spec = _ref.spec;
+  var heliumLookupData = useContext(LookupContext);
+
+  // Get estimated data
+
+  var estimateResult = EstimateSlope(_objectSpread$2({}, {
+    data: data,
+    spec: spec
+  }));
+  var estimatedBoiloff = estimateResult.slope.toFixed(3) || "N/A";
+
+  // Get stored data
+
+  var storedBoiloff = heliumLookupData.boilOff[spec].toFixed(3) || "N/A";
+
+  // Warn if values differ
+
+  var renderEstimatedBoiloff = Math.abs(estimatedBoiloff - storedBoiloff) < 0.1 ? estimatedBoiloff : /*#__PURE__*/jsx("strong", {
+    style: {
+      color: AppTheme.palette.primary.main
+    },
+    children: estimatedBoiloff
+  });
+  return /*#__PURE__*/jsxs("div", {
+    children: [/*#__PURE__*/jsx("h4", {
+      children: "Boiloff coefficients (%/day)"
+    }), /*#__PURE__*/jsx(Grid, {
+      container: true,
+      children: /*#__PURE__*/jsxs(AppTable, {
+        children: [/*#__PURE__*/jsx(TableHead, {
+          children: /*#__PURE__*/jsxs(TableRow, {
+            children: [/*#__PURE__*/jsx(TableHeadCell, {
+              children: "Estimated"
+            }), /*#__PURE__*/jsx(TableHeadCell, {
+              children: "Stored"
+            })]
+          })
+        }), /*#__PURE__*/jsx(TableBody, {
+          children: /*#__PURE__*/jsxs(TableRow, {
+            children: [/*#__PURE__*/jsx(TableCell, {
+              children: renderEstimatedBoiloff
+            }), /*#__PURE__*/jsx(TableCell, {
+              children: storedBoiloff
+            })]
+          })
+        })]
+      })
+    })]
+  });
+}
+
+function ownKeys$1(e, r) { var t = Object.keys(e); if (Object.getOwnPropertySymbols) { var o = Object.getOwnPropertySymbols(e); r && (o = o.filter(function (r) { return Object.getOwnPropertyDescriptor(e, r).enumerable; })), t.push.apply(t, o); } return t; }
+function _objectSpread$1(e) { for (var r = 1; r < arguments.length; r++) { var t = null != arguments[r] ? arguments[r] : {}; r % 2 ? ownKeys$1(Object(t), true).forEach(function (r) { _defineProperty(e, r, t[r]); }) : Object.getOwnPropertyDescriptors ? Object.defineProperties(e, Object.getOwnPropertyDescriptors(t)) : ownKeys$1(Object(t)).forEach(function (r) { Object.defineProperty(e, r, Object.getOwnPropertyDescriptor(t, r)); }); } return e; }
 function RenderGraph(_ref) {
   var data = _ref.data,
     height = _ref.height,
@@ -1340,6 +1464,15 @@ function RenderGraph(_ref) {
 
   var heliumLookupData = useContext(LookupContext);
 
+  // Get estimated data
+
+  var estimateResult = EstimateSlope(_objectSpread$1({}, {
+    data: data,
+    spec: spec
+  }));
+  var estimatedBoiloff = estimateResult.slope;
+  var estimatedIntercept = estimateResult.intercept;
+
   // Custom Tooltip for LineChart
 
   var CustomTooltip = function CustomTooltip(_ref2) {
@@ -1395,6 +1528,10 @@ function RenderGraph(_ref) {
     _useState4 = _slicedToArray(_useState3, 2),
     showMinima = _useState4[0],
     setShowMinima = _useState4[1];
+  var _useState5 = useState(false),
+    _useState6 = _slicedToArray(_useState5, 2),
+    showEstimate = _useState6[0],
+    setShowEstimate = _useState6[1];
 
   // Add days ago to data
 
@@ -1402,14 +1539,32 @@ function RenderGraph(_ref) {
     item.days = -moment(item.date, "ddd MMM D HH:mm:ss YYYY").diff(moment(), "days");
   });
 
+  // Get chart data from estimate
+
+  showEstimate && (data = data.map(function (item) {
+    var days = item.days;
+    var level = item.level;
+    var estimate = estimatedBoiloff * (data.length - days) + estimatedIntercept;
+    return {
+      date: item.date,
+      days: days,
+      level: level,
+      estimate: estimate
+    };
+  }));
+
   // Get last n elements of array
 
-  data = data.slice(Math.max(data.length - days, 0));
+  var slicedData = data.slice(Math.max(data.length - days, 0));
+
+  // Improve visibility of estimate
+
+  var lineColor = showEstimate ? AppTheme.palette.grey[300] : AppTheme.palette.primary.main;
   return /*#__PURE__*/jsxs(React.Fragment, {
     children: [/*#__PURE__*/jsxs(LineChart, {
       height: height,
       width: width,
-      data: data,
+      data: slicedData,
       margin: {
         top: 5,
         right: 20,
@@ -1418,13 +1573,20 @@ function RenderGraph(_ref) {
       },
       children: [/*#__PURE__*/jsx(Line, {
         dataKey: "level",
-        stroke: AppTheme.palette.primary.main,
-        fill: AppTheme.palette.primary.main,
+        stroke: lineColor,
+        fill: lineColor,
         type: "linear",
         dot: {
           r: 1.5
         }
-      }), /*#__PURE__*/jsx(CartesianGrid, {
+      }), showEstimate ? /*#__PURE__*/jsx(Line, {
+        dataKey: "estimate",
+        stroke: AppTheme.palette.action.main,
+        type: "monotone",
+        strokeDasharray: "5 5",
+        strokeWidth: 2,
+        dot: false
+      }) : null, /*#__PURE__*/jsx(CartesianGrid, {
         stroke: AppTheme.palette.divider,
         strokeDasharray: "5 5"
       }), /*#__PURE__*/jsx(XAxis, {
@@ -1478,8 +1640,8 @@ function RenderGraph(_ref) {
       }), /*#__PURE__*/jsx(DayButton, {
         value: 365
       })]
-    }), /*#__PURE__*/jsx(FormGroup, {
-      children: /*#__PURE__*/jsx(FormControlLabel, {
+    }), /*#__PURE__*/jsxs(FormGroup, {
+      children: [/*#__PURE__*/jsx(FormControlLabel, {
         control: /*#__PURE__*/jsx(Switch, {
           label: "Show Minimum",
           checked: showMinima,
@@ -1491,16 +1653,41 @@ function RenderGraph(_ref) {
         sx: {
           justifyContent: "center"
         }
-      })
+      }), /*#__PURE__*/jsx(FormControlLabel, {
+        control: /*#__PURE__*/jsx(Switch, {
+          label: "Show Estimate",
+          checked: showEstimate,
+          onChange: function onChange() {
+            return setShowEstimate(!showEstimate);
+          }
+        }),
+        label: "Show Estimate",
+        sx: {
+          justifyContent: "center"
+        }
+      })]
+    }), /*#__PURE__*/jsx(ShowEstimate, {
+      spec: spec,
+      data: data
     })]
   });
 }
-function HeliumGraph(_ref4) {
-  var graphData = _ref4.graphData,
-    graphDataMeta = _ref4.graphDataMeta,
-    matches = _ref4.matches;
+
+function HeliumGraph(_ref) {
+  var graphData = _ref.graphData,
+    graphDataMeta = _ref.graphDataMeta,
+    matches = _ref.matches;
   var height = matches ? 250 : 200;
   var width = matches ? 300 : 280;
+  var heliumLookupData = useContext(LookupContext);
+
+  // remove spectrometers not existing in heliumLookupData
+
+  Object.keys(graphData).forEach(function (spec) {
+    if (!heliumLookupData.boilOff[spec]) {
+      delete graphData[spec];
+    }
+  });
 
   // Catch missing data
 
@@ -1510,7 +1697,7 @@ function HeliumGraph(_ref4) {
         children: /*#__PURE__*/jsx("strong", {
           children: "Helium level monitoring"
         })
-      }), /*#__PURE__*/jsx(Grid2, {
+      }), /*#__PURE__*/jsx(Grid, {
         sx: {
           display: "flex",
           justifyContent: "center"
@@ -1531,7 +1718,7 @@ function HeliumGraph(_ref4) {
       }), " ", /*#__PURE__*/jsxs("em", {
         children: ["(updated ", moment(graphDataMeta.date).fromNow(), ")"]
       })]
-    }), /*#__PURE__*/jsx(Grid2, {
+    }), /*#__PURE__*/jsx(Grid, {
       container: true,
       sx: {
         display: "flex",

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@zac-apps/helium",
-    "version": "1.3.0-beta.2",
+    "version": "1.3.0-beta.4",
     "scripts": {
         "rollup": "node_modules/rollup/dist/rollup.js",
         "dev": "next dev",
@@ -30,9 +30,10 @@
     "dependencies": {
         "@mui/icons-material": "^5.17.1",
         "@mui/material": "^5.17.1",
-        "@zac-apps/commons": "^1.3",
+        "@zac-apps/commons": "^1",
         "moment": "^2.30.1",
         "recharts": "^2.15.1",
+        "regression": "^2.0.1",
         "use-immer": "^0.11.0"
     },
     "devDependencies": {
@@ -63,10 +64,10 @@
         "storybook": "^8.6.10"
     },
     "peerDependencies": {
+        "@zac-apps/commons": "^1",
         "next": "^14",
         "react": "^18 || ^19",
-        "react-dom": "^18 || ^19",
-        "@zac-apps/commons": "^1"
+        "react-dom": "^18 || ^19"
     },
     "description": "A React component to manage and visualize the helium consumption of a set of NMR spectrometers."
 }