linny-r 1.9.3 → 2.0.1

package/LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2022 Delft University of Technology
+Copyright (c) 2024 Delft University of Technology
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

package/README.md

@@ -30,7 +30,7 @@ Technical documentation will be developed on GitHub: https://github.com/pwgbots/
 Linny-R is developed as a JavaScript package, and requires that **Node.js** is installed on your computer. 
 This software can be downloaded from <a href="https://nodejs.org" target="_blank">https://nodejs.org</a>. 
 Make sure that you choose the correct installer for your computer.
-Linny-R is developed using the _current_ release. Presently (November 2023) this is 21.2.0. 
+Linny-R is developed using the _current_ release. Presently (April 2024) this is 21.7.3. 
 
 Run the installer and accept the default settings.
 There is **no** need to install the optional _Tools for Native Modules_.
@@ -41,7 +41,7 @@ Verify the installation by typing:
 
 ``node --version``
 
-The response should be the version number of Node.js, for example: v21.2.0.
+The response should be the version number of Node.js, for example: v21.7.3.
 
 ## Installing Linny-R
 It is advisable to install Linny-R in a directory on your computer, not in a cloud. 
@@ -245,8 +245,8 @@ Open the Command Line Interface (CLI) of your computer, change to your Linny-R d
 This response should be something similar to:
 
 <pre>
