linny-r 1.1.23 → 1.2.0

package/README.md

@@ -25,7 +25,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 (February 2023) this is 19.6.0. 
+Linny-R is developed using the _current_ release. Presently (April 2023) this is 20.0.0. 
 
 Run the installer and accept the default settings.
 There is **no** need to install the optional _Tools for Native Modules_.
@@ -36,7 +36,7 @@ Verify the installation by typing:
 
 ``node --version``
 
-The response should be the version number of Node.js, for example: v19.6.0.
+The response should be the version number of Node.js, for example: v20.0.0.
 
 ## Installing Linny-R
 It is advisable to install Linny-R in a directory on your computer, not in a cloud. 
@@ -116,6 +116,7 @@ Academic licenses can be obtained by students and staff of eligible institutions
 
 #### Installing Gurobi
 
+The software you need to install is '''Gurobi Optimizer'''.
 More information on how to obtain a license, and instructions for installing
 Gurobi on your computer can be obtained via this URL:
 https://www.gurobi.com/academia/academic-program-and-licenses/
@@ -170,7 +171,7 @@ This response should be something similar to:
 
 <pre>
 Node.js server for Linny-R version 1.1.21
-Node.js version: v19.6.0
+Node.js version: v20.0.0
 ... etc.
 </pre>
 
@@ -180,9 +181,9 @@ The Linny-R GUI should show in your browser window,
 while in the CLI you should see a long series of server log messages like:
 
 <pre>
-[2022-10-17 14:55:37] Static file: /index.html
-[2022-10-17 14:55:37] Static file: /scripts/iro.min.js
-[2022-10-17 14:55:37] Static file: /images/open.png
+[2023-04-29 22:55:17] Static file: /index.html
+[2023-04-29 22:55:17] Static file: /scripts/iro.min.js
+[2023-04-29 22:55:17] Static file: /images/open.png
 ... etc.
 </pre>
 

package/package.json

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

package/static/index.html

