linny-r 1.1.1 → 1.1.3

package/README.md

@@ -24,7 +24,7 @@ via the official documentation site https://linny-r.info.
 Linny-R is developed as a JavaScript package, and requires that **Node.js** is installed on your computer. 
 Node.js can be downloaded from https://nodejs.org. 
 Make sure that you choose the correct installer for your computer.
-Linny-R is developed using the *current* release. Presently (September 2022) this is 18.9.0. 
+Linny-R is developed using the *current* release. Presently (October 2022) this is 18.10.0. 
 
 Run the installer and accept the default settings.
 There is **no** need to install the optional Tools for Native Modules.
@@ -35,28 +35,58 @@ Verify the installation by typing:
 
 ``node --version``
 
-The response should be the version number of Node.js, for example: v18.9.0.
+The response should be the version number of Node.js, for example: v18.10.0.
 
 ### Installing Linny-R
 It is advisable to install Linny-R in a directory on your computer, not in a cloud. 
-In this installation guide, this directory is called `Linny-R`.
-At the command line, change to the Linny-R directory (if you are not there already) and type: 
+In this installation guide, the path to this directory is denoted by `WORKING_DIRECTORY`,
+so in all commands you should replace this with the actual directory path.
+On a Windows machine you may choose something like `C:\Users\xyz\Documents\Linny-R`,
+and on a macOS machine probably `/Users/xyz/Linny-R`.
 
-``npm install linny-r``
+To install Linny-R in this directory, type at the command line prompt: 
 
-The Linny-R directory should now contain a new sub-directory `node_modules`, 
+``npm install --prefix WORKING_DIRECTORY linny-r``
+
+`WORKING_DIRECTORY` should now contain a new sub-directory `node_modules`, 
 and two JSON files `package.json` and `package-lock.json` that should **not** be removed,
 or you will have to re-install Linny-R.
 
-When configuring Linny-R for a network environment where individual users each have their personal work space (e.g., a virtual drive U:),
-you can instruct Linny-R to create the `user` directory in this work space by adding the argument `workspace=[path]` to the `node` command.
+After installation has been completed, `WORKING_DIRECTORY` will also contain a script file
+to facilitate (single click) launch: on a macOS machine the shell script `linny-r.command`,
+on a Windows machine the batch script `linny-r.bat`. By default, this script file contains
+two commands: change to the Linny-R directory and then tell Node.js to launch the
+start the Linny-R server. When configuring Linny-R for a network environment
+where individual users each have their personal work space (e.g., a virtual drive U:),
+you must edit the script file, adding the argument `workspace=path/to/workspace` to the
+`node` command. This will instruct Linny-R to create the `user` directory in this workspace
+directory instead of the Linny-R directory.
+
+After installation has completed, `WORKING_DIRECTORY` should have this directory tree structure:
+
+<pre>
+WORKING_DIRECTORY
+ |
+ +-node_modules
+    |
+    +-@xmldom
+    |
+    +-linny-r
+       |
+       +-static
+          |
+          +-fonts
+          |
+          +-images
+          |
+          +-scripts
+          |
+          +-sounds
+</pre>
 
-The directory should contain this file `README.md`,
+The `linny-r` directory should contain this file `README.md`,
 the files `server.js` and `console.js` that will be run by Node.js,
 and the sub-directory `static`. 
-After installation has been completed, it will have two more subdirectories `user` and `node_modules`,
-and a script file to facilitate (single click) launch: on a macOS machine the shell script `linny-r.command`,
-on a Windows machine the batch script `linny-r.bat`. 
 
 The `static` directory should contain three HTML files: 
 
@@ -66,43 +96,8 @@ The `static` directory should contain three HTML files:
 
 It should also contain the style sheet `linny-r.css` required by the GUI.
 
-The subdirectories of `static` contain files that are served to the browser by the script `server.js` when it is running in Node.js. 
-
-After installation has completed, the `Linny-R` directory should have this directory tree structure:
-
-<pre>
-Linny-R
- |
- +- static
- |   |
- |   +  fonts
- |   |
- |   +- images
- |   |
- |   +- scripts
- |   |
- |   +- sounds
- |
- +- user
-     |
-     +-callback 
-     |
-     +-channel 
-     |
-     +-diagrams 
-     |
-     +-modules 
-     |
-     +-solver 
-</pre>
-
-The sub-directories of the `user` directory are used by Linny-R to store files.
-
-* `channel` and `callback` will be used to interact with Linny-R via its *Receiver* 
-* `diagrams` will be used to render Scalable Vector Graphics (SVG) files as Portable Network Graphics (PNG) using Inkscape (if installed)
-* `modules` will contain models stored in the `local host` *repository*
-* `solver` will contain the files that are exchanged with the Mixed Integer Linear Programming (MILP) solver
-  (the names of the files that will appear in this directory may vary, depending on the MILP-solver you use)
+The subdirectories of `static` contain files that are served to the browser by the script
+`server.js` when it is running in Node.js. 
 
 ### Configuring the MILP solver
 
