linny-r 1.1.2 → 1.1.4

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,32 +35,55 @@ 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, the path to this directory is denoted by `WORKING_DIRECTORY`,
-but on a Windows machine you may choose something like `C:\Users\xyz\Documents\Linny-R`,
+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`.
 
 To install Linny-R in this directory, type at the command line prompt: 
 
 ``npm install --prefix WORKING_DIRECTORY linny-r``
 
-WORKING_DIRECTORY should now contain a new sub-directory `node_modules`, 
+`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.
 
-After installation has been completed, `WORKING_DIRECTORY` will also have a sub-directory `user`
-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`. 
-
-When configuring Linny-R for a network environment
+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 can instruct Linny-R to create the `user` directory in this work space
-by adding the argument `workspace=[path]` to the `node` command that you use to start the Linny-R server.
+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 `node_modules` directory should contain two sub-directories: `@xmldom` and `linny-r`.
 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`. 
@@ -73,35 +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, `WORKING_DIRECTORY` should have this directory tree structure:
-
-<pre>
-WORKING_DIRECTORY
- |
- +- node_modules
- |
- +- 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
 
@@ -215,6 +211,20 @@ 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:

package/package.json

@@ -1,9 +1,10 @@
 {
   "name": "linny-r",
-  "version": "1.1.2",
+  "version": "1.1.4",
   "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,83 @@
+/*
+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'),
+    os = require('os'),
+    PLATFORM = os.platform(),
+    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
@@ -1535,7 +1535,9 @@ function createLaunchScript() {
     } 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

@@ -58,8 +58,8 @@ SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
       // 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

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 {