linny-r 1.6.8 → 1.7.1

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

@@ -260,7 +260,7 @@ class Controller {
     return VM.sig2Dig(n) + ' ' + 'kMGTP'.charAt(m) + 'B';
   }
   
-  // Shapes are only used to draw model diagrams
+  // Shapes are only used to draw model diagrams.
   
   createShape(mdl) {
     if(this.paper) return new Shape(mdl);
@@ -275,7 +275,7 @@ class Controller {
     if(shape) shape.removeFromDOM();
   }
 
-  // Methods to ensure proper naming of entities
+  // Methods to ensure proper naming of entities.
 
   cleanName(name) {
     // Returns `name` without the object-attribute separator |, backslashes,
@@ -429,7 +429,7 @@ class Controller {
 
   
   nameToID(name) {
-    // Returns a name in lower case with link arrow replaced by three
+    // Return a name in lower case with link arrow replaced by three
     // underscores, constraint link arrow by four underscores, and spaces
     // converted to underscores; in this way, IDs will always be valid
     // JavaScript object properties.
@@ -442,7 +442,7 @@ class Controller {
       // Empty string signals failure.
       return '';
     }
-    // NOTE: replace single quotes by Unicode apostrophe so that they
+    // NOTE: Replace single quotes by Unicode apostrophe so that they
     // cannot interfere with JavaScript strings delimited by single quotes.
     return name.toLowerCase().replace(/\s/g, '_').replace("'", '\u2019');
   }
@@ -485,8 +485,8 @@ class Controller {
   // Methods to notify modeler
   
   setMessage(msg, type, cause=null) {
-    // Only log errors and warnings on the browser console
-    // NOTE: optionally, the JavaScript error can be passed via `cause`
+    // Only log errors and warnings on the browser console.
+    // NOTE: Optionally, the JavaScript error can be passed via `cause`.
     if(type === 'error' || type === 'warning') {
       // Add type unless message already starts with it
       type = type.toUpperCase() + ':';
@@ -547,8 +547,8 @@ class Controller {
   }
   
   postResponseOK(text, notify=false) {
-    // Checks whether server reponse text is warning or error, and notifies
-    // the modeler if second argument is TRUE
+    // Check whether server reponse text is warning or error, and notify
+    // the modeler if second argument is TRUE.
     let mtype = 'notification';
     if(text.startsWith('ERROR:')) {
       mtype = 'error';
@@ -563,20 +563,20 @@ class Controller {
   }
   
   loginPrompt() {
-    // The VM needs credentials - his should only occur for the GUI
+    // The VM needs credentials - his should only occur for the GUI.
     console.log('WARNING: VM needs credentials, but GUI not active');
   }
 
   resetModel() {
-    // Resets the Virtual Machine (clears solution) 
+    // Reset the Virtual Machine (clears solution). 
     VM.reset();
-    // Redraw model in the browser (GUI only)
+    // Redraw model in the browser (GUI only).
     MODEL.clearSelection();
     this.drawDiagram(MODEL);
   }
   
   stopSolving() {
-    // Notify user only if VM was halted
+    // Notify user only if VM was halted.
     if(VM.halted) {
       this.notify('Solver HALTED');
     } else {
@@ -585,8 +585,9 @@ class Controller {
   }
   
   // NOTE: The following UI functions are implemented as "dummy" methods
-  // because they are called by the Virtual Machine and/or by other controllers
-  // while they can only be meaningfully performed by the GUI controller
+  // because they are called by the Virtual Machine and/or by other
+  // controllers while they can only be meaningfully performed by the
+  // GUI controller.
   addListeners() {}
   readyToReset() {}
   updateScaleUnitList() {}
@@ -616,27 +617,27 @@ class RepositoryBrowser {
     this.repositories = [];
     this.repository_index = -1; 
     this.module_index = -1;
-    // Get the repository list from the server
+    // Get the repository list from the server.
     this.getRepositories();
     this.reset();
   }
   
   reset() {
     this.visible = false;
-    // NOTE: do NOT reset repository list or module index, because:
-    // (1) they are properties of the local host, and hence model-independent
+    // NOTE: Do NOT reset repository list or module index, because:
+    // (1) they are properties of the local host, and hence model-independent;
     // (2) they must be known when loading a module as model, whereas the
-    //     loadingModel method hides and resets all stay-on-top dialogs
+    //     loadingModel method hides and resets all stay-on-top dialogs.
   }
 
   get isLocalHost() {
-    // Returns TRUE if first repository on the list is 'local host'
+    // Return TRUE if first repository on the list is 'local host'.
     return this.repositories.length > 0 &&
       this.repositories[0].name === 'local host';
   }
 
   getRepositories() {
-    // Gets the list of repository names from the server
+    // Get the list of repository names from the server.
     this.repositories.length = 0;
     fetch('repo/', postData({action: 'list'}))
       .then((response) => {
@@ -647,14 +648,14 @@ class RepositoryBrowser {
         })
       .then((data) => {
           if(UI.postResponseOK(data)) {
-            // NOTE: trim to prevent empty name strings
+            // NOTE: Trim to prevent empty name strings.
             const rl = data.trim().split('\n');
             for(let i = 0; i < rl.length; i++) {
               this.addRepository(rl[i].trim());
             }
           }
-          // NOTE: set index to first repository on list (typically local host)
-          // unless the list is empty
+          // NOTE: Set index to first repository on list (typically the
+          // local host repository) unless the list is empty.
           this.repository_index = Math.min(0, this.repositories.length - 1);
           this.updateDialog();
         })
@@ -662,7 +663,7 @@ class RepositoryBrowser {
   }
   
   repositoryByName(n) {
-    // Returns the repository having name `n` if already known, otherwise NULL
+    // Return the repository having name `n` if already known, or NULL.
     for(let i = 0; i < this.repositories.length; i++) {
       if(this.repositories[i].name === n) {
         return this.repositories[i];
@@ -672,8 +673,8 @@ class RepositoryBrowser {
   }
   
   asFileName(s) {
-    // Returns string `s` with whitespace converted to a single dash, and
-    // special characters converted to underscores
+    // Return string `s` with whitespace converted to a single dash, and
+    // special characters converted to underscores.
     return s.normalize('NFKD').trim()
         .replace(/[\s\-]+/g, '-')
         .replace(/[^A-Za-z0-9_\-]/g, '_')
@@ -681,12 +682,13 @@ class RepositoryBrowser {
   }
   
   loadModuleAsModel() {
-    // Loads selected module as model
+    // Load selected module as model.
     if(this.repository_index >= 0 && this.module_index >= 0) {
-      // NOTE: when loading new model, the stay-on-top dialogs must be reset
+      // NOTE: When loading new model, the stay-on-top dialogs must be
+      // reset (GUI only; for console this is a "dummy" method).
       UI.hideStayOnTopDialogs();
       const r = this.repositories[this.repository_index];
-      // NOTE: pass FALSE to indicate "no inclusion; load XML as model"
+      // NOTE: pass FALSE to indicate "no inclusion; load XML as model".
       r.loadModule(this.module_index, false);
     }
   }
@@ -1289,6 +1291,8 @@ class ExperimentManager {
       // Only now compute the simulation run time (number of time steps)
       xr.time_steps = MODEL.end_period - MODEL.start_period + 1;
       VM.callback = this.callback;
+      // NOTE: Asynchronous call. All follow-up actions must be performed
+      // by the callback function.
       VM.solveModel();
     }
   }
@@ -1315,11 +1319,11 @@ class ExperimentManager {
   }
 
   processRestOfRun() {   
-    // Performs post-processing after run results have been added.
+    // Perform post-processing after run results have been added.
     const x = MODEL.running_experiment;
     if(!x) return;
     const aci = x.active_combination_index;
-    // Always add solver messages
+    // Always add solver messages.
     x.runs[aci].addMessages();
     const n = x.combinations.length;
     if(!VM.halted && aci < n - 1 && aci != x.single_run) {
@@ -1330,8 +1334,8 @@ class ExperimentManager {
       } else {
         x.active_combination_index++;
         let delay = 5;
-        // NOTE: when executing a remote command, wait for 1 second to
-        // allow enough time for report writing
+        // NOTE: When executing a remote command, wait for 1 second to
+        // allow enough time for report writing.
         if(RECEIVER.active && RECEIVER.experiment) {
           UI.setMessage('Reporting run #' + (x.active_combination_index - 1));
           delay = 1000;
@@ -1352,8 +1356,8 @@ class ExperimentManager {
             `Experiment <em>${x.title}</em> terminated during run #${aci}`);
         RECEIVER.deactivate();
       }
-      // No more runs => stop experiment, and perform call-back
-      // NOTE: if call-back is successful, the receiver will resume listening
+      // No more runs => stop experiment, and perform call-back.
+      // NOTE: If call-back is successful, the receiver will resume listening.
       if(RECEIVER.active) {
         RECEIVER.experiment = '';
         RECEIVER.callBack();
@@ -1363,34 +1367,35 @@ class ExperimentManager {
       MODEL.parseSettings(x.original_model_settings);
       MODEL.round_sequence = x.original_round_sequence;
       // Reset the Virtual Machine so t=0 at the status line,
-      // and ALL expressions are reset as well
+      // and ALL expressions are reset as well.
       VM.reset();
       this.readyButtons();
     }
     this.drawTable();
-    // Reset the model, as results of last run will be showing still
+    // Reset the model, as results of last run will be showing still.
     UI.resetModel();
     CHART_MANAGER.resetChartVectors();
-    // NOTE: clear chart only when done (charts do not update during experiment)
+    // NOTE: Clear chart only when done; charts do not update when an
+    // experiment is running.
     if(!MODEL.running_experiment) CHART_MANAGER.updateDialog();
   }
 
   stopExperiment() {
-    // Interrupt solver but retain data on server (and no resume)
+    // Interrupt solver but retain data on server (and no resume).
     VM.halt(); 
   }
   
   showProgress(ci, p, n) {
-    // Report progress on the console
+    // Report progress on the console.
     console.log('\nRun', ci, `(${p}% of ${n})`);
   }
 
   resumeButtons() {
-    // Console experiments cannot be paused, and hence not resumed
+    // Console experiments cannot be paused, and hence not resumed.
     return false;
   }
 
-  // Dummy methods: actions that are meaningful only for the graphical UI
+  // Dummy methods: actions that are meaningful only for the graphical UI.
   drawTable() {}
   readyButtons() {}
   pausedButtons() {}

package/static/scripts/linny-r-gui-controller.js

@@ -449,7 +449,7 @@ class GUIController extends Controller {
     // not to other dialog objects.
     const main_modals = ['logon', 'model', 'load', 'password', 'settings',
         'actors', 'add-process', 'add-product', 'move', 'note', 'clone', 
-        'replace', 'expression'];
+        'replace', 'expression', 'server', 'solver'];
     for(let i = 0; i < main_modals.length; i++) {
       this.modals[main_modals[i]] = new ModalDialog(main_modals[i]);
     }
@@ -581,8 +581,10 @@ class GUIController extends Controller {
       // NOTE: When user name is specified, solver is not on local host.
       const hl = document.getElementById('host-logo');
       hl.classList.add('local-server');
-      hl.addEventListener('click', () => UI.shutDownServer());
+      hl.addEventListener('click', () => UI.showServerModal());
     }
+    this.server_modal = new ModalDialog('server');
+    
 
     // Vertical tool bar buttons:
     this.buttons.clone.addEventListener('click',
@@ -704,10 +706,27 @@ class GUIController extends Controller {
             // Ensure that model documentation can no longer be edited.
             DOCUMENTATION_MANAGER.clearEntity([MODEL]);
           });
-    // Make the scale units button of the settings dialog responsive.
+    // Make the scale units and solver preferences buttons of the settings
+    // dialog responsive. Clicking will open these dialogs on top of the
+    // settings modal dialog.
     this.modals.settings.element('scale-units-btn').addEventListener('click',
-        // Open the scale units modal dialog on top of the settings dialog.
         () => SCALE_UNIT_MANAGER.show());
+    this.modals.settings.element('solver-prefs-btn').addEventListener('click',
+        () => UI.showSolverPreferencesDialog());
+    // Make solver modal elements responsive.
+    this.modals.solver.ok.addEventListener('click',
+        () => UI.updateSolverPreferences());
+    this.modals.solver.cancel.addEventListener('click',
+        () => UI.modals.solver.hide());
+    // Make server modal elements responsive.
+    this.modals.server.ok.addEventListener('click',
+        () => UI.changeSolver(UI.modals.server.element('solver').value));
+    this.modals.server.cancel.addEventListener('click',
+        () => UI.modals.server.hide());
+    this.modals.server.element('update').addEventListener('click',
+        () => UI.shutDownToUpdate());
+    this.modals.server.element('shut-down').addEventListener('click',
+        () => UI.shutDownServer());
 
     // Modals related to vertical toolbar buttons.
     this.modals['add-process'].ok.addEventListener('click',
@@ -796,7 +815,7 @@ class GUIController extends Controller {
     
     // The REPLACE dialog appears when a product is Ctrl-clicked.
     this.modals.replace.ok.addEventListener('click',
-        () => UI.replaceProduct());
+        () => UI.replaceProduct()); 
     this.modals.replace.cancel.addEventListener('click',
         () => UI.modals.replace.hide());
     
@@ -871,21 +890,25 @@ class GUIController extends Controller {
   }
 
   loadModelFromXML(xml) {
-    // Parses `xml` and updates the GUI 
+    // Parse `xml` and update the GUI.
     const loaded = MODEL.parseXML(xml);
-    // If not a valid Linny-R model, ensure that the current model is clean 
+    // If not a valid Linny-R model, ensure that the current model is clean.
     if(!loaded) MODEL = new LinnyRModel();
+    // If model specifies a preferred solver, immediately try to switch.
+    if(MODEL.preferred_solver !== VM.solver_name) {
+      UI.changeSolver(MODEL.preferred_solver);
+    }
     this.updateScaleUnitList();
     this.drawDiagram(MODEL);
-    // Cursor may have been set to `waiting` when decrypting
+    // Cursor may have been set to `waiting` when decrypting.
     this.normalCursor();
     this.setMessage('');
     this.updateButtons();
     // Undoable operations no longer apply!
     UNDO_STACK.clear();
-    // Autosaving should start anew
+    // Autosaving should start anew.
     AUTO_SAVE.setAutoSaveInterval();
-    // Signal success or failure
+    // Signal success or failure.
     return loaded;
   }
   
@@ -899,15 +922,15 @@ class GUIController extends Controller {
     MODEL.clearSelection();
     this.paper.drawModel(MODEL);
     this.updateButtons();
-    // NOTE: when "moving up" in the cluster hierarchy, bring the former focal
-    // cluster into view
+    // NOTE: When "moving up" in the cluster hierarchy, bring the former
+    // focal cluster into view.
     if(fc.cluster == MODEL.focal_cluster) {
       this.scrollIntoView(fc.shape.element.childNodes[0]);
     }
   }
   
   drawDiagram(mdl) {
-    // "Queue" a draw request (to avoid redrawing too often)
+    // "Queue" a draw request (to avoid redrawing too often).
     if(this.busy_drawing) {
       this.draw_requests += 1;
     } else {
@@ -953,19 +976,81 @@ class GUIController extends Controller {
       if(a.links.indexOf(link) >= 0) this.paper.drawArrow(a);
     }    
   }
+  
+  showServerModal() {
+    // Prepare and show the server modal dialog.
+    const
+        md = this.modals.server,
+        host = md.element('host-div'),
+        sd = md.element('solver-div'),
+        nsd = md.element('no-solver-div'),
+        html = [];
+    host.innerText = 'Server on ' + VM.server;
+    if(VM.server === 'local host') {
+      host.title = 'Linny-R directory is ' + VM.working_directory;
+    }
+    for(let i = 0; i < VM.solver_list.length; i++) {
+      const s = VM.solver_list[i];
+      html.push(['<option value="', s,
+          (s === VM.solver_name ? '"selected="selected' : ''),
+          '">', VM.solver_names[s], '</option>'].join(''));
+    }
+    md.element('solver').innerHTML = html.join('');
+    if(html.length) {
+      sd.style.display = 'block';
+      nsd.style.display = 'none';
+    } else {
+      sd.style.display = 'none';
+      nsd.style.display = 'block';
+    }
+    md.show();
+  }
+  
+  changeSolver(sid) {
+    // Change preferred solver to `sid` if specified.
+    if(!sid) return;
+    const
+        md = this.modals.server,
+        mps = MODEL.preferred_solver;
+    md.hide();
+    if(mps && mps !== sid) {
+      UI.warn('Model setttings designate ' + VM.solver_names[mps] +
+          ' as preferred solver');
+      return;
+    }
+    const pd = postData({action: 'change', solver: sid});
+    fetch('solver/', pd)
+      .then((response) => {
+          if(!response.ok) {
+            UI.alert(`ERROR ${response.status}: ${response.statusText}`);
+          }
+          return response.text();
+        })
+      .then((data) => {
+          if(UI.postResponseOK(data, true)) {
+            VM.solver_name = sid;
+            UI.modals.server.hide();
+          }
+        })
+      .catch((err) => {
+          UI.warn(UI.WARNING.NO_CONNECTION, err);
+        });
+  }
 
   shutDownServer() {
     // This terminates the local host server script and display a plain
     // HTML message in the browser with a restart button.
+    this.modals.server.hide();
     if(!SOLVER.user_id) window.open('./shutdown', '_self');
   }
 
   shutDownToUpdate() {
-    // Sisgnal server that an update is required. This will close the
+    // Signal server that an update is required. This will close the
     // local host Linny-R server. If this server was started by the
     // standard OS batch script, this script will proceed to update
     // Linny-R via npm and then restart the server again. If not, the
     // fetch request will time out, anf the user will be warned.
+    this.modals.server.hide();
     if(SOLVER.user_id) return;
     fetch('update/')
       .then((response) => {
@@ -1023,6 +1108,8 @@ class GUIController extends Controller {
                 `Linny-R version ${m[1]} has been installed.`,
                 'To continue, you must reload this page, and',
                 'confirm when prompted by your browser.');
+              // Hide "update" button in server dialog.
+              UI.modals.server.element('update').style.display = 'none';
             } else {
               // Inform user that install appears to have failed.
               msg.push(
@@ -1047,6 +1134,10 @@ class GUIController extends Controller {
   preventUpdate() {
     // Signal server that no update is required. 
     if(SOLVER.user_id) return;
+    // Show "update" button in server dialog to permit updating later.
+    const btn = this.modals.server.element('update');
+    btn.innerText = 'Update Linny-R to version ' + this.newer_version;
+    btn.style.display = 'block';
     fetch('no-update/')
       .then((response) => {
           if(!response.ok) {
@@ -2591,7 +2682,7 @@ class GUIController extends Controller {
     }
     // Display text only if previous message has "timed out" or was less
     // urgent than this one.
-    if(mti > lmti || dt >= this.message_display_time) {
+    if(lmti < 0 || mti > lmti || dt >= this.message_display_time) {
       this.time_last_message = t;
       this.last_message_type = type;
       if(type) SOUNDS[type].play().catch(() => {
@@ -3521,6 +3612,53 @@ console.log('HERE name conflicts', name_conflicts, mapping);
     if(redraw) this.drawDiagram(model);
   }
   
+  // Solver preferences modal
+  
+  showSolverPreferencesDialog() {
+    const
+        md = this.modals.solver,
+        html = ['<option value="">(default)</option>'];
+    for(let i = 0; i < VM.solver_list.length; i++) {
+      const s = VM.solver_list[i];
+      html.push(['<option value="', s,
+          (s === MODEL.preferred_solver ? '"selected="selected' : ''),
+          '">', VM.solver_names[s], '</option>'].join(''));
+    }
+    md.element('preference').innerHTML = html.join('');
+    md.element('int-feasibility').value = MODEL.integer_tolerance;
+    md.element('mip-gap').value = MODEL.MIP_gap;
+    md.show();
+  }
+  
+  updateSolverPreferences() {
+    // Set values for solver preferences.
+    const
+        md = this.modals.solver,
+        it = md.element('int-feasibility'),
+        mg = md.element('mip-gap');
+    let itol = 5e-7,
+        mgap = 1e-4;
+    // Validate input, assuming default values for empty fields.
+    if(it.value.trim()) itol = UI.validNumericInput('solver-int-feasibility',
+        'integer feasibility tolerance');
+    if(itol === false) return false;
+    if(mg.value.trim()) mgap = UI.validNumericInput('solver-mip-gap',
+        'relative MIP gap');
+    if(mgap === false) return false;
+    // Modify solver preferences for the current model.
+    const ps = md.element('preference').value;
+    if(ps !== MODEL.preferred_solver) {
+      MODEL.preferred_solver = ps;
+      // Immediately try to change to the preferred solver, as this is
+      // an asynchronous call that may take time to complete.
+      UI.changeSolver(ps);
+    }
+    MODEL.integer_tolerance = Math.max(1e-9, Math.min(0.1, itol));
+    MODEL.MIP_gap = Math.max(0, Math.min(0.5, mgap));
+    // Close the dialog.
+    md.hide();
+  }
+  
   // Note modal
 
   showNotePropertiesDialog(n=null) {

package/static/scripts/linny-r-gui-monitor.js

@@ -326,13 +326,13 @@ class GUIMonitor {
           } else if(jsr.server) {
             VM.solver_token = jsr.token;
             VM.solver_name = jsr.solver;
-            // Remote solver may indicate user-specific solver time limit
+            // Remote solver may indicate user-specific solver time limit.
             let utl = '';
             if(jsr.time_limit) {
               VM.max_solver_time = jsr.time_limit;
               utl = ` -- ${VM.solver_name} solver: ` +
                   `max. ${VM.max_solver_time} seconds per block`;
-              // If user has a set time limit, no restrictions on tableau size
+              // If user has a set time limit, no restrictions on tableau size.
               VM.max_tableau_size = 0;
             }
             UI.notify('Logged on to ' + jsr.server + utl);
@@ -346,12 +346,15 @@ class GUIMonitor {
   }
 
   connectToServer() {
-    // Prompts for credentials if not connected yet
-    // NOTE: no authentication prompt if SOLVER.user_id in `linny-r-config.js`
-    // is left blank
+    // Prompts for credentials if not connected yet.
+    // NOTE: No authentication prompt if SOLVER.user_id in `linny-r-config.js`
+    // is left blank.
     if(!VM.solver_user) {
+      VM.connected = false;
       VM.solver_token = 'local host';
-      fetch('solver/', postData({action: 'logon'}))
+      fetch('solver/', postData({
+            action: 'logon',
+            solver: MODEL.preferred_solver || VM.solver_name}))
         .then((response) => {
             if(!response.ok) {
               UI.alert(`ERROR ${response.status}: ${response.statusText}`);
@@ -362,10 +365,15 @@ class GUIMonitor {
             try {
               const
                   jsr = JSON.parse(data),
-                  svr = `Solver on ${jsr.server} is ${jsr.solver}`;
-              if(jsr.solver !== VM.solver_name) UI.notify(svr);              
+                  sname = VM.solver_names[jsr.solver] || 'unknown',
+                  svr = `Solver on ${jsr.server} is ${sname}`;
+              if(jsr.solver !== VM.solver_name) UI.notify(svr);
+              VM.server = jsr.server;
+              VM.working_directory = jsr.path;
               VM.solver_name = jsr.solver;
+              VM.solver_list = jsr.solver_list;
               document.getElementById('host-logo').title  = svr;
+              VM.connected = true;
             } catch(err) {
               console.log(err, data);
               UI.alert('ERROR: Unexpected data from server: ' +
@@ -381,6 +389,7 @@ class GUIMonitor {
   }
 
   submitBlockToSolver() {
+    // Post MILP model plus relevant metadata to the server.
     let top = MODEL.timeout_period;
     if(VM.max_solver_time && top > VM.max_solver_time) {
       top = VM.max_solver_time;
@@ -398,7 +407,10 @@ UI.logHeapSize(`BEFORE creating post data`);
             round: VM.round_sequence[VM.current_round],
             columns: VM.columnsInBlock,
             data: VM.lines,
-            timeout: top
+            solver: MODEL.preferred_solver,
+            timeout: top,
+            inttol: MODEL.integer_tolerance,
+            mipgap: MODEL.MIP_gap
           });
 UI.logHeapSize(`AFTER creating post data`);
     // Immediately free the memory taken up by VM.lines