linny-r 2.0.2 → 2.0.4

package/README.md

@@ -56,7 +56,7 @@ in a cloud.
 
 In this installation guide, the path to this directory is denoted by `Linny-R`,
 so in all commands you should replace this with the actual directory path.
-On a Windows machine the suggested path is `C:\Users\(your user name)\Documents\Linny-R`,
+On a Windows machine the suggested path is `C:\Users\(your user name)\Linny-R`,
 and on a macOS machine `/Users/(your user name)/Linny-R`.
 
 To install Linny-R in this directory, first change to the parent directory
@@ -104,20 +104,50 @@ Linny-R
 
 `Linny-R` should contain two JSON files `package.json` and `package-lock.json`
 that should **not** be removed, or you will have to re-install Linny-R.
+It should also contain the launch script.  On a macOS machine, this will be
+the shell script `linny-r.command`, on a Windows machine the batch script
+`linny-r.bat`.
+
+All other software is contained in the `node_modules` directory. It comprises
+two Node.js packages: `@xlmdom` and `linny-r`. 
 
-The `linny-r` directory should also contain this file `README.md`,
-the files `server.js` and `console.js` that will be run by Node.js,
-and the sub-directory `static`. This `static` directory should contain three
-HTML files: 
+The `linny-r` package 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`. 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 betwee two Linny-R models)
+* `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.
 
 The sub-directories of `static` contain files that are served to the browser
-by the script `server.js` when it is running in Node.js. 
+by the script `server.js` when it is running in Node.js.
+
+> [!IMPORTANT]
+> Unless you _really_ know what you are doing, do **not** move or rename
+> your Linny-R directory or change its contents. If for some reason Linny-R
+> does not work, remove _all_ Linny-R software from your machine, and then
+> install it anew, following the procedure described above.
+
+#### Updating to the latest version of Linny-R
+
+When a newer version has beeh released, Linny-R will prompt you to update
+automatically. Click on the link in this prompt to see the release notes
+on GitHub and find out about new features and bug fixes. When you click on
+the _OK_ button, Linny-R will shut down its local server script, and then
+the launch script should perform the `npm update` command and then restart
+the server script. Your browser will prompt you to close its current tab,
+and then Linny-R should reappear in a new browser tab or window.
+
+> [!NOTE]
+> The built-in updating function of Linny-R will _**not**_ automatically
+> upgrade to a new _major_ version. To update from a version like 1.9.x to
+> a version like 2.0.x, you have to open a command line interface
+> (`Command Prompt` or `Terminal`), change to your Linny-R directory, and
+> then type `npm install linny-r@2`. This should perform the upgrade.
+> You can then launch Linny-R as usual by typing `linny-r` (Windows) or
+> `./linny-r.command` (macOS).
 
 #### Installing and using an earlier version of Linny-R
 
@@ -234,7 +264,7 @@ as this is where Linny-R will look for it when it does not find one of the
 other solvers.
 
 On a macOS machine, you must then make the file `lp_solve` executable.
-Open Terminal and change to your Linny-R directory, and then type:
+Open `Terminal` and change to your Linny-R directory, and then type:
 
 ``chmod +x lp_solve``
 
@@ -243,37 +273,36 @@ When you then type:
 ``./lp_solve -h``
 
 a window may appear that warns you that the software may be malicious.
-To allow running LP_solve, you must then go to Security & Privacy (via
-System Preferences) and there click the Open Anyway button in the General
-pane to confirm that you wish to use LP_solve. Then return to Terminal
+To allow running LP_solve, you must then go to _Security & Privacy_ (via
+_System Preferences_) and there click the _Open Anyway_ button in the _General_
+pane to confirm that you wish to use LP_solve. Then return to `Terminal`
 and once more type `./lp_solve -h`. The response should then be a listing
 of all the command line options of LP_solve. 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, change to your
-Linny-R directory and type:
+On a Windows machine, open `Command Prompt`, change to your Linny-R
+directory and type:
 
-``node node_modules/linny-r/server launch``
+``linny-r``
 