@@ -138,7 +133,7 @@ How to do this is explained on the page "Installing LP_solve on a Mac" on the Li
 https://linny-r.info 
 
 When you have downloaded the file (just `lp_solve` for macOS, `lp_solve.exe` for Windows), 
-you must copy or move this file to the main Linny-R directory,
+you must copy or move this file to your `WORKING_DIRECTORY`,
 as this is where Linny-R will look for it when it does not find Gurobi.
 
 On a macOS machine, you must then make the file `lp_solve` executable.
@@ -161,12 +156,13 @@ If you reach this stage, Linny-R will be able to run LP_solve.
 ### Running Linny-R
 
 Open the Command Line Interface (CLI) of your computer.
-On macOS, this will be `Terminal`, on Windows `Command Prompt`. 
+On macOS, open `Terminal`, change to your `WORKING_DIRECTORY` and type:
+
+``node node_modules/linny-r/server``
 
-At the CLI prompt, change to the main Linny-R directory that contains the file `server.js`.
-Then type:
+On Windows, open `Command Prompt`, change to your `WORKING_DIRECTORY` and type:
 
-``node server``
+``node node_modules\linny-r\server``
 
 The response should be something similar to:
 
@@ -175,7 +171,8 @@ Node.js server for Linny-R version 1.0
 Node.js version: v18.9.0
 </pre>
 
-followed by some data on your Linny-R configuration. The last line will be something like:
+followed by some data on your Linny-R configuration.
+The last line will be something like:
 
 <pre>
 Listening at: http://127.0.0.1:5050
@@ -214,16 +211,30 @@ Meanwhile, in the CLI, you should see a server log message like:
 Solve block 1 a
 </pre>
 
+#### User workspace
+
+The user workspace is created when the server is run for the first time.
+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* 
+* `diagrams` will be used to render Scalable Vector Graphics (SVG) files as
+  Portable Network Graphics (PNG) using Inkscape (if installed)
+* `modules` will contain models stored in the `local host` *repository*
+* `solver` will contain the files that are exchanged with the Mixed Integer Linear Programming (MILP) solver
+  (the names of the files that will appear in this directory may vary, depending on the MILP-solver you use)
+
+
+
 #### Command line options
 
 Optionally, you can add more arguments to the `node` command:
 
 <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, LP_solve)
 workspace=[path]   to overrule the default path for the user directory
-dpi=[number]       to overrule the default resolution (300 dpi) for Inkscape 
 </pre>
 
 ### Installing Inkscape
@@ -257,7 +268,7 @@ To facilitate start-up, you can create a shortcut icon on your desktop.
 On a Windows machine, change to your Linny-R folder, right-click on the batch file `linny-r.bat`,
 and select the *Create shortcut* option. 
 Then right-click on the shortcut file to edit its properties, and click the *Change Icon* button.
-The dialog that then appears will allow you to go to the sub-folder `static\images`,
+The dialog that then appears will allow you to go to the sub-folder `node_modules\linny-r\static\images`,
 where you should select the file `linny-r.ico`.
 Finally, rename the shortcut to `Linny-R` and move or copy it to your desktop.
 
@@ -267,7 +278,7 @@ On a macOS machine, open Terminal and change to your Linny-R directory, and then
 
 to make the script file executable.
 To set the icon, click on the icon of `linny-r.command` (which still is plain) and open the Info dialog by pressing ``Cmd+I``.
-Then open your Linny-R folder in the Finder, change to the sub-folder `static/images`, 
+Then open your Linny-R folder in the Finder, change to the sub-folder `node_modules/linny-r/static/images`, 
 and from there drag/drop the file `linny-r.icns` on the icon shown in the top left corner of the Info dialog.
 
 
@@ -289,9 +300,9 @@ In that case, you can stop Node.js by stopping the Terminal.
 
 The console-only version of Linny-R allows you to run a Linny-R model without a web browser.
 This may be useful when you want run models from a script (shell script, Python, ...). 
