linny-r 2.0.8 → 2.0.10

package/README.md

@@ -36,8 +36,8 @@ 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 (December 2024)
-this is 23.3.0. 
+Linny-R is developed using the _current_ release. Presently (May 2025)
+this is 24.1.0. 
 
 Run the installer and accept the default settings.
 There is <u>**no**</u> need to install the optional _Tools for Native Modules_.
@@ -48,7 +48,7 @@ Verify the installation by typing:
 
 ``node --version``
 
-The response should be the version number of Node.js, for example: v23.3.0.
+The response should be the version number of Node.js, for example: v24.1.0.
 
 ## Installing Linny-R
 It is advisable to install Linny-R in a directory on your computer, **not**
@@ -116,7 +116,6 @@ The `linny-r` package directory should contain this file `README.md`, the files
 `static`. This `static` directory should contain three HTML files: 
 
 * `index.html` (the browser-based GUI) 
-* `show-png.html` (to render SVG diagrams as PNG images)
 * `show-diff.html` (to display differences between two Linny-R models)
 
 It should also contain the style sheet `linny-r.css` required by the GUI.
@@ -379,7 +378,6 @@ You can customize Linny-R by adding more arguments to the `node` command
 in the launch script:
 
 <pre>
-dpi=[number]       to overrule the default resolution (300 dpi) for Inkscape 
 launch             to automatically launch Linny-R in your default browser
 port=[number]      to overrule the default port number (5050)
 solver=[name]      to overrule the default sequence (Gurobi, MOSEK, CPLEX, SCIP, LP_solve)
@@ -402,8 +400,6 @@ The sub-directories of this directory `user` are used by Linny-R to store files.
 * `channel` and `callback` will be used to interact with Linny-R via its _Receiver_ 
 * `data` will be used by the _Dataset Manager_ to locate datasets for which
   a path has been specified
-* `diagrams` will be used to render Scalable Vector Graphics (SVG) files as
-  Portable Network Graphics (PNG) using Inkscape (if installed)
 * `models` will contain models that you saved by Shift-clicking on the
   _Save_ button, or using the keyboard shortcut Ctrl-Shift-S
 * `modules` will contain models stored in the `local host` _repository_
@@ -419,39 +415,6 @@ The sub-directories of this directory `user` are used by Linny-R to store files.
 > option. This will create a new, empty workspace in the specified path.
 > It will **not** affect or duplicate information from existing workspaces.
 
-## Installing Inkscape
-
-Linny-R creates its diagrams and charts as SVG images. 
-When you download a diagram, it will be saved as a .svg file.
-These files can be viewed and edited using Inkscape, an open source
-vector graphics editor. 
-
-As it may be tedious to first save a diagram as SVG and then render it
-manually as a bitmap image, Linny-R features a *Render diagram as bitmap*
-button on the top toolbar, and on the bottom toolbar of the _Chart manager_.
-When you click it, Linny-R will send the image as SVG to the server. 
-The server script will save the SVG in the `user/diagrams` sub-directory, 
-and then try to execute an Inkscape command that will convert this SVG to
-a PNG image file in the same directory.
-The file name will be `diagram-(date and time).png`. 
-Meanwhile, the browser will have opened a new tab that will be "waiting"
-for this PNG image to become available. 
-If rendering was successful, the image will appear in this browser tab; 
-if rendering failed, the original SVG image will be shown.
-
-To install Inkscape, please look here:
-<a href="https://inkscape.org/release"
-   target="_blank">https://inkscape.org/release</a>
-
-Linny-R will automatically detect whether Inkscape is installed by searching
-for it in the environment variable PATH on your computer. On a macOS computer,
-Linny-R will look for Inkscape in `/Applications/Inkscape.app/Contents/MacOS`.
-
-> [!NOTE]
-> The installation wizard for Inkscape (version 1.3) may **not**
-> add the application to the PATH variable. Please check whether you need to
-> do this yourself.
-
 ## Using Linny-R console
 
 The console-only version of Linny-R allows you to run a Linny-R model without

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "linny-r",
-  "version": "2.0.8",
+  "version": "2.0.10",
   "description": "Executable graphical language with WYSIWYG editor for MILP models",
   "main": "server.js",
   "scripts": {
@@ -21,7 +21,11 @@
     "optimization",
     "simulation",
     "unit commitment",
-    "generation expansion"
+    "industrial ecology",
+    "linearized power flow",
+    "loss approximation",
+    "generation expansion",
+    "grid expansion"
   ],
   "author": "Pieter W.G. Bots",
   "license": "MIT",