@@ -165,7 +165,8 @@ SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
                 // Inform user that newer version exists
                 UI.check_update_modal.element('msg').innerHTML = [
                     '<a href="', GITHUB_REPOSITORY,
-                    '/wiki/Linny-R-version-history" ',
+                    '/wiki/Linny-R-version-history#%EF%B8%8F-current-',
+                    info[1].replaceAll('.', ''), '" ',
                     'title="Click to view version release notes" ',
                     'target="_blank">Version <strong>',
                     info[1], '</strong></a> released on ',
@@ -198,6 +199,7 @@ SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
       UNDO_STACK = new UndoStack();
       X_EDIT = new ExpressionEditor();
       ACTOR_MANAGER = new ActorManager();
+      SCALE_UNIT_MANAGER = new ScaleUnitManager();
       EQUATION_MANAGER = new EquationManager();
       FINDER = new Finder();
       CONSTRAINT_EDITOR = new ConstraintEditor();  
@@ -487,7 +489,12 @@ and move the cursor over the status bar">
         </strong>
       </div>
     </div>
-  </div>  
+  </div>
+  
+  <!-- the UNITS datalist is a placeholder for scale units -->
+  <datalist id="units-data">
+    <option value="1">
+  </datalist>
   
   <!-- the MODEL SETTINGS dialog allows the user to modify model parameters -->
   <div id="settings-modal" class="modal">
@@ -510,15 +517,21 @@ and move the cursor over the status bar">
           <td><input id="settings-author" type="text" autocomplete="off"
                      style="width:270px"></td>
         </tr>
-      </table>
-      <table style="width:100%; white-space: nowrap">
         <tr>
           <td colspan="2">Default product unit:&nbsp;
-            <input id="settings-product-unit" type="text" autocomplete="off"
-                   style="width:45px;margin-right:19px">Currency unit:&nbsp;
+            <input id="settings-product-unit" type="text"
+                   list="units-data" autocomplete="off" style="width:80px">
+            <img id="settings-scale-units-btn" class="sbtn" src="images/scale.png"
+                 title="View scale units">
+          </td>
+        </tr>
+        <tr>
+          <td colspan="2">Currency unit:&nbsp;
             <input id="settings-currency-unit" type="text" style="width:45px">
           </td>
         </tr>
+      </table>
+      <table style="width:100%; white-space: nowrap">
         <tr>
           <td style="padding:0px">
             <div id="settings-decimal-comma" class="box clear"></div>
@@ -599,6 +612,55 @@ and move the cursor over the status bar">
     </div>
   </div>
 
+  <!-- the SCALE UNITS dialog allows viewing/editing scale units -->
+  <div id="scale-units-modal" class="modal">
+    <div id="scale-units-dlg" class="inp-dlg">
+      <div class="dlg-title">
+        Scale units
+        <img class="close-btn" src="images/close.png">
+      </div>
+      <div id="scale-units-buttons">
+        <img id="scale-units-new-btn" class="btn enab" src="images/new.png"
+             title="New scale unit">
+        <img id="scale-units-edit-btn" class="btn disab" src="images/edit.png"
+             title="Edit selected scale unit">
+        <img id="scale-units-delete-btn" class="btn disab" src="images/delete.png"
+             title="Delete selected scale unit">
+      </div>
+      <div id="scale-units-scroll-area">
+        <table id="scale-units-table">
+        </table>
+      </div>
+    </div>
+  </div>
+
+  <!-- the ADD SCALE UNIT dialog prompts for a new scale unit -->
+  <div id="new-scale-unit-modal" class="modal">
+    <div id="new-scale-unit-dlg" class="inp-dlg">
+      <div class="dlg-title">
+        <span id="new-scale-unit-action" >Define new</span> scale unit
+        <img class="cancel-btn" src="images/cancel.png"">
+        <img class="ok-btn" src="images/ok.png">
+      </div>
+      <table>
+        <tr>
+          <td>Unit:</td>
+          <td title="Unit symbols must be alphanumeric and start with a letter.
+NOTE: Unit symbols are case-sensitive, so BTU &ne; Btu">
+            <input id="new-scale-unit-name" type="text" autocomplete="off">
+          </td>
+          <td>=</td>
+          <td>
+            <input id="new-scale-unit-scalar" type="text" autocomplete="off">
+          </td>
+          <td title="Base unit (optional)">
+            <input id="new-scale-unit-base" type="text" list="units-data" autocomplete="off">
+          </td>
+        </tr>
+      </table>
+    </div>
+  </div>
+
   <!-- the REPOSITORY BROWSER dialog allows interaction with repositories -->
   <div id="repository-dlg" class="inp-dlg">
     <div id="repository-hdr" class="dragger dlg-title">Repository browser
@@ -741,7 +803,7 @@ and move the cursor over the status bar">
         <tr>
           <td>Module:</td>
           <td>
-            <input id="store-bb-model-in-repository-name" type="text"
+            <input id="store-bb-in-repository-model-name" type="text"
                    autocomplete="off" style="width:266px; font-size:12px;">
           </td>
         </tr>
@@ -947,7 +1009,7 @@ and move the cursor over the status bar">
         <tr>
           <td>Unit:</td>
           <td>
-            <input id="add-product-unit"
+            <input id="add-product-unit" list="units-data"
                    style="width:70px" type="text" autocomplete="off">
           </td>
           <td style="width:20px;padding:0px">
@@ -1247,7 +1309,7 @@ and move the cursor over the status bar">
       <div id="product-name-lbl">Name:</div>
       <input id="product-name" type="text" autocomplete="off">
       <div id="product-unit-lbl">Unit:</div>
-      <input id="product-unit" type="text" autocomplete="off">
+      <input id="product-unit" type="text" list="units-data" autocomplete="off">
       <div id="source" title="Source products may have level &lt; 0">
         <div id="product-source" class="box clear"></div>
         <div id="product-source-lbl">Source</div>
@@ -1283,7 +1345,7 @@ and move the cursor over the status bar">
       <div id="product-P-div">
         <div id="product-P-lbl">
           Price
-          <small>(<span id="product-currency"></span>/<span id="product-P-unit"></span>)</small>:
+          <small>(<span id="product-currency"></span><span id="product-P-unit"></span>)</small>:
         </div>
         <input id="product-P" type="text" autocomplete="off">
         <img id="product-P-x" class="sbtn enab" src="images/edit.png"
@@ -1539,7 +1601,7 @@ and move the cursor over the status bar">
         <img class="ok-btn" src="images/ok.png">
       </div>
       <input id="new-selector-name" type="text"
-             title="Can contain only alphanumerical characters, +, -, and %
+             title="Can contain only alphanumeric characters, +, -, and %
 NOTE: * and ? will be interpreted as wildcards" 
              maxlength="10" autocomplete="off">
       <div id="new-selector-label">(1 to 10 characters)</div>
@@ -1555,7 +1617,7 @@ NOTE: * and ? will be interpreted as wildcards"
         <img class="ok-btn" src="images/ok.png">
       </div>
       <input id="rename-selector-name" type="text"
-             title="Can contain only alphanumerical characters, +, -, and %" 
+             title="Can contain only alphanumeric characters, +, -, and %" 
              maxlength="10" autocomplete="off">
       <div id="rename-selector-label">(1 to 10 characters)</div>
     </div>
@@ -1575,6 +1637,8 @@ NOTE: * and ? will be interpreted as wildcards"
       </div>
       <div id="series-default-lbl">Default value:</div>
       <input id="series-default" type="text" autocomplete="off">
+      <div id="series-unit-lbl">Unit:</div>
+      <input id="series-unit" type="text" list="units-data" autocomplete="off">
       <div id="series-periodic" class="box clear"></div>
       <div id="series-periodic-lbl">Periodic</div>
       <div id="series-array" class="box clear"></div>
@@ -2015,8 +2079,12 @@ NOTE: * and ? will be interpreted as wildcards"
                  title="Move dimension down in list">
             <img id="xp-d-settings-btn" class="v-btn" src="images/settings.png"
                  title="Edit model settings dimensions">
+            <img id="xp-d-iterator-btn" class="v-btn" src="images/iterator.png"
+                 title="Edit iterator ranges">
             <img id="xp-d-actor-btn" class="v-btn" src="images/actors.png"
-                 title="Edit actor dimension">
+                 title="Edit actors dimension">
+            <img id="xp-d-combination-btn" class="v-btn" src="images/combination.png"
+                 title="Edit combination dimensions">
             <img id="xp-d-delete-btn" class="v-btn" src="images/remove.png"
                  title="Remove selected dimension from list">
           </div>
@@ -2232,6 +2300,55 @@ NOTE: * and ? will be interpreted as wildcards"
     </div>
   </div>
 
+  <!-- the ITERATOR dialog permits editing the iterator ranges -->
+  <div id="xp-iterator-modal" class="modal">
+    <div id="xp-iterator-dlg" class="inp-dlg">
+      <div class="dlg-title">
+        Iterator ranges
+        <img class="cancel-btn" src="images/cancel.png">
+        <img class="ok-btn" src="images/ok.png">
+      </div>
+      <table id="xp-iterator-table">
+        <tr>
+          <td>i</td><td>=</td>
+          <td>
+            <input id="xp-iterator-i-from" type="text" class="range-limit"
+                   placeholder="0" maxlength="4" autocomplete="off">
+          </td>
+          <td>&hellip;</td>
+          <td>
+            <input id="xp-iterator-i-to" type="text" class="range-limit"
+                   placeholder="0" maxlength="4" autocomplete="off">
+          </td>
+        </tr>
+        <tr>
+          <td>j</td><td>=</td>
+          <td>
+            <input id="xp-iterator-j-from" type="text" class="range-limit"
+                   placeholder="0" maxlength="4" autocomplete="off">
+          </td>
+          <td>&hellip;</td>
+          <td>
+            <input id="xp-iterator-j-to" type="text" class="range-limit"
+                   placeholder="0" maxlength="4" autocomplete="off">
+          </td>
+        </tr>
+        <tr>
+          <td>k</td><td>=</td>
+          <td>
+            <input id="xp-iterator-k-from" type="text" class="range-limit"
+                   placeholder="0" maxlength="4" autocomplete="off">
+          </td>
+          <td>&hellip;</td>
+          <td>
+            <input id="xp-iterator-k-to" type="text" class="range-limit"
+                   placeholder="0" maxlength="4" autocomplete="off">
+          </td>
+        </tr>
+      </table>
+    </div>
+  </div>
+
   <!-- the SETTINGS dialog permits editing the model settings dimensions -->
   <div id="xp-settings-modal" class="modal">
     <div id="xp-settings-dlg" class="inp-dlg">
@@ -2344,6 +2461,74 @@ Example: s=0.5h  t=1-480  b=24  l=24   (in this order: s t b l)">
     </div>
   </div>
 
+  <!-- the COMBINATION dialog permits editing the combination dimensions -->
+  <div id="xp-combination-modal" class="modal">
+    <div id="xp-combination-dlg" class="inp-dlg">
+      <div class="dlg-title">
+        Combination dimensions
+        <img class="close-btn" src="images/close.png">
+      </div>
+      <div id="xp-combination-s-header">Combination selectors:
+        <img id="xp-combination-s-add-btn" class="v-btn" src="images/add.png"
+             title="Add combination selector">
+      </div>
+      <div id="xp-combination-s-scroll-area">
+        <table id="xp-combination-s-table">
+        </table>
+      </div>
+      <div id="xp-combination-d-header">Combination dimensions:
+        <img id="xp-combination-d-add-btn" class="v-btn" src="images/add.png"
+             title="Add combination dimension">
+      </div>
+      <div id="xp-combination-d-scroll-area">
+        <table id="xp-combination-d-table">
+        </table>
+      </div>
+    </div>
+  </div>
+
+  <!-- the COMBINATION SELECTOR dialog prompts for a selector + string -->
+  <div id="xp-combination-selector-modal" class="modal">
+    <div id="xp-combination-selector-dlg" class="inp-dlg">
+      <div class="dlg-title">
+        <span id="xp-combination-selector-action">Edit</span>
+        combination selector
+        <span id="xp-combination-selector-clear" class="sd-clear">
+          (clear combination field to remove)
+        </span>
+        <img class="cancel-btn" src="images/cancel.png">
+        <img class="ok-btn" src="images/ok.png">
+      </div>
+      <div style="padding: 2px; white-space: nowrap">
+        <label>Selector:</label>
+        <input id="xp-combination-selector-code" type="text"
+               title="Max. 10 characters (only alphanumericals, +, -, and %)" 
+               maxlength="10" autocomplete="off">
+        <label>Combination:</label>
+        <input id="xp-combination-selector-string" type="text" autocomplete="off"
+               title="One or more selectors, each from a different dimension">
+      </div>
+    </div>
+  </div>
+
+  <!-- the COMBINATION DIMENSION dialog prompts for a combination dimension -->
+  <div id="xp-combination-dimension-modal" class="modal">
+    <div id="xp-combination-dimension-dlg" class="inp-dlg">
+      <div class="dlg-title">
+        <span id="xp-combination-dimension-action">Edit</span>
+        combination dimension
+        <span id="xp-combination-dimension-clear">(clear to remove)</span>
+        <img class="cancel-btn" src="images/cancel.png">
+        <img class="ok-btn" src="images/ok.png">
+      </div>
+      <div style="padding: 2px; white-space: nowrap"
+           title="One or more combination selectors, separated by spaces">
+        <label>Selectors:</label>
+        <input id="xp-combination-dimension-string" type="text" autocomplete="off">
+      </div>
+    </div>
+  </div>
+
   <!-- The "clusters to ignore" dialog displays a scrollable list of clusters
        set to be ignored for specified selectors.
        NOTE: Changes to this list are discarded if CANCEL is clicked.