@grnsft/if 0.1.5 → 0.1.7

package/grafana/IF_GRAFANA_SETUP.md

@@ -0,0 +1,71 @@
+# Setting up the Impact Framework Grafana dashboard
+(for any questions please contact paz.barda@intel.com / pazbarda@gmail.com)
+
+## Download and Install Grafana
+https://grafana.com/get/?plcmt=top-nav&cta=downloads&tab=self-managed
+
+This is the self managed version: you install it and can run it on your local machine. 
+
+## Open Grafana on your local machine
+Web browser: localhost:3000
+
+You should see the Grafana welcome page.
+
+## Download and Install Grafana CSV plugin
+https://grafana.com/grafana/plugins/marcusolsson-csv-datasource/?tab=installation
+
+After installation, go to Menu -> Plugins, search for "CSV" and make sure CSV plugin is there
+
+## Import the dashboard json config
+
+Menu -> Dashboards -> New -> Import
+
+1. Drag and drop "grafana_config.json" from this folder to Grafana webpage
+2. Optional - change the name of the dashboard and the details text on the right
+3. Click import.
+
+Dashboard should now appear, but with no data fed into the charts (yet).
+
+## Create a data source for your OMPL CSV file
+Menu -> Connections -> Data Sources -> Add data source
+
+1. Search for "CSV", you should see the CSV plugin. Click it.
+2. Name you new data source.
+3. Switch from "HTTP" to "Local".
+4. Type/paste in the path to your ompl csv ("your/path/to/csvs/if-iee-demo.csv" in our example)
+
+Click Save & Test
+
+
+
+## Connect your OMPL CSV data source to your dashboard
+
+Menu -> Dashboards -> Select your new dashboard 
+
+For each blank chart:
+
+1. Click the chart menu -> edit
+2. Below the chart go to Quary tab
+3. At the top of the tab select the ompl CSV datasource you created
+4. Go to Transform tab, and select the fields you'd like to show on the chart.
+5. Start with "timestamp" and convert it to "Time".
+6. Any other numeric value you'd like to show should be converted to "Number"
+
+Click Apply
+
+Click Save
+
+NOTE: when you select a CSV file (step 3) it might initially not show the columns in the transformation dropdown. if that happens - save the dashboard, exit it refresh the Grafana webpage (localhost:3000). Once you go into the dashboard again it should show the columns for transformation. 
+
+
+## Enable auto-refresh of the dashboard
+
+On the top right of the dashboard, look for the "refresh dashboard" button
+
+Click the dropdown next to it, and choose the auto-refresh interval
+
+Click Save
+
+## Your dashboard is now ready to go!
+With every change to you CSV file you should see it reflect on the dashboard momentarily.
+

package/grafana/if_grafana_config.json