package/server.js

@@ -1265,29 +1265,27 @@ function rcvrCallBack(res, rpath, rfile, script) {
 const STATIC_FILES = {
     // MIME types of files that can be served
     extensions: {
-      js: 'application/javascript',
-      xml: 'application/xml',
-      wav: 'audio/x-wav',
-      ttc: 'font/collection',
-      otf: 'font/otf',
-      ttf: 'font/ttf',
-      icns: 'image/icns',
-      png: 'image/png',
-      svg: 'image/svg+xml',
-      ico: 'image/x-icon',
-      css: 'text/css',
-      html: 'text/html',
-      txt: 'text/plain'
-    },
+        js: 'application/javascript',
+        xml: 'application/xml',
+        wav: 'audio/x-wav',
+        ttc: 'font/collection',
+        otf: 'font/otf',
+        ttf: 'font/ttf',
+        icns: 'image/icns',
+        png: 'image/png',
+        svg: 'image/svg+xml',
+        ico: 'image/x-icon',
+        css: 'text/css',
+        html: 'text/html',
+        txt: 'text/plain'
+      },
     // Subdirectories of (main)/static/ directory from which files with
     // accepted MIME types can be served
     directories: {
         '/scripts': ['js'],
         '/images': ['icns', 'ico', 'png', 'svg'],
         '/fonts': ['otf', 'ttc', 'ttf'],
-        '/sounds': ['wav'],
-        // NOTE: diagrams will actually be served from (main)/user/diagrams/
-        '/diagrams': ['png', 'svg']
+        '/sounds': ['wav']
       },
     // Files that can be served from the (main)/static/ directory itself
     files: [
@@ -1417,17 +1415,11 @@ function permittedFile(path) {
 }
 
 function serveStaticFile(res, path) {
-  // Serve the specified path (if permitted: only diagrams and static files)
+  // Serve the specified path (if permitted: only static files)
   if(path === '/' || path === '') path = '/index.html';
-  if(path.startsWith('/diagrams/')) {
-    // Serve diagrams from the (main)/user/diagrams/ sub-directory 
-    logAction('Diagram: ' + path);
-    path = WORKING_DIRECTORY + '/user' + path;
-  } else {
-    // Other files from the (main)/static/ subdirectory
-    logAction('Static file: ' + path);
-    path = MODULE_DIRECTORY + '/static' + path;
-  }
+  // Serve files from the (main)/static/ subdirectory
+  logAction('Static file: ' + path);
+  path = MODULE_DIRECTORY + '/static' + path;
   fs.readFile(path, (err, data) => {
       if(err) {
         console.log(err);
@@ -1442,75 +1434,6 @@ function serveStaticFile(res, path) {
     });
 }
 
-function convertSVGtoPNG(req, res, sp) {
-  // Convert SVG data from browser to PNG image using Inkscape
-  // NOTE: images can be huge, so send only the file name as response;
-  // Linny-R will open a new browser window, load the file, and display it
-  const
-      svg = decodeURI(atob(sp.get('data'))),
-      // Use current time as file name
-      fn = 'diagram-' +
-          (new Date()).toISOString().slice(0, 19).replace(/[\-\:]/g, ''),
-      fp = path.join(WORKSPACE.diagrams, fn);
-  // NOTE: use binary encoding for SVG file
-  logAction('Saving SVG file: ' + fp);
-  try {
-    fs.writeFileSync(fp + '.svg', svg);
-  } catch(error) {
-    console.log('WARNING: Failed to save SVG --', error);
-  }
-  // Use Inkscape to convert SVG to the requested format
-  if(SETTINGS.inkscape) {
-    logAction('Rendering image');
-    let
-      cmd = SETTINGS.inkscape,
-      svg = fp + '.svg';
-    // Enclose paths in double quotes if they contain spaces
-    if(cmd.indexOf(' ') >= 0) cmd = `"${cmd}"`;
-    if(svg.indexOf(' ') >= 0) svg = `"${svg}"`;
-    cmd += ` --export-type=png --export-dpi=${SETTINGS.dpi} ${svg}`;
-    console.log(cmd);
-    child_process.exec(cmd,
-        (error, stdout, stderr) => {
-            let ext = '.svg';
-            console.log(stdout);
-            if(error) {
-              console.log('WARNING: Failed to run Inkscape --', error);
-              console.log(stderr);
-            } else {
-              // Look for the PNG file.
-              const mode = fs.constants.R_OK | fs.constants.W_O;
-              try {
-                fs.accessSync(fp + '.png', mode);
-                ext = '.png';
-              } catch(err) {
-                // NOTE: Inkscape 1.3 adds ".png" to the original file name,
-                // so this may end on ".svg.png"
-                try {
-                  fs.accessSync(fp + '.svg.png', mode);
-                  // If found, rename the PNG file.
-                  fs.renameSync(fp + '.svg.png', fp + '.png');
-                  ext = '.png';
-                } catch(err) {
-                  console.log('WARNING: Inkscape did not output a PNG file');
-                }
-              }
-              // Delete the SVG file.
-              try {
-                fs.unlinkSync(fp + '.svg');
-              } catch(error) {
-                console.log(`NOTICE: Failed to delete SVG file "${fp}.svg"`);
-              }
-            }
-            // Return the image file name (PNG if successful, otherwise SVG) 
-            servePlainText(res, 'diagrams/' + fn + ext);
-          }
-      );
-  } else {
-    servePlainText(res, 'diagrams/' + fn + '.svg');
-  }
-}
-
 // Convenience functions to fetch data from external URL
 // NOTE: the parameters `on_ok` and `on_error` must be functions with two
 // parameters:
@@ -1591,8 +1514,6 @@ function commandLineSettings() {
   // Sets default settings, and then checks the command line arguments.
   const settings = {
       cli_name: (PLATFORM.startsWith('win') ? 'Command Prompt' : 'Terminal'),
-      inkscape: '',
-      dpi: 300,
       launch: false,
       port: 5050,
       preferred_solver: '',
@@ -1604,7 +1525,6 @@ function commandLineSettings() {
       usage = `Usage:  ${app} server [options]
 
 Possible options are:
-  dpi=[number]       will make InkScape render SVGs in the specified resolution
   help               will display these command line options
   launch             will open the Linny-R GUI in a browser window
   port=[number]      will listen at the specified port number
@@ -1635,14 +1555,6 @@ Possible options are:
         } else {
           settings.preferred_solver = av[1];
         }
-      } else if(av[0] === 'dpi') {
-        // Accept any number greater than or equal to 1024.
-        const n = parseInt(av[1]);
-        if(isNaN(n) || n > 1200) {
-          console.log(`WARNING: Invalid resolution ${av[1]} (max. 1200 dpi)`);
-        } else {
-          settings.dpi = n;
-        }
       } else if(av[0] === 'workspace') {
         // User directory must be READ/WRITE-accessible.
         try {
@@ -1665,55 +1577,6 @@ Possible options are:
       }
     }
   }
-  // Check whether Inkscape has been installed.
-  const path_list = process.env.PATH.split(path.delimiter);
-  for(let i = 0; i < path_list.length; i++) {
-    // Check whether it is an Inkscape path.
-    match = path_list[i].match(/inkscape/i);
-    // If so, use it (so the *last* matching path will be used).
-    if(match) settings.inkscape = path_list[i];
-  }
-  // NOTE: On macOS, Inkscape is not added to the PATH environment variable. 
-  if(!settings.inkscape && PLATFORM === 'darwin') {
-    console.log('Looking for Inkscape in Applications...');
-    try {
-      // Look in the default directory.
-      const ip = '/Applications/Inkscape.app/Contents/MacOS';
-      fs.accessSync(ip);
-      settings.inkscape = ip;
-    } catch(err) {
-      // No real error, so no action needed.
-    }
-  }
-  // Verify that Inkscape is installed.
-  if(settings.inkscape) {
-    // NOTE: On Windows, the command line version is a .com file.
-    let ip = path.join(settings.inkscape,
-        'inkscape' + (PLATFORM.startsWith('win') ? '.com' : ''));
-    try {
-      fs.accessSync(ip, fs.constants.X_OK);
-    } catch(err) {
-      // NOTE: As of Inkscape version 1.3, the command line executable
-      // is called inkscapecom(.com).
-      ip = path.join(settings.inkscape,
-          'inkscapecom' + (PLATFORM.startsWith('win') ? '.com' : ''));
-    }
-    try {
-      fs.accessSync(ip, fs.constants.X_OK);
-      console.log('Path to Inkscape:', settings.inkscape);
-      settings.inkscape = ip;
-      console.log(
-          `SVG will be rendered with ${settings.dpi} dpi resolution`);
-    } catch(err) {
-      settings.inkscape = '';
-      console.log(err.message);
-      console.log(
-          'WARNING: Failed to access the Inkscape command line application');
-    }
-  } else {
-    console.log(
-        'Inkscape not installed, so images will not be rendered as PNG');
-  }
   return settings;
 }
 
@@ -1741,7 +1604,6 @@ function createWorkspace() {
       channel: path.join(SETTINGS.user_dir, 'channel'),
       callback: path.join(SETTINGS.user_dir, 'callback'),
       data: path.join(SETTINGS.user_dir, 'data'),
-      diagrams: path.join(SETTINGS.user_dir, 'diagrams'),
       models: path.join(SETTINGS.user_dir, 'models'),
       modules: path.join(SETTINGS.user_dir, 'modules'),
       reports: path.join(SETTINGS.user_dir, 'reports'),

package/static/index.html

@@ -277,13 +277,9 @@ SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
            title="Sensitivity analysis (Ctrl-J)">
       <img id="experiment-btn" class="btn enab" src="images/experiment.png"
            title="Manage experiments (Ctrl-X)">
-      <a href="show-png.html" target="_blank"
-         style="text-decoration: none; outline: none">
-        <img id="diagram-btn" class="btn enab" src="images/diagram.png"
-           title="Render diagram as bitmap at 300 dpi (Ctrl-P)">
-      </a>
       <img id="savediagram-btn" class="btn enab" src="images/save-diagram.png"
-           title="Download diagram as Scalable Vector Graphics (Ctrl-G)">
+           title="Download diagram as Portable Network Graphics bitmap image (Ctrl-P)
+&#x270E; Shift-click to download as Scalable Vector Graphics (Ctrl-Shift-P)">
       <img id="finder-btn" class="btn enab" src="images/find.png"
            title="Find model elements by their name (Ctrl-F)">
       <img id="monitor-btn" class="btn enab" src="images/monitor.png"
@@ -771,6 +767,24 @@ NOTE: Unit symbols are case-sensitive, so BTU &ne; Btu">
         <table id="power-grids-table">
         </table>
       </div>
+      <table>
+        <tr title="Checked aspects will be ignored for all power grids">
+          <td style="padding-bottom: 3px; font-style: italic">Disregard:</td>
+          <td style="padding: 0px; width: 20px">
+            <div id="power-grids-capacity" class="box clear"></div>
+          </td>
+          <td style="padding-bottom: 3px; width: 70px">Congestion</td>
+          <td style="padding: 0px; width: 20px">
+            <div id="power-grids-KVL" class="box clear"></div>
+          </td>
+          <td style="padding-bottom: 3px; width: 35px"
+              title="Kirchhoff's Voltage Law">KVL</td>
+          <td style="padding: 0px; width: 20px">
+            <div id="power-grids-losses" class="box clear"></div>
+          </td>
+          <td style="padding-bottom: 3px">Losses</td>
+        </tr>
+      </table>
     </div>
   </div>
 
@@ -1716,7 +1730,86 @@ Each line should represent the points of a different bound line.">
       </div>
     </div>
   </div>
+
+  <!-- the DATASET GROUP modal allows editing properties of multiple datasets -->
+  <div id="datasetgroup-modal" class="modal">
+    <div id="datasetgroup-dlg" class="inp-dlg">
+      <div class="dlg-title">
+        Dataset group properties
+        <span id="datasetgroup-group"></span>
+        <img class="cancel-btn" src="images/cancel.png">
+        <img class="ok-btn" src="images/ok.png">
+      </div>
+      <div id="datasetgroup-prefix-lbl">Prefix:</div>
+      <input id="datasetgroup-prefix" type="text" autocomplete="off">
+      <div id="datasetgroup-default-lbl">Default value:</div>
+      <input id="datasetgroup-default" type="text" autocomplete="off">
+      <div id="datasetgroup-unit-lbl">Unit:</div>
+      <input id="datasetgroup-unit" type="text" list="units-data" autocomplete="off">
+      <div id="datasetgroup-periodic" class="box clear"></div>
+      <div id="datasetgroup-periodic-lbl">Periodic</div>
+      <div id="datasetgroup-array" class="box clear"></div>
+      <div id="datasetgroup-array-lbl">Array</div>
+      <div id="datasetgroup-no-time-msg">
+        Arrays ignore time dimension
+      </div>
+      <div id="datasetgroup-time-step-lbl">Time step:</div>
+      <input id="datasetgroup-time-scale" type="text" autocomplete="off">
+      <select id="datasetgroup-time-unit">
+        <option value="year">yr</option>
+        <option value="week">wk</option>
+        <option value="day">d</option>
+        <option value="hour">h</option>
+        <option value="minute">m</option>
+        <option value="second">s</option>
+      </select>
+      <div id="datasetgroup-method-lbl">Method:</div>
+      <select id="datasetgroup-method">
+        <option value="nearest">at nearest t</option>
+        <option value="w-mean">weighted mean</option>
+        <option value="w-sum">weighted sum</option>
+        <option value="max">maximum</option>
+      </select>
+      <div id="datasetgroup-separator"></div>
+      <div id="datasetgroup-modif-header">Modifiers</div>
+      <div id="datasetgroup-modif-titles">
+        <span>Selector</span>
+        <span style="margin-left: 35px">Expression</span>
+      </div>
+      <div id="datasetgroup-modif-scroll-area">
+        <table id="datasetgroup-modif-table">
+        </table>
+      </div>
+      <div id="datasetgroup-modif-buttons">
+        <img id="dsg-add-modif-btn" class="btn enab"
+             src="images/add-selector.png" title="Add new selector">
+        <img id="dsg-rename-modif-btn" class="btn disab" src="images/rename.png"
+             title="Rename selected modifier">
+        <img id="dsg-edit-modif-btn" class="btn disab"
+             src="images/edit.png" title="Edit expression of selected modifier">
+        <img id="dsg-delete-modif-btn" class="btn disab"
+             src="images/delete.png" title="Delete selected modifier"
+             style="margin-left: 20px">
+      </div>
+    </div>
+  </div>
   
+  <!-- the GROUP SELECTOR dialog prompts for a new selector -->
+  <div id="group-selector-modal" class="modal">
+    <div id="group-selector-dlg" class="inp-dlg">
+      <div class="dlg-title">
+        <span id="group-selector-action">Add</span> selector
+        <img class="cancel-btn" src="images/cancel.png">
+        <img class="ok-btn" src="images/ok.png">
+      </div>
+      <input id="group-selector-name" type="text"
+             title="Can contain only alphanumeric characters, +, -, and %
+NOTE: * and ? will be interpreted as wildcards" 
+             maxlength="10" autocomplete="off">
+      <div id="group-selector-label">(1 to 10 characters)</div>
+    </div>
+  </div>
+
   <!-- The CLONE dialog prompts for a prefix -->
   <div id="clone-modal" class="modal">
     <div id="clone-dlg" class="inp-dlg">
@@ -2234,13 +2327,8 @@ NOTE: * and ? will be interpreted as wildcards"
         </div>
         <div id="chart-only-buttons">
           <img id="chart-save-btn" class="btn enab" src="images/save-chart.png"
-               title="Save chart diagram">
-          <a id="chart-render-btn" href="show-png.html" target="_blank"
-             style="margin-left: 4px; text-decoration: none; outline: none">
-            <img class="btn enab" src="images/chart.png"
-                 title="Render chart diagram as PNG"
-                 style="height: 20px; width: 20px">
-          </a>
+               title="Download chart as bitmap image (PNG)
+&#x270E; Shift-click to download chart as Scalable Vector Graphics (SVG)">
           <img id="chart-widen-btn" class="btn enab" src="images/stretch.png"
                title="Widen chart" style="margin-left: 24px">
           <img id="chart-narrow-btn" class="btn enab" src="images/compress.png"
@@ -2858,7 +2946,9 @@ NOTE: * and ? will be interpreted as wildcards"
         <label>Settings:</label>
         <input id="xp-settings-selector-string" type="text" autocomplete="off"
                title="Can specifiy time step, simulation period, block length and look-ahead.
-Example: s=0.5h  t=1-480  b=24  l=24   (in this order: s t b l)">
+Example: s=0.5h  t=1-480  b=24  l=24
+When modeling power grids, -c indicates &ldquo;disregard grid capacity&rdquo;,
+-k &ldquo;disregard Kirchhoff's Voltage Law&rdquo;, and -l &ldquo;disregard power losses&rdquo;">
       </div>
     </div>
   </div>
@@ -3048,12 +3138,17 @@ where X can be one or several of these letters: ABCDELPQ">
     <div id="finder-status">
       <span id="finder-count"></span> found
     </div>
-    <img id="finder-edit-btn" class="btn enab"
-         src="images/edit.png"
-         title="Edit attributes">
-    <img id="finder-copy-btn" class="btn enab"
-         src="images/table-to-clpbrd.png"
-         title="Copy entity attributes to clipboard">
+    <div id="finder-status-buttons">
+      <img id="finder-edit-btn" class="btn enab"
+           src="images/edit.png"
+           title="Edit attributes">
+      <img id="finder-chart-btn" class="btn enab"
+           src="images/chart.png"
+           title="Add attribute to chart">
+      <img id="finder-copy-btn" class="btn enab"
+           src="images/table-to-clpbrd.png"
+           title="Copy entity attributes to clipboard">
+    </div>
     <div id="finder-separator"></div>
     <div id="finder-item-header">(no item selected)</div>
     <div id="finder-item-scroll-area">
@@ -3068,6 +3163,28 @@ where X can be one or several of these letters: ABCDELPQ">
     <div id="finder-resize" class="resizer"></div>
   </div>
 
+  <!-- the CONFIRM ADD CHART VARIABLES modal asks to confirm to add a
+       specific attribute of the filtered entities to the current chart -->
+  <div id="confirm-add-chart-variables-modal" class="modal">
+    <div id="confirm-add-chart-variables-dlg" class="inp-dlg">
+      <div class="dlg-title">
+        Add to chart
+        <img class="cancel-btn" src="images/cancel.png">
+        <img class="ok-btn" src="images/ok.png">
+      </div>
+      <div style="margin: 2px; padding-right: 2px; white-space: nowrap">
+        <select id="confirm-add-chart-variables-attribute"></select>
+        of <span id="confirm-add-chart-variables-count"></span>
+      </div>
+      <div>
+        <div id="confirm-add-chart-variables-stacked" class="box clear"></div>
+        <div style="display:inline-block; vertical-align:top; margin-top: 3px">
+          Display as stacked areas
+        </div>
+      </div>
+    </div>
+  </div>
+
   <!-- the MONITOR dialog shows solver progress and messages, and model equations -->
   <div id="monitor-dlg" class="inp-dlg">
     <div id="monitor-hdr" class="dragger dlg-title">Solver monitor