-This response should be something similar to:
+On a macOS machine, open `Terminal`, change to your Linny-R directory
+and type:
 
-<pre>
-Node.js server for Linny-R version 2.0.0
-Node.js version: v22.2.0
-... etc.
-</pre>
+``./linny-r.command``
 
+This should run the launch script for Linny-R, which will start the
+local server script that connects your browser with the solver. 
 Meanwhile, your default web browser should have opened a tab for the local
 server URL, which by default will be http://127.0.0.1:5050.
 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>
-[2023-11-19 22:55:17] Static file: /index.html
-[2023-11-19 22:55:17] Static file: /scripts/iro.min.js
-[2023-11-19 22:55:17] Static file: /images/open.png
+[2024-06-11 22:55:17] Static file: /index.html
+[2024-06-11 22:55:17] Static file: /scripts/iro.min.js
+[2024-06-11 22:55:17] Static file: /images/open.png
 ... etc.
 </pre>
 
@@ -281,7 +310,7 @@ should see a long series of server log messages like:
 > Do **not** close the CLI. If you do, the Linny-R GUI may still be
 > visible in your browser, but you will be warned that it cannot connect
 > to the server (at 127.0.0.1:5050). This means that you have to restart
-> Linny-R from a new CLI.
+> Linny-R as described above.
 
 After loading into the browser, Linny-R will try to connect to the solver.
 If successful, a notification (blue background) will appear on the status
@@ -313,36 +342,18 @@ confirming that you want to leave, and then closing your browser (tab).
 If you do not shut down the server from the browser, you can also stop the
 server by repeatedly pressing ``Ctrl+C`` in the CLI.
 
-## 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, MOSEK, CPLEX, SCIP, LP_solve)
-workspace=[path]   to overrule the default path for the user directory
-</pre>
-
 ## Click-start for Linny-R
 
-The first time you start Linny-R after a fresh install or an update,
-you will have to open the Command Line Interface (CLI) of your computer,
-change to your Linny-R directory and type:
+When `npm` installs the Linny-R package, it creates a script file in your
+Linny-R directory that launches Linny-R. On a macOS machine, this will be
+the shell script `linny-r.command`, on a Windows machine the batch script
+`linny-r.bat`. When you create a desktop shortcut to this script, this will
+allow you to click-start Linny-R. 
 
-``node node_modules/linny-r/server launch``
+How you can create a shortcut icon for Linny-R on your desktop depends on
+the type of computer you use.
 
-This will not only start Linny-R, but also create a script file in your
-Linny-R directory that will allow you to start Linny-R by clicking its
-icon on your machine. On a macOS machine, this fill will be the shell
-script `linny-r.command`, on a Windows machine the batch script
-`linny-r.bat`.
-
-To facilitate start-up, you can create a shortcut icon for Linny-R on your
-desktop.
-
-On a Windows machine, open the _File Explorer_, select your Linny-R folder,
+On a Windows machine, open the `File Explorer`, select 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
@@ -350,22 +361,35 @@ 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.
 
-On a macOS machine, open Terminal and change to your Linny-R directory,
+On a macOS machine, open `Terminal` and change to your Linny-R directory,
 and then type:
 
 ``chmod +x linny-r.command``
 
-to make the script file executable. To set the icon, use Finder to open
+to make the script file executable. To set the icon, use `Finder` to open
 the folder that contains the file `linny-r.command`, click on its icon
 (which still is plain) and open the _Info dialog_ by pressing ``Cmd+I``.