-Node.js server for Linny-R version 1.7.4
-Node.js version: v21.2.0
+Node.js server for Linny-R version 1.9.3
+Node.js version: v21.7.3
 ... etc.
 </pre>
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "linny-r",
-  "version": "1.9.3",
+  "version": "2.0.1",
   "description": "Executable graphical language with WYSIWYG editor for MILP models",
   "main": "server.js",
   "scripts": {

package/server.js

@@ -12,7 +12,7 @@ that pass the MILP equation model to the solver, and then return the solution
 to the Linny-R "virtual machine" that is running in the browser.
 */
 /*
-Copyright (c) 2020-2022 Delft University of Technology
+Copyright (c) 2020-2024 Delft University of Technology
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

package/static/index.html

@@ -28,7 +28,7 @@ implementation is made available via the Linny-R web site.
 -->
 
 <!--
-Copyright (c) 2017-2023 Delft University of Technology
+Copyright (c) 2017-2024 Delft University of Technology
 
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the
@@ -49,8 +49,15 @@ CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
 TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
 SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
 -->
-
   <link rel="shortcut icon" type="image/png" href="images/icon.png">
+  <link rel="stylesheet"
+        href="https://cdn.jsdelivr.net/npm/katex@0.16.9/dist/katex.min.css"
+        integrity="sha384-n8MVd4RsNIU0tAv4ct0nTaAbDJwPJzDEaqSD1odI+WdtXRGWt2kTvGFasHpSy3SV"
+        crossorigin="anonymous">
+  <!-- The loading of KaTeX is deferred to speed up page rendering -->
+  <script src="https://cdn.jsdelivr.net/npm/katex@0.16.9/dist/katex.min.js"
+          integrity="sha384-XjKyOOlGwcjNTAIQHIpgOno0Hl1YQqzUOEleOLALmuqehneUG+vnGctmUb0ZY0l8"
+          crossorigin="anonymous"></script>
   <!-- NOTE: do not display the page until after software update check -->
   <style>body { display: none; }</style>
   <script>
@@ -83,6 +90,7 @@ SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
       SENSITIVITY_ANALYSIS = null,
       CONSTRAINT_EDITOR = null,
       DOCUMENTATION_MANAGER = null,
+      TEX_MANAGER = null,
       RECEIVER = null,
       REPOSITORY_BROWSER = null,
       // Stack for undo/redo operations
@@ -125,11 +133,13 @@ SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
             '-gui-paper', '-gui-controller', '-gui-monitor',
             '-gui-file-manager', '-gui-expression-editor',
             '-gui-model-autosaver', '-gui-scale-unit-manager',
+            '-gui-power-grid-manager',
             '-gui-actor-manager', '-gui-constraint-editor',
             '-gui-repository-browser', '-gui-dataset-manager',
             '-gui-equation-manager', '-gui-chart-manager',
             '-gui-sensitivity-analysis', '-gui-experiment-manager',
-            '-gui-documentation-manager', '-gui-finder', '-gui-receiver',
+            '-gui-documentation-manager', '-gui-tex-manager',
+            '-gui-finder', '-gui-receiver',
             '-gui-undo-redo', '-vm', '-utils'], t);
       }
     }
@@ -209,6 +219,7 @@ SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
       X_EDIT = new ExpressionEditor();
       ACTOR_MANAGER = new ActorManager();
       SCALE_UNIT_MANAGER = new ScaleUnitManager();
+      POWER_GRID_MANAGER = new PowerGridManager();
       EQUATION_MANAGER = new EquationManager();
       FINDER = new Finder();
       CONSTRAINT_EDITOR = new ConstraintEditor();  
@@ -221,6 +232,7 @@ SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
       EXPERIMENT_MANAGER = new GUIExperimentManager();
       MONITOR = new GUIMonitor();
       RECEIVER = new GUIReceiver();
+      TEX_MANAGER = new TEXManager();
       // Check for software updates only when running on local server
       // NOTE: do this *after* GUI elements have been created, as the
       // updater uses a dialog
@@ -280,6 +292,8 @@ SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
            title="Listen for commands from local host (Ctrl-H)">
       <img id="documentation-btn" class="btn enab" src="images/info.png"
            title="View information and documentation (Ctrl-I)">
+      <img id="tex-btn" class="btn enab" src="images/tex.png"
+           title="View mathematical formula for node under cursor">
     </div>
     <!-- if diagram is not the TOP cluster, show a button to move up to the parent cluster -->
     <div id="focal-cluster">
@@ -637,6 +651,16 @@ and move the cursor over the status bar">
           <td style="padding-bottom:4px">Diagnose infeasible/unbounded problems</td>
           </td>
         </tr>
+        <tr>
+          <td style="padding:0px">
+            <div id="settings-power" class="box clear"></div>
+          </td>
+          <td>
+            <span style="padding-bottom:4px">Support power grid options</span>
+            <img id="settings-power-btn" class="sbtn" src="images/power.png"
+                 title="View/edit power grid settings">
+          </td>
+        </tr>
         <tr>
           <td style="padding:0px">
             <div id="settings-cost-prices" class="box clear"></div>
@@ -720,6 +744,91 @@ NOTE: Unit symbols are case-sensitive, so BTU &ne; Btu">
     </div>
   </div>
 
+  <!-- the POWER GRIDS dialog allows viewing/editing power grids -->
+  <div id="power-grids-modal" class="modal">
+    <div id="power-grids-dlg" class="inp-dlg">
+      <div class="dlg-title">
+        Power grids
+        <img class="close-btn" src="images/close.png">
+      </div>
+      <div id="power-grids-buttons">
+        <img id="power-grids-new-btn" class="btn enab" src="images/new.png"
+             title="New power grid">
+        <img id="power-grids-edit-btn" class="btn disab" src="images/edit.png"
+             title="Edit selected power grid">
+        <img id="power-grids-delete-btn" class="btn disab" src="images/delete.png"
+             title="Delete selected power grid">
+      </div>
+      <div id="power-grids-scroll-area">
+        <table id="power-grids-table">
+        </table>
+      </div>
+    </div>
+  </div>
+
+  <!-- the ADD POWER GRID dialog prompts for a new power grid -->
+  <div id="new-power-grid-modal" class="modal">
+    <div id="new-power-grid-dlg" class="inp-dlg">
+      <div class="dlg-title">
+        <span id="new-power-grid-action" >Define new</span> power grid
+        <img class="cancel-btn" src="images/cancel.png"">
+        <img class="ok-btn" src="images/ok.png">
+      </div>
+      <table style="margin: auto">
+        <tr>
+          <td colspan="2">Name:</td>
+          <td>
+            <input id="new-power-grid-name" type="text" autocomplete="off">
+          </td>
+        </tr>
+        <tr>
+          <td colspan="2">
+            Voltage:
+          </td>
+          <td>
+            <input id="new-power-grid-voltage" type="text" autocomplete="off">
+            kV
+            <span style="margin-left: 40px">Color:</span>
+            <input id="new-power-grid-color" type="color">
+          </td>
+        </tr>
+        <tr title="Unit of the level of power grid processes.
+NOTE: Products directly linked to such processes should have a proportional unit.">
+          <td colspan="3">
+            Power unit:
+            <select id="new-power-grid-unit">
+              <option value="W">watt (W)</option>
+              <option value="kW">kilowatt (kW)</option>
+              <option value="MW">megawatt (MW)</option>
+              <option value="GW">gigawatt (GW)</option>
+            </select>
+          </td>
+        </tr>
+        <tr title="When checked, Kirchhoff's voltage law will be observed">
+          <td style="padding: 0px; margin-bottom: 1px; width: 20px">
+            <div id="grid-kirchhoff" class="box clear"></div>
+          </td>
+          <td colspan="2" style="padding-bottom:4px">
+            Add power flow constraints
+          </td>
+        </tr>
+        <tr title="Power loss is computed by approximating rP&sup2;">
+          <td colspan="2">
+            Losses:
+          </td>
+          <td>
+            <select id="new-power-grid-losses">
+              <option value="0">Disregard</option>
+              <option value="1">Proportional with load</option>
+              <option value="2">Piecewise linear (2 slopes)</option>
+              <option value="3">Piecewise linear (3 slopes)</option>
+            </select>
+          </td>
+        </tr>
+      </table>
+    </div>
+  </div>
+
   <!-- the SOLVER dialog permits specifying solver preference and tolerances -->
   <div id="solver-modal" class="modal">
     <div id="solver-dlg" class="inp-dlg">
@@ -1320,7 +1429,7 @@ NOTE: Unit symbols are case-sensitive, so BTU &ne; Btu">
    -->
   <div id="constraint-modal" class="modal">
     <div id="constraint-dlg" class="inp-dlg">
-      <div class="dlg-title">Constraint X &DDotrahd; Y
+      <div class="dlg-title">Constraint X <span style="font-weight: normal">&#x219D;</span> Y
         <span id="constraint-group"></span>
         <div style="display: inline-block; margin-left: 219px; margin-bottom: -7px">
           <img class="cancel-btn" src="images/cancel.png">
@@ -1334,7 +1443,9 @@ NOTE: Unit symbols are case-sensitive, so BTU &ne; Btu">
         <img id="del-point-btn" class="mbtn disab"
              title="Remove selected point from bound line" src="images/remove.png">
         <img id="add-bl-btn" class="mbtn enab" title="Add new bound line"
-             style="margin-left: 10px" src="images/pwlf.png">
+             style="margin-left: 15px" src="images/pwlf.png">
+        <img id="bl-data-btn" class="mbtn enab" title="Add/modify bound line data"
+             src="images/dataset.png">
         <!-- NOTE: values correspond to constants used by Virtual Machine -->
         <select id="bl-type" title="Bound type">
           <option value="1">&le;</option>
@@ -1343,9 +1454,6 @@ NOTE: Unit symbols are case-sensitive, so BTU &ne; Btu">
         </select>
         <img id="del-bl-btn" class="mbtn disab" src="images/delete.png"
              title="Delete selected bound line">
-        <label>Selectors:</label>
-        <input id="bl-selectors" type="text" placeholder="(any)"
-               title="When specified, bound line will constrain only in matching experiment runs">
       </div>
       <div id="constraint-y-label">% range of <span id="constraint-to-name"></span></div>
       <!-- NOTE: this is the div that will contain the chart's SVG image -->
@@ -1374,6 +1482,63 @@ NOTE: Unit symbols are case-sensitive, so BTU &ne; Btu">
     </div>
   </div>
 
+  <!-- BOUNDLINE DATA modal -->
+  <div id="boundline-data-modal" class="modal">
+    <div id="boundline-data-dlg" class="inp-dlg">
+      <div class="dlg-title">
+        Boundline data
+        <img class="close-btn" src="images/close.png">
+      </div>
+      <div id="boundline-data-remote">
+        <img id="boundline-data-clip" src="images/paperclip.png">
+        <input id="boundline-data-url" type="text"
+               placeholder="URL or path on local host"
+               title="Path can be absolute, or relative to (Linny-R)/user/data.
+Parameters %i, %j and %k will be replaced by the corresponding iterator values.">
+      </div>
+      <div id="boundline-data-series-lbl">Point data</div>
+      <img class="btn enab" id="boundline-data-edit-btn"
+           src="images/edit.png" title="Edit point data">
+      <img class="ok-btn off" id="boundline-data-save-btn"
+           src="images/ok.png" title="Save changes">
+      <img class="cancel-btn off" id="boundline-data-cancel-btn"
+           src="images/cancel.png" title="Discard changes">
+      <div id="boundline-data-series-area">
+        <table id="boundline-data-series-table">
+        </table>
+      </div>
+      <textarea id="boundline-data-series" hidden="hidden" autocomplete="off"
+                autocorrect="off" autocapitalize="off" spellcheck="false"
+                title="Point coordinates must be semicolon-separated values between 0 and 1.
+Each line should represent the points of a different bound line.">
+      </textarea>
+      <div id="boundline-data-line">
+        <span id="boundline-data-line-number"></span>
+        (<span id="boundline-data-line-count">no data</span>)
+      </div>
+      <div id="boundline-data-sel-titles" style="display: block;">
+        <span>Selector</span>
+        <span style="margin-left: 38px">Line index expression or
+        <span class="blpoints">points expression</span></span>
+      </div>
+      <div id="boundline-data-sel-area">
+        <table id="boundline-data-sel-table">
+        </table>
+      </div>
+      <div id="boundline-data-sel-buttons">
+        <img id="bl-add-sel-btn" class="btn enab"
+             src="images/add-selector.png" title="Add new selector">
+        <img id="bl-rename-sel-btn" class="btn disab"
+             src="images/rename.png" title="Rename selected selector">
+        <img id="bl-edit-sel-btn" class="btn disab"
+             src="images/edit.png" title="Edit expression of selected selector">
+        <img id="bl-delete-sel-btn" class="btn disab"
+             src="images/delete.png" title="Delete selected selector"
+             style="margin-left: 20px">
+      </div>
+    </div>
+  </div>
+
   <!-- BOUNDLINE POINT modal -->
   <div id="boundline-point-modal" class="modal">
     <div id="boundline-point-dlg" class="inp-dlg">
@@ -1439,6 +1604,27 @@ NOTE: Unit symbols are case-sensitive, so BTU &ne; Btu">
         <div id="process-collapsed" class="box clear"></div>
         <div id="process-collapsed-lbl">Display as small rectangle</div>
       </div>
+      <div id="process-grid-plate" class="no-grid-plate"></div>
+      <div id="process-grid-plate-menu"></div>
+      <div id="process-grid-overlay" hidden="hidden">
+        <img id="process-negated" src="images/eq-negated.png">
+        <div id="process-negated-msg">
+          will be set to minus upper bound
+        </div>
+        <div id="process-grid-msg">
+          When marked as grid element, lower bound, initial level,
+          integer constraint, shut-down and level change frequency data
+          are preserved but ignored.
+        </div>
+        <div id="process-length-div">
+          Length of line or cable:
+          <input id="process-length" type="text" autocomplete="off">
+          km
+        </div>
+      </div>
+      <input id="process-tex-id" type="text"
+             title="TEX code to identify this process in formulas"
+             autocomplete="off" hidden="hidden">
     </div>
   </div>
 
@@ -1509,6 +1695,9 @@ NOTE: Unit symbols are case-sensitive, so BTU &ne; Btu">
         <div id="product-no-links" class="box clear"></div>
         <div id="product-no-links-lbl">Hide related links</div>
       </div>
+      <input id="product-tex-id" type="text"
+             title="TEX code to identify this product in formulas"
+             autocomplete="off" hidden="hidden">
       <div id="product-io" title="Click to set/unset as model parameter">
         &#10063;
         <div id="product-import">&darr;</div>
@@ -1745,7 +1934,7 @@ Start with = to find exact match, with ~ to match first characters">
   <div id="new-selector-modal" class="modal">
     <div id="new-selector-dlg" class="inp-dlg">
       <div class="dlg-title">
-        New dataset modifier
+        New <span id="new-selector-type">dataset modifier</span>
         <img class="cancel-btn" src="images/cancel.png">
         <img class="ok-btn" src="images/ok.png">
       </div>
@@ -1761,7 +1950,7 @@ NOTE: * and ? will be interpreted as wildcards"
   <div id="rename-selector-modal" class="modal">
     <div id="rename-selector-dlg" class="inp-dlg">
       <div class="dlg-title">
-        Rename dataset modifier
+        Rename <span id="rename-selector-type">dataset modifier</span>
         <img class="cancel-btn" src="images/cancel.png">
         <img class="ok-btn" src="images/ok.png">
       </div>
@@ -2886,6 +3075,32 @@ where X can be one or several of these letters: ABCDELPQ">
     <div id="monitor-resize" class="resizer"></div>
   </div>
   
+  <!-- the TEX dialog shows mathematical equations for nodes -->
+  <div id="tex-dlg" class="inp-dlg">
+    <div id="tex-hdr" class="dragger dlg-title">Mathematical formulas
+      <img id="tex-close-btn" class="close-btn" src="images/close.png">
+    </div>
+    <div id="tex-entity"></div>
+    <div id="tex-tabs" class="tabs">
+      <div id="tex-formula-tab" class="tab sel-tab"
+           title="Mathematical formula">
+        Formula
+      </div>
+      <div id="tex-code-tab" class="tab"
+           title="Formula in TEX syntax">
+        TEX code
+      </div>
+      <span style="margin-left: 20px; font-style: italic; color: purple">
+        Work in progress!
+      </span>
+    </div>
+    <div id="tex-formula"></div>
+    <textarea id="tex-code" autocomplete="off" autocorrect="off"
+        autocapitalize="off" spellcheck="false" hidden="hidden"
+        readonly="true"></textarea>
+    <div id="tex-resize" class="resizer"></div>
+  </div>
+  
   <!-- the CHANNEL dialog prompts for two paths: channel and call-back -->
   <div id="channel-modal" class="modal">
     <div id="channel-dlg" class="inp-dlg">