-If you open a CLI box, change to the main Linny-R directory, and then type:
+If you open a CLI box, change to your `WORKING_DIRECTORY`, and then type:
 
-``node console``
+``node node_modules/linny-r/console``  _(on Windows, use backslashes)_
 
 you will see the command line options that allow you to run models in various ways.
 

package/console.js

@@ -41,31 +41,29 @@ SOFTWARE.
 // (this will make the "module" files linny-r-xxx.js export their properties)
 global.NODE = true;
 
-const VERSION_NUMBER = '1.0.0';
-    
-const MAIN_DIRECTORY = process.cwd();
-
-// Load the required Node.js modules
 const
+    VERSION_NUMBER = '1.1.2',
+    WORKING_DIRECTORY = process.cwd(),
+    path = require('path'),
+    MAIN_DIRECTORY = path.join(WORKING_DIRECTORY, 'node_modules', 'linny-r'),
+    // Load the required Node.js modules
     fs = require('fs'),
     os = require('os'),
-    path = require('path'),
-    readline = require('readline');
-
-// Get the platform name (win32, macOS, linux) of the user's computer
-const PLATFORM = os.platform();
+    readline = require('readline'),
+    // Get the platform name (win32, macOS, linux) of the user's computer
+    PLATFORM = os.platform();
 
 // Immediately output some configuration information to the console
 console.log('\nNode.js Linny-R console version', VERSION_NUMBER);
 console.log('Node.js version:', process.version);
 console.log('Platform:', PLATFORM, '(' + os.type() + ')');
 console.log('Main directory:', MAIN_DIRECTORY);
+console.log('Working directory:', WORKING_DIRECTORY);
 
-// Load the MILP solver (dependent on Node.js: `fs`, `os` and `path`)
-const MILPSolver = require('./static/scripts/linny-r-milp.js');
-    
-// Load the browser-compatible Linny-R scripts
 const
+    // Load the MILP solver (dependent on Node.js: `fs`, `os` and `path`)
+    MILPSolver = require('./static/scripts/linny-r-milp.js'),
+    // Load the browser-compatible Linny-R scripts
     config = require('./static/scripts/linny-r-config.js'),
     utils = require('./static/scripts/linny-r-utils.js'),
     vm = require('./static/scripts/linny-r-vm.js'),