@@ -0,0 +1,370 @@
+{
+  "annotations": {
+    "list": [
+      {
+        "builtIn": 1,
+        "datasource": {
+          "type": "grafana",
+          "uid": "-- Grafana --"
+        },
+        "enable": true,
+        "hide": true,
+        "iconColor": "rgba(0, 211, 255, 1)",
+        "name": "Annotations & Alerts",
+        "type": "dashboard"
+      }
+    ]
+  },
+  "editable": true,
+  "fiscalYearStartMonth": 0,
+  "graphTooltip": 0,
+  "id": 5,
+  "links": [],
+  "liveNow": false,
+  "panels": [
+    {
+      "datasource": {
+        "type": "marcusolsson-csv-datasource",
+        "uid": "<SOURCE_ID>"
+      },
+      "gridPos": {
+        "h": 3,
+        "w": 18,
+        "x": 0,
+        "y": 0
+      },
+      "id": 3,
+      "options": {
+        "code": {
+          "language": "plaintext",
+          "showLineNumbers": false,
+          "showMiniMap": false
+        },
+        "content": "<h1 style=\"font-size: 80px;\">\n        <span style=\"color: #0071C5;\">Dashboard Title</span> <b>goes here</b>",
+        "mode": "html"
+      },
+      "pluginVersion": "10.1.1",
+      "targets": [
+        {
+          "datasource": {
+            "type": "marcusolsson-csv-datasource",
+            "uid": "<SOURCE_ID>"
+          },
+          "decimalSeparator": ".",
+          "delimiter": ",",
+          "header": true,
+          "ignoreUnknown": false,
+          "refId": "A",
+          "schema": [
+            {
+              "name": "",
+              "type": "string"
+            }
+          ],
+          "skipRows": 0
+        }
+      ],
+      "transparent": true,
+      "type": "text"
+    },
+    {
+      "datasource": {
+        "type": "marcusolsson-csv-datasource",
+        "uid": "<SOURCE_ID>"
+      },
+      "description": "",
+      "gridPos": {
+        "h": 3,
+        "w": 5,
+        "x": 19,
+        "y": 0
+      },
+      "id": 2,
+      "options": {
+        "code": {
+          "language": "plaintext",
+          "showLineNumbers": false,
+          "showMiniMap": false
+        },
+        "content": "<p style=\"font-size: 8px; color: gray;\">\n      <u>Some detailed text</u>:<br> goes here</p>",
+        "mode": "html"
+      },
+      "pluginVersion": "10.1.1",
+      "targets": [
+        {
+          "datasource": {
+            "type": "marcusolsson-csv-datasource",
+            "uid": "<SOURCE_ID>"
+          },
+          "decimalSeparator": ".",
+          "delimiter": ",",
+          "header": true,
+          "ignoreUnknown": false,
+          "refId": "A",
+          "schema": [
+            {
+              "name": "",
+              "type": "string"
+            }
+          ],
+          "skipRows": 0
+        }
+      ],
+      "transparent": true,
+      "type": "text"
+    },
+    {
+      "datasource": {
+        "type": "marcusolsson-csv-datasource",
+        "uid": "<SOURCE_ID>"
+      },
+      "fieldConfig": {
+        "defaults": {
+          "color": {
+            "mode": "palette-classic"
+          },
+          "custom": {
+            "axisCenteredZero": false,
+            "axisColorMode": "text",
+            "axisLabel": "",
+            "axisPlacement": "auto",
+            "barAlignment": 0,
+            "drawStyle": "line",
+            "fillOpacity": 0,
+            "gradientMode": "none",
+            "hideFrom": {
+              "legend": false,
+              "tooltip": false,
+              "viz": false
+            },
+            "insertNulls": false,
+            "lineInterpolation": "linear",
+            "lineWidth": 1,
+            "pointSize": 5,
+            "scaleDistribution": {
+              "type": "linear"
+            },
+            "showPoints": "auto",
+            "spanNulls": false,
+            "stacking": {
+              "group": "A",
+              "mode": "none"
+            },
+            "thresholdsStyle": {
+              "mode": "off"
+            }
+          },
+          "mappings": [],
+          "thresholds": {
+            "mode": "absolute",
+            "steps": [
+              {
+                "color": "green",
+                "value": null
+              },
+              {
+                "color": "red",
+                "value": 80
+              }
+            ]
+          }
+        },
+        "overrides": []
+      },
+      "gridPos": {
+        "h": 9,
+        "w": 24,
+        "x": 0,
+        "y": 3
+      },
+      "id": 1,
+      "options": {
+        "legend": {
+          "calcs": [],
+          "displayMode": "list",
+          "placement": "bottom",
+          "showLegend": true
+        },
+        "tooltip": {
+          "mode": "single",
+          "sort": "none"
+        }
+      },
+      "targets": [
+        {
+          "datasource": {
+            "type": "marcusolsson-csv-datasource",
+            "uid": "<SOURCE_ID>"
+          },
+          "decimalSeparator": ".",
+          "delimiter": ",",
+          "header": true,
+          "ignoreUnknown": false,
+          "refId": "A",
+          "schema": [
+            {
+              "name": "",
+              "type": "string"
+            }
+          ],
+          "skipRows": 0
+        }
+      ],
+      "title": "Energy [kWh]",
+      "transformations": [
+        {
+          "id": "convertFieldType",
+          "options": {
+            "conversions": [
+              {
+                "destinationType": "time",
+                "targetField": "timestamp"
+              },
+              {
+                "destinationType": "number",
+                "targetField": "energy"
+              }
+            ],
+            "fields": {}
+          }
+        }
+      ],
+      "type": "timeseries"
+    },
+    {
+      "datasource": {
+        "type": "marcusolsson-csv-datasource",
+        "uid": "<SOURCE_ID>"
+      },
+      "fieldConfig": {
+        "defaults": {
+          "color": {
+            "mode": "palette-classic"
+          },
+          "custom": {
+            "axisCenteredZero": false,
+            "axisColorMode": "text",
+            "axisLabel": "",
+            "axisPlacement": "auto",
+            "barAlignment": 0,
+            "drawStyle": "line",
+            "fillOpacity": 0,
+            "gradientMode": "none",
+            "hideFrom": {
+              "legend": false,
+              "tooltip": false,
+              "viz": false
+            },
+            "insertNulls": false,
+            "lineInterpolation": "linear",
+            "lineWidth": 1,
+            "pointSize": 5,
+            "scaleDistribution": {
+              "type": "linear"
+            },
+            "showPoints": "auto",
+            "spanNulls": false,
+            "stacking": {
+              "group": "A",
+              "mode": "none"
+            },
+            "thresholdsStyle": {
+              "mode": "off"
+            }
+          },
+          "mappings": [],
+          "thresholds": {
+            "mode": "absolute",
+            "steps": [
+              {
+                "color": "green",
+                "value": null
+              },
+              {
+                "color": "red",
+                "value": 80
+              }
+            ]
+          }
+        },
+        "overrides": []
+      },
+      "gridPos": {
+        "h": 8,
+        "w": 24,
+        "x": 0,
+        "y": 12
+      },
+      "id": 5,
+      "options": {
+        "legend": {
+          "calcs": [],
+          "displayMode": "list",
+          "placement": "bottom",
+          "showLegend": true
+        },
+        "tooltip": {
+          "mode": "single",
+          "sort": "none"
+        }
+      },
+      "targets": [
+        {
+          "datasource": {
+            "type": "marcusolsson-csv-datasource",
+            "uid": "<SOURCE_ID>"
+          },
+          "decimalSeparator": ".",
+          "delimiter": ",",
+          "header": true,
+          "ignoreUnknown": false,
+          "refId": "A",
+          "schema": [
+            {
+              "name": "",
+              "type": "string"
+            }
+          ],
+          "skipRows": 0
+        }
+      ],
+      "title": "Carbon [gCO2]",
+      "transformations": [
+        {
+          "id": "convertFieldType",
+          "options": {
+            "conversions": [
+              {
+                "destinationType": "time",
+                "targetField": "timestamp"
+              },
+              {
+                "destinationType": "number",
+                "targetField": "carbon"
+              }
+            ],
+            "fields": {}
+          }
+        }
+      ],
+      "type": "timeseries"
+    }
+  ],
+  "refresh": "",
+  "schemaVersion": 38,
+  "style": "dark",
+  "tags": [],
+  "templating": {
+    "list": []
+  },
+  "time": {
+    "from": "2023-11-02T08:35:31.000Z",
+    "to": "2023-11-02T08:35:42.000Z"
+  },
+  "timepicker": {},
+  "timezone": "",
+  "title": "IF_dashboard",
+  "uid": "",
+  "version": 40,
+  "weekStart": ""
+}

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@grnsft/if",
   "description": "Impact Framework",
