linny-r 2.0.9 → 2.0.10

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "linny-r",
-  "version": "2.0.9",
+  "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/static/index.html

@@ -1730,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">

package/static/linny-r.css

@@ -396,6 +396,28 @@ input[type="text"]:disabled {
   background-color: #f4f0f2;
 }
 
+td.same-not-changed {
+  color: #5060b0;  
+  background-color: #f4f8ff; 
+}
+
+td.not-same-not-changed {
+  color: #b06050;
+  background-color: #fff6f4; 
+}
+
+td.same-changed {
+  color: #0000e0;
+  background-color: #f4f8ff; 
+  text-shadow: 0px 0px 10px #00b0ff;
+}
+
+td.not-same-changed {
+  color: #e00000;
+  background-color: #fff6f4; 
+  text-shadow: 0px 0px 10px #ff6000;
+}
+
 input[type="text"].same-not-changed {
   color: #5060b0;
   background-color: #f4f8ff; 
@@ -426,10 +448,12 @@ select.not-same-not-changed {
 
 select.same-changed {
   color: #0000e0;  
+  text-shadow: 0px 0px 10px #00b0ff;
 }
 
 select.not-same-changed {
   color: #e00000;  
+  text-shadow: 0px 0px 10px #ff6000;
 }
 
 textarea {
@@ -685,6 +709,7 @@ img.inline-cancel-btn:hover {
 #actor-group,
 #constraint-group,
 #cluster-group,
+#datasetgroup-group,
 #link-group,
 #process-group,
 #product-group {
@@ -1910,6 +1935,7 @@ td.export {
 
 #actor-export,
 #dataset-export,
+#datasetgroup-export,
 #product-export {
   position: absolute;
   bottom: 10px;
@@ -1921,6 +1947,7 @@ td.export {
 
 #actor-import,
 #dataset-import,
+#datasetgroup-import,
 #product-import {
   position: absolute;
   bottom: 9px;
@@ -2607,6 +2634,7 @@ div.io-box {
 #power-grids-table,
 #dataset-table,
 #dataset-modif-table,
+#datasetgroup-modif-table,
 #equation-table,
 #experiment-table,
 #experiment-dim-table,
@@ -2647,6 +2675,7 @@ div.io-box {
 }
 
 #dataset-outcome.not-selected,
+#datasetgroup-outcome.not-selected,
 #equation-outcome.not-selected {
   filter: saturate(0) contrast(50%) brightness(170%);
 }
@@ -2703,7 +2732,8 @@ div.io-box {
   left: calc(40% + 3px);
 }
 
-#dataset-modif-buttons > img.btn {
+#dataset-modif-buttons > img.btn,
+#datasetgroup-modif-buttons > img.btn {
   height: 20px;
   width: 20px;
 }
@@ -2729,6 +2759,11 @@ tr.sel-set {
   background-color: #eff0ff;  
 }
 
+tr.sel-set > td,
+tr.dataset-modif:hover > td {
+  background-color: inherit !important;
+}
+
 tr.def-sel {
   color: #400090;
   font-weight: bold;
@@ -2931,11 +2966,13 @@ td.equation-expression-multi {
   color: #e0e0e0;
 }
 
-#dataset-blackbox.off {
+#dataset-blackbox.off,
+#datasetgroup-blackbox.off {
   color: #e0e0e0;
 }
 
-#dataset-blackbox.on {
+#dataset-blackbox.on,
+#datasetgroup-blackbox.on {
   color: #403848;
 }
 
@@ -2999,18 +3036,21 @@ td.equation-expression-multi {
 
 /* NOTE: New and Rename modals must be above boundline data modal */
 #new-selector-modal,
-#rename-selector-modal {
+#rename-selector-modal,
+#group-selector-modal {
   z-index: 102;
 }
 
 #new-selector-dlg,
-#rename-selector-dlg {
+#rename-selector-dlg,
+#group-selector-dlg {
   width: 215px;
   height: 45px;
 }
 
 #new-selector-name,
-#rename-selector-name {
+#rename-selector-name,
+#group-selector-name {
   position: absolute;
   bottom: 2px;
   left: 2px;
@@ -3018,7 +3058,8 @@ td.equation-expression-multi {
 }
 
 #new-selector-label,
-#rename-selector-label {
+#rename-selector-label,
+#group-selector-label {
   position: absolute;
   left: 110px;
   bottom: 5px;
@@ -5104,6 +5145,198 @@ img.finder {
   font-size: 12px;
 }
 
+/* the DATASET GROUP modal permits editing properties of multiple datasets */
+#datasetgroup-dlg {
+  width: 440px;
+  height: 190px;
+}
+
+#datasetgroup-prefix-lbl {
+  position: absolute;
+  top: 25px;
+  left: 2px;
+}
+
+#datasetgroup-prefix {
+  position: absolute;
+  top: 24px;
+  left: 38px;
+  width: 121px;
+  font-size: 12px;
+}
+
+#datasetgroup-default-lbl {
+  position: absolute;
+  top: 48px;
+  left: 2px;
+}
+
+#datasetgroup-default {
+  position: absolute;
+  top: 47px;
+  left: 79px;
+  width: 80px;
+  font-size: 12px;
+}
+
+#datasetgroup-unit-lbl {
+  position: absolute;
+  top: 71px;
+  left: 2px;
+}
+
+#datasetgroup-unit {
+  position: absolute;
+  top: 70px;
+  left: 32px;
+  width: 70px;
+  font-size: 12px;
+}
+
+#datasetgroup-periodic {
+  position: absolute;
+  top: 90px;
+  left: 0px;  
+}
+
+#datasetgroup-periodic-lbl {
+  position: absolute;
+  top: 92px;
+  left: 22px;  
+}
+
+#datasetgroup-array {
+  position: absolute;
+  top: 90px;
+  left: 77px; 
+}
+
+#datasetgroup-array-lbl {
+  position: absolute;
+  top: 92px;
+  left: 99px;  
+}
+
+#datasetgroup-no-time-msg {
+  position: absolute;
+  top: 111px;
+  left: 1px;
+  width: 164px;
+  height: 31px;
+  z-index: 1;
+  background-color: inherit;
+  font-style: italic;
+  padding-top: 15px;
+  text-align: center;
+  display: none;
+}
+
+#datasetgroup-time-step-lbl {
+  position: absolute;
+  top: 113px;
+  left: 2px;
+}
+
+#datasetgroup-time-scale {
+  position: absolute;
+  top: 112px;
+  left: 60px;
+  width: 50px;
+  font-size: 12px;
+}
+
+#datasetgroup-time-unit {
+  position: absolute;
+  top: 113px;
+  left: 116px;
+  height: 19px;
+  width: 45px;
+  font-size: 12px;
+}
+
+#datasetgroup-method-lbl {
+  position: absolute;
+  top: 137px;
+  left: 2px;
+}
+
+#datasetgroup-method {
+  position: absolute;
+  top: 135px;
+  left: 50px;
+  height: 21px;
+  width: 111px;
+  font-size: 12px;
+}
+
+#datasetgroup-blackbox {
+  position: absolute;
+  bottom: 7px;
+  left: 124px;
+  width: 16px;
+  height: 16px;
+  font-size: 19px;
+  cursor: pointer;
+  color: #e0e0e0;
+}
+
+#datasetgroup-outcome {
+  position: absolute;
+  bottom: 1px;
+  left: 144px;
+  width: 16px;
+  height: 16px;
+  cursor: pointer;
+}
+
+#datasetgroup-io {
+  position: absolute;
+  bottom: -2px;
+  left: 144px;
+  font-size: 18px;
+  color: Silver;
+  cursor: pointer;
+}
+
+#datasetgroup-separator {
+  position: absolute;
+  top: 23px;
+  left: 165px;
+  height: 164px;
+  width: 3px;
+  border-left: 1.5px Silver ridge;
+}
+
+#datasetgroup-modif-header {
+  position: absolute;
+  top: 22px;
+  left: 170px;
+  font-style: italic;
+}
+
+#datasetgroup-modif-titles {
+  position: absolute;
+  top: 38px;
+  left: 170px;
+  font-weight: 600;
+}
+
+#datasetgroup-modif-scroll-area {
+  position: absolute;
+  top: 54px;
+  left: 170px;
+  width: 267px;
+  height: 110px;
+  overflow-y: auto;
+  border-top: 1px solid Silver;
+}
+
+#datasetgroup-modif-buttons {
+  position: absolute;
+  bottom: 1px;
+  left: 170px;
+}
+
 /* the MONITOR DIALOG displays solver progress and messages */
 #monitor-dlg {
   display: none;

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