@@ -681,7 +679,7 @@ function commandLineSettings() {
       preferred_solver: '',
       solver: '',
       solver_path: '',
-      user_dir: path.join(MAIN_DIRECTORY, 'user')
+      user_dir: path.join(WORKING_DIRECTORY, 'user')
     };
   let show_usage = process.argv.length < 3;
   for(let i = 2; i < process.argv.length; i++) {
@@ -812,7 +810,7 @@ function commandLineSettings() {
   }
   // Check if lp_solve(.exe) exists in main directory
   const
-      sp = path.join(MAIN_DIRECTORY,
+      sp = path.join(WORKING_DIRECTORY,
           'lp_solve' + (PLATFORM.startsWith('win') ? '.exe' : '')),
       need_lps = !settings.solver || settings.preferred_solver === 'lp_solve';
   try {

package/package.json

@@ -1,9 +1,10 @@
 {
   "name": "linny-r",
-  "version": "1.1.1",
+  "version": "1.1.3",
   "description": "Executable graphical language with WYSIWYG editor for MILP models",
   "main": "server.js",
   "scripts": {
+    "post-install": "post-install.js",
     "test": "echo \"Error: no test specified\" && exit 1"
   },
   "dependencies": {

package/post-install.js

@@ -0,0 +1,81 @@
+/*
+Linny-R is an executable graphical specification language for (mixed integer)
+linear programming (MILP) problems, especially unit commitment problems (UCP).
+The Linny-R language and tool have been developed by Pieter Bots at Delft
+University of Technology, starting in 2009. The project to develop a browser-
+based version started in 2017. See https://linny-r.org for more information.
+
+This NodeJS script (post-install.js) creates a launch script for Linny-R
+that facilitates start-up: the user can then type `linny-r` at the command
+line prompt, and also create a clickable icon as desktop shortcut.
+
+For macOS, the script file is `linny-r.command`, for Windows `linny-r.bat`.
+The script comprises two commands:
+
+  cd path/to/linny-r/directory
+  node node_modules/linny-r/server launch
+  
+since Windows also supports the slash as path separator. The "launch"
+command tells the script `server.js` to start Linny-R in the default
+web browser. 
+
+Comments are added to the script file to facilitate customization of the
+scripts by the user. The README.md file explains how the script file can be
+used for single-click launch of Linny-R, and how the "workspace" parameter
+can be used in a multi-user network environment to provide individual
+workspaces for users.
+*/
+/*
+Copyright (c) 2020-2022 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
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY 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.
+*/
+
+const
+    path = require('path'),
+    WORKING_DIRECTORY = process.cwd(),
+    lines = [
+        '# The first line (without the comment symbol #) should be like this:',
+        '# cd ',
+        '',
+        '# Then this command to launch the Linny-R server should work:',
+        'node ' + path.join('node_modules', 'linny-r', 'server') + ' launch'
+      ];
+let sp;
+if(PLATFORM.startsWith('win')) {
+  sp = path.join(WORKING_DIRECTORY, 'linny-r.bat');
+  lines[1] += 'C:\\path\\to\\main\\Linny-R\\directory';
+} else {
+  sp = path.join(WORKING_DIRECTORY, 'linny-r.command'); 
+  lines[1] += '/path/to/main/Linny-R/directory';
+}
+lines[2] = 'cd ' + WORKING_DIRECTORY;
+try {
+  try {
+    fs.accessSync(sp);
+  } catch(err) {
+    // Only write the script content if the file it does not yet exist
+    console.log('Creating launch script:', sp);
+    let code = lines.join(os.EOL);
+    if(PLATFORM.startsWith('win')) code = code.replace('#', '::');
+    fs.writeFileSync(sp, code, 'utf8');
+  }
+} catch(err) {
+  console.log('WARNING: Failed to create launch script');
+}

package/server.js

@@ -5,7 +5,7 @@ The Linny-R language and tool have been developed by Pieter Bots at Delft
 University of Technology, starting in 2009. The project to develop a browser-
 based version started in 2017. See https://linny-r.org for more information.
 
-This NodeJS script (linny-r-node.js) provides a minimalist local host web server
+This NodeJS script (server.js) provides a minimalist local host web server
 (URL http://127.0.0.1:5050) that will serve the Linny-R GUI (HTML, CSS,
 and JavaScript files, and images), process the requests from the browser
 that pass the MILP equation model to the solver, and then return the solution
@@ -39,15 +39,17 @@ SOFTWARE.
 
 const
     // The version number of this Linny-R server in Node.js
-    VERSION_NUMBER = '1.0.0',
+    VERSION_NUMBER = '1.1.2',
     
     // The URL of the official Linny-R website (with the most recent release)
     PUBLIC_LINNY_R_URL = 'https://sysmod.tbm.tudelft.nl/linny-r',
 
     // The current working directory (from where Node.js was started) is
     // assumed to be the main directory
-    MAIN_DIRECTORY = process.cwd(),
-
+    path = require('path'),
+    WORKING_DIRECTORY = process.cwd(),
+    MAIN_DIRECTORY = path.join(WORKING_DIRECTORY, 'node_modules', 'linny-r'),
+    
     // Get the required built-in Node.js modules
     child_process = require('child_process'),
     crypto = require('crypto'),
@@ -55,7 +57,6 @@ const
     http = require('http'),
     https = require('https'),
     os = require('os'),
-    path = require('path'),
 
     // Get the platform name (win32, macOS, linux) of the user's computer
     PLATFORM = os.platform();    
@@ -65,6 +66,7 @@ console.log('\nNode.js server for Linny-R version', VERSION_NUMBER);
 console.log('Node.js version:', process.version);
 console.log('Platform:', PLATFORM, '(' + os.type() + ')');
 console.log('Main directory:', MAIN_DIRECTORY);
+console.log('Working directory:', WORKING_DIRECTORY);
 
 // Only then require the Node.js modules that are not "built-in"
 
@@ -104,8 +106,6 @@ const SOLVER = new MILPSolver(SETTINGS, WORKSPACE);
 // Create launch script
 createLaunchScript();
 
-verifyScriptFiles();
-
 // Create the HTTP server
 const SERVER = http.createServer((req, res) => {
     const u = new URL(req.url, 'http://127.0.0.1:' + SETTINGS.port);
@@ -831,11 +831,11 @@ function receiver(res, sp) {
   let
       rpath = anyOSpath(sp.get('path') || ''),
       rfile = anyOSpath(sp.get('file') || '');
-  // Assume that path is relative tochannel directory unless it starts with
+  // Assume that path is relative to channel directory unless it starts with
   // a (back)slash or specifiess drive or volume
   if(!(rpath.startsWith(path.sep) || rpath.indexOf(':') >= 0 ||
-      rpath.startsWith(MAIN_DIRECTORY))) {
-    rpath = path.join(MAIN_DIRECTORY, rpath);
+      rpath.startsWith(WORKING_DIRECTORY))) {
+    rpath = path.join(WORKING_DIRECTORY, rpath);
   }
   // Verify that the channel path exists
   try {
@@ -1321,7 +1321,7 @@ function commandLineSettings() {
       preferred_solver: '',
       solver: '',
       solver_path: '',
-      user_dir: path.join(MAIN_DIRECTORY, 'user')
+      user_dir: path.join(WORKING_DIRECTORY, 'user')
     };
   for(let i = 2; i < process.argv.length; i++) {
     const lca = process.argv[i].toLowerCase();
@@ -1410,9 +1410,9 @@ function commandLineSettings() {
           'WARNING: Failed to access the Gurobi command line application');
     }
   }
-  // Check if lp_solve(.exe) exists in main directory
+  // Check if lp_solve(.exe) exists in working directory
   const
-      sp = path.join(MAIN_DIRECTORY,
+      sp = path.join(WORKING_DIRECTORY,
           'lp_solve' + (PLATFORM.startsWith('win') ? '.exe' : '')),
       need_lps = !settings.solver || settings.preferred_solver === 'lp_solve';
   try {
@@ -1518,24 +1518,26 @@ function createLaunchScript() {
       '# cd ',
       '',
       '# Then this command to launch the Linny-R server should work:',
-      'node server launch'
+      'node ' + path.join('node_modules', 'linny-r', 'server') + ' launch'
     ];
   let sp;
   if(PLATFORM.startsWith('win')) {
-    sp = path.join(MAIN_DIRECTORY, 'linny-r.bat');
+    sp = path.join(WORKING_DIRECTORY, 'linny-r.bat');
     lines[1] += 'C:\\path\\to\\main\\Linny-R\\directory';
   } else {
-    sp = path.join(MAIN_DIRECTORY, 'linny-r.command'); 
+    sp = path.join(WORKING_DIRECTORY, 'linny-r.command'); 
     lines[1] += '/path/to/main/Linny-R/directory';
   }
-  lines[2] = 'cd ' + MAIN_DIRECTORY;
+  lines[2] = 'cd ' + WORKING_DIRECTORY;
   try {
     try {
       fs.accessSync(sp);
     } catch(err) {
       // Only write the script content if the file it does not yet exist
       console.log('Creating launch script:', sp);
-      fs.writeFileSync(sp, lines.join(os.EOL), 'utf8');
+      let code = lines.join(os.EOL);
+      if(PLATFORM.startsWith('win')) code = code.replace('#', '::');
+      fs.writeFileSync(sp, code, 'utf8');
     }
   } catch(err) {
     console.log('WARNING: Failed to create launch script');

package/static/index.html

@@ -51,13 +51,15 @@ SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
 -->
 
   <link rel="shortcut icon" type="image/png" href="images/icon.png">
+  <!-- NOTE: do not display the page until after software update check -->
+  <style>body { display: none; }</style>
   <script>
     var
       // NODE = false indicates that modules need not export their properties
       NODE = false,
       // Version number and release date
-      LINNY_R_VERSION = '1.1.0',
-      VERSION_RELEASE_DATE = '2022-09-14 17:00',
+      LINNY_R_VERSION = '1.1.2',
+      VERSION_RELEASE_DATE = '2022-10-11 10:25',
       // Linny-R server hosting public channels
       PUBLIC_LINNY_R_URL = 'https://sysmod.tbm.tudelft.nl/linny-r',
       // Create the XML parser
@@ -141,8 +143,6 @@ SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
     }
     
     function checkForUpdates() {
-      UI.check_update_modal.element('reload-btn').style.display = 'none';
-      UI.check_update_modal.element('restart-btn').style.display = 'none';
       fetch('auto-check')
         .then((response) => response.text())
         .then((data) => {

package/static/linny-r.css

@@ -218,8 +218,7 @@ main {
   padding: 2px;
   font: 7px sans-serif;
   font-style: oblique;
-  color: gray;
-  cursor: pointer;
+  color: #200030;
 }
 
 #topbar {