-  "version": "v0.1.5",
+  "version": "v0.1.7",
   "author": {
     "name": "Green Software Foundation",
     "email": "info@gsf.com"
@@ -13,6 +13,7 @@
     "url": "https://github.com/Green-Software-Foundation/if/issues/new?assignees=&labels=feedback&projects=&template=feedback.md&title=Feedback+-+"
   },
   "dependencies": {
+    "copyfiles": "^2.4.1",
     "js-yaml": "^4.1.0",
     "moment": "^2.29.4",
     "moment-range": "^4.0.2",
@@ -34,7 +35,6 @@
   },
   "engines": {
     "node": ">=18",
-    "yarn": ">=1.22",
     "npm": ">=8"
   },
   "homepage": "https://greensoftware.foundation",
@@ -55,13 +55,13 @@
     "url": "https://github.com/Green-Software-Foundation/if"
   },
   "scripts": {
-    "build": "rm -rf build && tsc --project tsconfig.build.json",
+    "build": "rm -rf build && tsc --project tsconfig.build.json && copyfiles -u 2 src/config/units.yaml build/config",
     "coverage": "jest --verbose --coverage",
     "fix": "gts fix",
     "fix:package": "fixpack",
     "impact-engine": "npx ts-node src/index.ts",
     "lint": "gts lint",
-    "prepublish": "yarn build",
+    "prepublish": "npm run build",
     "test": "jest --verbose"
   },
   "stability": "stable",

package/src/config/units.yaml

@@ -105,7 +105,7 @@ timestamp:
 time-reserved:
   description: time reserved for a component
   unit: seconds
-  aggregation: none
+  aggregation: avg
 total-resources:
   description: total resources available
   unit: count