@@ -279,19 +279,19 @@ class Controller {
   // Methods to ensure proper naming of entities.
 
   cleanName(name) {
-    // Returns `name` without the object-attribute separator |, backslashes,
+    // Return `name` without the object-attribute separator |, backslashes,
     // and leading and trailing whitespace, and with all internal whitespace
     // reduced to a single space.
     name = name.replace(this.OA_SEPARATOR, ' ')
         .replace(/\||\\/g, ' ').trim()
         .replace(/\s\s+/g, ' ');
-    // NOTE: this may still result in a single space, which is not a name
+    // NOTE: This may still result in a single space, which is not a name.
     if(name === ' ') return '';
     return name;
   }
   
   validName(name) {
-    // Returns TRUE if `name` is a valid Linny-R entity name. These names
+    // Return TRUE if `name` is a valid Linny-R entity name. These names
     // must not be empty strings, may not contain brackets, backslashes or
     // vertical bars, may not end with a colon, and must start with an
     // underscore, a letter or a digit.
@@ -361,20 +361,84 @@ class Controller {
     // Replace a leading colon in `name` by `prefix`.
     // If `name` identifies a link or a constraint, this is applied to
     // both node names.
+    // NOTE: To give the modeler more control over what to use as prefix,
+    // successive colons indicate that a shorter prefix should be used.
+    // For example, when the prefix is XXX: YYY: ZZZ, two colons mean
+    // "use only XXX: YYY:", three colons "use only XXX:", etc.
     const
         arrow = (name.indexOf(this.LINK_ARROW) >= 0 ?
             this.LINK_ARROW : this.CONSTRAINT_ARROW),
         nodes = name.split(arrow);
     for(let i = 0; i < nodes.length; i++) {
-      nodes[i] = nodes[i].replace(/^:\s*/, prefix)
+      // First check for the special case of just a leading colon plus
+      // possibly an entity attribute.
+      // NOTE:
+      const m = nodes[i].match(/^(:+)\s*(\|[^\|]*)/);
+      if(m) {
+        // Split prefix in parts.
+        const p = prefix.split(UI.PREFIXER);
+        // Remove last (empty!) substring.
+        p.pop();
+        // Shorten prefix by the number of successive colons minus 1.
+        for(let i = 1; i < m[1].length; i++) p.pop();
+        p.push('');
+        // New name is just the (shortened) prefix without its last ": ".
+        nodes[i] = p.join(UI.PREFIXER).replace(/:\s*$/, '') + m[2];
+      } else {
+        // Prefix is typically leading, so try to replace this first.
+        const m = nodes[i].match(/^(:+)/);
+        if(m) {
+          // Shorten prefix by the number of successive colons minus 1.
+          let p = prefix.split(UI.PREFIXER);
+          p.pop();
+          for(let i = 1; i < m[1].length; i++) p.pop();
+          p.push('');
+          nodes[i] = nodes[i].replace(/^:+\s*/, p.join(UI.PREFIXER));
+        } else {
+          // If no change, try to replace an embedded double prefix.
           // NOTE: An embedded double prefix, e.g., "xxx: : yyy" indicates
           // that the second colon+space should be replaced by the prefix.
-          // This "double prefix" may occur only once in an entity name,
-          // hence no global regexp.
-          .replace(/(\w+):\s+:\s+(\w+)/, `$1: ${prefix}$2`);
+          const m = nodes[i].match(/(\w+):\s+(:+)\s+(\w+)/);
+          if(m) {
+            // Shorten prefix by the number of successive colons minus 1.
+            let p = prefix.split(UI.PREFIXER);
+            p.pop();
+            for(let i = 1; i < m[2].length; i++) p.pop();
+            p.push('');
+            prefix = p.join(UI.PREFIXER);
+            nodes[i] = `${m[1]}: ${prefix}${m[3]}`;
+          }
+        }
+      }
     }
     return nodes.join(arrow);
   }
+
+  entityPrefix(name) {
+    // Return the prefix of `name` with its trailing colon+space.
+    const
+        arrow = (name.indexOf(this.LINK_ARROW) >= 0 ?
+            this.LINK_ARROW : this.CONSTRAINT_ARROW),
+        nodes = name.split(arrow);
+    if(nodes.length === 1) return this.completePrefix(name);
+    // For names of links and constraints, it depends:
+    const
+        fn = nodes[0],
+        tn = nodes[1];
+    if(fn.indexOf(UI.PREFIXER) >= 0) {
+      if(tn.indexOf(UI.PREFIXER) >= 0) {
+        // If BOTH nodes are prefixed, use the longest prefix that these
+        // nodes have in common...
+        return UI.sharedPrefix(fn, tn) + UI.PREFIXER;
+      }
+      // .. otherwise, return the FROM node prefix.
+      return UI.completePrefix(fn);
+    }
+    // No FROM node prefix => return the TO node prefix (if any)
+    if(tn.indexOf(UI.PREFIXER) >= 0) return UI.completePrefix(tn);
+    // No prefixers => empty prefix.
+    return '';
+  }
   
   tailNumber(name) {
     // Return the string of digits at the end of `name`. If not there,
@@ -429,7 +493,6 @@ class Controller {
     return pan1.length - pan2.length;
   }
 
-  
   nameToID(name) {
     // Return a name in lower case with link arrow replaced by three
     // underscores, constraint link arrow by four underscores, and spaces
@@ -1272,7 +1335,7 @@ class ExperimentManager {
           MODEL.round_sequence = asel.round_sequence;
         }
       }
-      // Only now compute the simulation run time (number of time steps)
+      // 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
@@ -1282,18 +1345,18 @@ class ExperimentManager {
   }
   
   processRun() {
-    // This method is called by the solveBlocks method of the Virtual Machine
+    // This method is called by the solveBlocks method of the Virtual Machine.
     const x = MODEL.running_experiment;
     if(!x) return;
     const aci = x.active_combination_index;
     if(MODEL.solved) {
-      // NOTE: addresults will call processRestOfRun when completed
+      // NOTE: addresults will call processRestOfRun when completed.
       x.runs[aci].addResults();
     } else {
       // Do not add results...
       UI.warn(`Model run #${aci} incomplete -- results will be invalid`);
-      // ... but do perform the usual post-processing
-      // NOTE: when sensitivity analysis is being performed, switch back to SA
+      // ... but do perform the usual post-processing.
+      // NOTE: When sensitivity analysis is being performed, switch back to SA.
       if(SENSITIVITY_ANALYSIS.experiment) {
         SENSITIVITY_ANALYSIS.processRestOfRun();
       } else {

package/static/scripts/linny-r-gui-chart-manager.js

@@ -331,7 +331,7 @@ class GUIChartManager extends ChartManager {
   }
   
   updateSelector() {
-    // Adds one option to the selector for each chart defined for the model.
+    // Add one option to the selector for each chart defined for the model.
     // NOTE: Add the "new chart" option if it is not in the list.
     MODEL.addChart(this.new_chart_title);
     if(this.chart_index < 0) this.chart_index = 0;
@@ -545,16 +545,16 @@ class GUIChartManager extends ChartManager {
   }
 
   selectChart() {
-    // Sets the selected chart to be the "active" chart
+    // Set the selected chart to be the "active" chart.
     const ci = parseInt(this.chart_selector.value);
-    // Deselect variable only if different chart is selected
+    // Deselect variable only if different chart is selected.
     if(ci !== this.chart_index) this.variable_index = -1;
     this.chart_index = ci;
     this.updateDialog();
   }
 
   promptForTitle() {
-    // Prompts modeler for a new title for the current chart
+    // Prompt modeler for a new title for the current chart.
     if(this.chart_index >= 0) {
       this.rename_chart_modal.show();
       const nct = document.getElementById('new-chart-title');
@@ -564,29 +564,29 @@ class GUIChartManager extends ChartManager {
   }
 
   renameChart() {
-    // Renames the current chart
+    // Rename the current chart.
     if(this.chart_index >= 0) {
-      const t = document.getElementById('new-chart-title').value.trim();
-      // Check if a chart with this title already exists
+      const t = UI.cleanName(document.getElementById('new-chart-title').value);
+      // Check if a chart with this title already exists.
       const ci = MODEL.indexOfChart(t);
       if(ci >= 0 && ci != this.chart_index) {
         UI.warn(`A chart with title "${t}" already exists`);
       } else {
         const c = MODEL.charts[this.chart_index];
-        // Remember the old title of the chart-to-be-renamed
+        // Remember the old title of the chart-to-be-renamed.
         const ot = c.title;
         c.title = t;
-        // If the default '(new chart)' has been renamed, create a new one
+        // If the default '(new chart)' has been renamed, create a new one.
         if(ot === this.new_chart_title) {
           MODEL.addChart(ot);
         }
-        // Update the chart index so that it points to the renamed chart
+        // Update the chart index so that it points to the renamed chart.
         this.chart_index = MODEL.indexOfChart(t);
         this.updateSelector();
-        // Redraw the chart if title is shown
+        // Redraw the chart if title is shown.
         if(c.show_title) this.drawChart();
       }
-      // Update experiment viewer in case its current experiment uses this chart
+      // Update dialogs that may refer to this chart.
       UI.updateControllerDialogs('CFX');
     }
     this.rename_chart_modal.hide();
@@ -744,6 +744,7 @@ class GUIChartManager extends ChartManager {
         chart.addWildcardVariables(dsm, indices);
       } else if(dsm.selector.startsWith(':')) {
         UI.notify('Plotting methods is work-in-progress!');
+        console.log('HERE dsm', dsm, 'expr', dsm.expression.text, 'indices', indices);
       } else {
         UI.notify(`Variable "${dsm.displayName}" cannot be plotted`);
       }