-Then open your Linny-R folder in Finder, change to the sub-folder
+Then open your Linny-R folder in `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_.
 
+## Command line options
+
+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)
+workspace=[path]   to overrule the default path for the user directory
+</pre>
+
 > [!NOTE]
 > 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 this script file, adding the argument `workspace=path/to/workspace`
+> each have their personal work space (e.g., a virtual drive U:), you **must**
+> edit the launch 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.
 
@@ -380,6 +404,8 @@ The sub-directories of this directory `user` are used by Linny-R to store files.
   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_
 * `reports` will contain text files with time series data and statistics in
   tab-separated format that can be imported or copy/pasted into Excel

package/package.json

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

package/server.js

@@ -255,22 +255,24 @@ function clearNewerVersion() {
 }
 
 // HTML page to show when the server is shut down by the user.
-// NOTE: on a macOS machine, this is slightly more work
-const OS_TEXT = {close: '', reopen: ''};
-if(PLATFORM === 'darwin') {
-  OS_TEXT.close =
-`<p>You can close the <em>Terminal</em> window that shows
-  <tt>[Process Terminated]</tt> at the bottom.
-</p>`;
-  OS_TEXT.reopen =
-`open <em>Terminal</em> again, change to your Linny-R directory by typing:
+// Parts of the text are platform-specific.
+const
+    macOS = (PLATFORM === 'darwin'),
+    close = (macOS ?
+        `<p>You can now close the <em>Terminal</em> window that shows
+         <tt>[Process Terminated]</tt> at the bottom.</p>` :
+        `<p>The <em>Command Prompt</em> window where the server was
+         running will be closed automatically.</p>`),
+    cli = (macOS ? 'Terminal' : 'Command Prompt'),
+    ext = (macOS ? '.command' : ''),
+    chmod = (!macOS ? '' : `
+<p>If launch fails, you may still need to make the script executable.</p>
+<p>
+  You can do this by typing <code>chmod +x linny-r.command</code>
+  at the command prompt.
 </p>
-<p><code>cd ${WORKING_DIRECTORY}</code></p>
-<p>`;
-} else {
-  OS_TEXT.reopen = 'switch to your <em>Command Prompt</em> window ';
-}
-const SHUTDOWN_MESSAGE = `<!DOCTYPE html>
+<p>Then retype <code>linny-r.command</code> to launch Linny-R.</p>`),
+    SHUTDOWN_MESSAGE = `<!DOCTYPE html>
 <html lang="en-US">
 <head>
   <meta http-equiv="content-type" content="text/html; charset=UTF-8">
@@ -290,16 +292,18 @@ const SHUTDOWN_MESSAGE = `<!DOCTYPE html>
   </style>
 </head>
 <body>
-  <h3>Linny-R server (127.0.0.1) is shutting down</h3>${OS_TEXT.close}
-  <p>To restart Linny-R, ${OS_TEXT.reopen} and then at the prompt type:</p>
-  <p><code>node node_modules${path.sep}linny-r${path.sep}server</code></p>
+  <h3>Linny-R server (127.0.0.1) is shutting down</h3>${close}
   <p>
-    Then switch back to this window, and click this
-    <button type="button"
-      onclick="window.location.href = 'http://127.0.0.1:${SETTINGS.port}';">
-      Restart
-    </button> button.
+    To restart Linny-R, open <em>${cli}</em> again, change to
+    your Linny-R directory by typing:
   </p>
+  <p><code>cd ${WORKING_DIRECTORY}</code></p>
+  <p>and then type:</p>
+  <p><code>linny-r${ext}</code></p>
+  <p>
+    This should launch Linny-R in a new browser window or tab, so you
+    can close this one.
+  </p>${chmod}
 </body>
 </html>`;
 

package/static/scripts/linny-r-vm.js

@@ -9006,13 +9006,15 @@ function VMI_add_bound_line_constraint(args) {
       vy = VM.variables[viy - 1],
       objy= vy[1],
       uby = args[5].result(VM.t),
-      bl = args[6],
+      bl = args[6];
+  // Set bound line point coordinates for current run and time step.
+  bl.setDynamicPoints(VM.t);
+  // Then use the actualized points.
+  const
       n = bl.points.length,
       x = new Array(n),
       y = new Array(n),
       w = new Array(n);
-  // Set bound line point coordinates for current run and time step.
-  bl.setDynamicPoints(VM.t);
   if(DEBUGGING) {
     console.log('add_bound_line_constraint:', bl.displayName);
   }