@grnsft/if 0.3.4 → 0.4.0-beta.1

package/manifests/plugins/mock-observations/failure-invalid-memory-utilization-range.yml

@@ -0,0 +1,34 @@
+name: mock-observation-demo
+description: a manifest demonstrating how to use the mock observations feature
+tags:
+initialize:
+ # outputs: ['yaml']
+  plugins:
+    mock-observations:
+      kind: plugin
+      method: MockObservations
+      path: "builtin"
+      global-config:
+        timestamp-from: 2023-07-06T00:00
+        timestamp-to: 2023-07-06T00:10
+        duration: 60
+        components:
+          - cloud/instance-type: A1
+          - cloud/instance-type: B1
+        generators:
+          common:
+            region: uk-west
+            common-key: common-val
+          randint:
+            cpu/utilization:
+              min: 1
+              max: 99
+            memory/utilization:
+              min: 99
+              max: 10
+tree:
+  children:
+    child:
+      pipeline:
+        - mock-observations
+      inputs:

package/manifests/plugins/mock-observations/failure-missing-timestamp-from-param.yml

@@ -0,0 +1,34 @@
+name: mock-observation-demo
+description: a manifest demonstrating how to use the mock observations feature
+tags:
+initialize:
+  outputs: ['yaml']
+  plugins:
+    mock-observations:
+      kind: plugin
+      method: MockObservations
+      path: "builtin"
+      global-config:
+        #timestamp-from: 2023-07-06T00:00
+        timestamp-to: 2023-07-06T00:10
+        duration: 60
+        components:
+          - cloud/instance-type: A1
+          - cloud/instance-type: B1
+        generators:
+          common:
+            region: uk-west
+            common-key: common-val
+          randint:
+            cpu/utilization:
+              min: 1
+              max: 99
+            memory/utilization:
+              min: 1
+              max: 99
+tree:
+  children:
+    child:
+      pipeline:
+        - mock-observations
+      inputs:

package/manifests/plugins/mock-observations/success.yml

@@ -2,12 +2,12 @@ name: mock-observation-demo
 description: a manifest demonstrating how to use the mock observations feature
 tags:
 initialize:
-  outputs: ['yaml']
+ # outputs: ['yaml']
   plugins:
     mock-observations:
       kind: plugin
       method: MockObservations
-      path: "@grnsft/if-plugins"
+      path: "builtin"
       global-config:
         timestamp-from: 2023-07-06T00:00
         timestamp-to: 2023-07-06T00:10

package/manifests/plugins/multiply/failure-input-parameter-is-missing.yml

@@ -6,7 +6,7 @@ initialize:
   plugins:
     multiply:
       method: Multiply
-      path: "@grnsft/if-plugins"
+      path: "builtin"
       global-config:
         input-parameters: ["cpu/energy", "network/energy"]
         output-parameter: "energy-product"

package/manifests/plugins/multiply/success-with-multiple-inputs.yml

@@ -0,0 +1,32 @@
+name: multiply
+description: a manifest demonstrating how to use the multiply feature
+tags:
+initialize:
+  outputs: ['yaml']
+  plugins:
+    multiply:
+      method: Multiply
+      path: "builtin"
+      global-config:
+        input-parameters: ["cpu/energy", "network/energy"]
+        output-parameter: "energy-product"
+tree:
+  children:
+    child:
+      pipeline:
+        - multiply
+      config:
+        sum: 
+      inputs:
+        - timestamp: 2023-08-06T00:00
+          duration: 3600
+          cpu/energy: 0.001
+          network/energy: 0.002
+        - timestamp: 2023-08-06T10:00
+          duration: 3600
+          cpu/energy: 0.005
+          network/energy: -0.002
+        - timestamp: 2023-08-06T10:00
+          duration: 3600
+          cpu/energy: 0.005
+          network/energy: 0

package/manifests/plugins/multiply/success.yml

@@ -2,11 +2,11 @@ name: multiply
 description: a manifest demonstrating how to use the multiply feature
 tags:
 initialize:
-  outputs: ['yaml']
+ # outputs: ['yaml']
   plugins:
     multiply:
       method: Multiply
-      path: "@grnsft/if-plugins"
+      path: builtin
       global-config:
         input-parameters: ["cpu/energy", "network/energy"]
         output-parameter: "energy-product"
@@ -16,7 +16,7 @@ tree:
       pipeline:
         - multiply
       config:
-        sum:
+        sum: 
       inputs:
         - timestamp: 2023-08-06T00:00
           duration: 3600

package/manifests/plugins/regex/failure-missing-input-param.yml

@@ -6,7 +6,7 @@ initialize:
   plugins:
     regex:
       method: Regex
-      path: "@grnsft/if-plugins"
+      path: "builtin"
       global-config:
         parameter: physical-processor
         match: ^(.*),

package/manifests/plugins/regex/failure-not-matching-with-regex.yml

@@ -0,0 +1,24 @@
+name: regex
+description: physical processor doesn't match the regex expression
+tags:
+initialize:
+ # outputs: ['yaml']
+  plugins:
+    regex:
+      method: Regex
+      path: "builtin"
+      global-config:
+        parameter: physical-processor
+        match: ^
+        output: cpu/name
+tree:
+  children:
+    child:
+      pipeline:
+        - regex
+      config:
+        regex:
+      inputs:
+        - timestamp: 2023-08-06T00:00
+          duration: 3600
+          physical-processor: Intel® Xeon® Platinum 8272CL,Intel® Xeon® 8171M 2.1 GHz,Intel® Xeon® E5-2673 v4 2.3 GHz,Intel® Xeon® E5-2673 v3 2.4 GHz

package/manifests/plugins/regex/success.yml

@@ -2,11 +2,11 @@ name: regex
 description: successful path
 tags:
 initialize:
-  outputs: ['yaml']
+  # outputs: ['yaml']
   plugins:
     regex:
       method: Regex
-      path: "@grnsft/if-plugins"
+      path: "builtin"
       global-config:
         parameter: physical-processor
         match: ^(.*),

package/manifests/plugins/sci/failure-invalid-config-value.yml

@@ -7,9 +7,9 @@ initialize:
     sci:
       kind: plugin
       method: Sci
-      path: "@grnsft/if-plugins"
+      path: "builtin"
       # global-config:
-      #   functional-unit-time: 1 minute
+      #   functional-unit: 1 minute
 tree:
   children:
     child:
@@ -17,7 +17,6 @@ tree:
         - sci
       config:
         sci:
-          functional-unit-time: 1 sec
           functional-unit: 999 # factor to convert per time to per f.unit
       inputs:
         - timestamp: 2023-07-06T00:00

package/manifests/plugins/sci/failure-missing-input-param.yml

@@ -0,0 +1,27 @@
+name: sci
+description: missing input value (carbon-embodied)
+tags:
+initialize:
+  #outputs: ['yaml']
+  plugins:
+    sci:
+      kind: plugin
+      method: Sci
+      path: "builtin"
+      # global-config:
+      #   functional-unit: requests
+tree:
+  children:
+    child:
+      pipeline:
+        - sci
+      config:
+        sci:
+          functional-unit-time: 1 sec
+          functional-unit: requests # factor to convert per time to per f.unit
+      inputs:
+        - timestamp: 2023-07-06T00:00
+          duration: 3600
+          energy: 5
+          carbon-operational: 5
+          requests: 100

package/manifests/plugins/sci/success.yml

@@ -2,14 +2,14 @@ name: sci
 description: successful path
 tags:
 initialize:
-  outputs: ['yaml']
+  # outputs: ['yaml']
   plugins:
     sci:
       kind: plugin
       method: Sci
-      path: "@grnsft/if-plugins"
-      # global-config:
-      #   functional-unit-time: 1 minute
+      path: "builtin"
+      global-config:
+        functional-unit: requests
 tree:
   children:
     child:
@@ -25,4 +25,5 @@ tree:
           energy: 5
           carbon-operational: 5
           carbon-embodied: 0.02
+          carbon: 5.02
           requests: 100

package/manifests/plugins/{sci-m → sci-embodied}/failure-invalid-default-emission-value.yml

@@ -1,18 +1,17 @@
-name: sci-m
+name: sci-embodied
 description: failure with `defaults.device/emissions-embodied` being string instead of number
 tags:
 initialize:
   outputs: ['yaml']
   plugins:
-    "sci-m": # a model that calculates m from te, tir, el, rr and rtor
-      method: SciM
-      verbose: false
-      path: "@grnsft/if-plugins"
+    "sci-embodied": # a model that calculates m from te, tir, el, rr and rtor
+      method: SciEmbodied
+      path: "builtin"
 tree:
   children:
     child:
       pipeline:
-        - sci-m # duration & config -> embodied
+        - sci-embodied # duration & config -> embodied
       defaults:
         device/emissions-embodied: 'fail' # gCO2eq
         time-reserved: 3600 # 1hr in seconds

package/manifests/plugins/sci-embodied/failure-missing-expected-lifespan.yml

@@ -0,0 +1,23 @@
+name: sci-embodied
+description: missing device/expected-lifespan
+tags:
+initialize:
+  #outputs: ['yaml']
+  plugins:
+    "sci-embodied": # a model that calculates m from te, tir, el, rr and rtor
+      method: SciEmbodied
+      path: "builtin"
+tree:
+  children:
+    child:
+      pipeline:
+        - sci-embodied # duration & config -> embodied
+      defaults:
+        device/emissions-embodied: 1533.120 # gCO2eq
+        time-reserved: 3600 # 1hr in seconds
+        #device/expected-lifespan: 94608000 # 3 years in seconds
+        resources-reserved: 1
+        resources-total: 8
+      inputs:
+        - timestamp: 2023-07-06T00:00
+          duration: 3600

package/manifests/plugins/{sci-m → sci-embodied}/success.yml

@@ -1,18 +1,17 @@
-name: sci-m
+name: sci-embodied
 description: successful path
 tags:
 initialize:
   outputs: ['yaml']
   plugins:
-    "sci-m": # a model that calculates m from te, tir, el, rr and rtor
-      method: SciM
-      verbose: false
-      path: "@grnsft/if-plugins"
+    "sci-embodied": # a model that calculates m from te, tir, el, rr and rtor
+      method: SciEmbodied
+      path: "builtin"
 tree:
   children:
     child:
       pipeline:
-        - sci-m # duration & config -> embodied
+        - sci-embodied # duration & config -> embodied
       defaults:
         device/emissions-embodied: 1533.120 # gCO2eq
         time-reserved: 3600 # 1hr in seconds

package/manifests/plugins/shell/failure-invalid-command.yml

@@ -6,7 +6,7 @@ initialize:
   plugins:
     shell:
       method: Shell
-      path: "@grnsft/if-plugins"
+      path: "builtin"
       global-config:
         command: 1000
 tree:

package/manifests/plugins/shell/success.yml

@@ -2,11 +2,10 @@ name: shell
 description: successful path
 tags:
 initialize:
-  outputs: ['yaml']
   plugins:
     shell:
       method: Shell
-      path: "@grnsft/if-plugins"
+      path: 'builtin'
       global-config:
         command: python3 /usr/local/bin/sampler
 tree:

package/manifests/plugins/sum/failure-missing-input-param.yml

@@ -6,7 +6,7 @@ initialize:
   plugins:
     sum:
       method: Sum
-      path: "@grnsft/if-plugins"
+      path: "builtin"
       global-config:
         input-parameters: ["cpu/energy", "network/energy"]
         output-parameter: "energy"

package/manifests/plugins/sum/failure-missing-output-param.yml

@@ -0,0 +1,28 @@
+name: sum
+description: missing `output-parameter` in global-config
+tags:
+initialize:
+  outputs: ['yaml']
+  plugins:
+    sum:
+      method: Sum
+      path: "builtin"
+      global-config:
+        input-parameters: ["cpu/energy", "network/energy"]
+       # output-parameter: "energy"
+tree:
+  children:
+    child:
+      pipeline:
+        - sum
+      config:
+        sum:
+      inputs:
+        - timestamp: 2023-08-06T00:00
+          duration: 3600
+          cpu/energy: 0.001
+          network/energy: 0.001
+        - timestamp: 2023-08-06T00:00
+          duration: 3600
+          cpu/energy: 0.001
+          network/energy: e

package/manifests/plugins/sum/success.yml

@@ -6,7 +6,7 @@ initialize:
   plugins:
     sum:
       method: Sum
-      path: "@grnsft/if-plugins"
+      path: "builtin"
       global-config:
         input-parameters: ["cpu/energy", "network/energy"]
         output-parameter: "energy"

package/manifests/plugins/tdp-finder/failure-unsupported-physical-processor.yml

@@ -0,0 +1,19 @@
+name: tdp-finder
+description: successful path
+tags:
+initialize:
+  outputs: ['yaml']
+  plugins:
+    tdp-finder: # a model that returns an embodied value given the sci embodied attribution equation.
+      method: TdpFinder
+      path: "@grnsft/if-plugins"
+tree:
+  children:
+    child:
+      pipeline:
+        - tdp-finder
+      config:
+      inputs:
+        - timestamp: 2023-07-06T00:00
+          duration: 300
+          physical-processor: AMD 302

package/manifests/plugins/time-sync/failure-missing-global-config.yml

@@ -0,0 +1,34 @@
+name: time-sync
+description: missing global config
+tags:
+initialize:
+  output:
+    - yaml
+  plugins:
+    'time-sync':
+      method: TimeSync
+      path: "builtin"
+      global-config: 
+        # start-time: '2023-12-12T00:00:00.000Z'
+        # end-time: '2023-12-12T00:01:00.000Z'
+        # interval: 5
+        # allow-padding: true
+tree:
+  children:
+    child:
+      pipeline:
+        - time-sync
+      config:
+      inputs:
+        - timestamp: '2023-12-12T00:00:00.000Z'
+          duration: 3
+          energy-cpu: 0.001
+        - timestamp: '2023-12-12T00:00:01.000Z'
+          duration: 5
+          energy-cpu: 0.001
+        - timestamp: '2023-12-12T00:00:06.000Z'
+          duration: 7
+          energy-cpu: 0.001
+        - timestamp: '2023-12-12T00:00:13.000Z'
+          duration: 30
+          energy-cpu: 0.001

package/package.json

@@ -1,13 +1,14 @@
 {
   "name": "@grnsft/if",
   "description": "Impact Framework",
-  "version": "0.3.4",
+  "version": "0.4.0-beta.1",
   "author": {
     "name": "Green Software Foundation",
     "email": "info@gsf.com"
   },
   "bin": {
-    "ie": "./build/index.js"
+    "ie": "./build/index.js",
+    "if-diff": "./build/diff.js"
   },
   "bugs": {
     "url": "https://github.com/Green-Software-Foundation/if/issues/new?assignees=&labels=feedback&projects=&template=feedback.md&title=Feedback+-+"
@@ -15,11 +16,14 @@
   "dependencies": {
     "@commitlint/cli": "^18.6.0",
     "@commitlint/config-conventional": "^18.6.0",
+    "axios": "^1.7.2",
+    "csv-parse": "^5.5.6",
     "csv-stringify": "^6.4.6",
     "js-yaml": "^4.1.0",
     "luxon": "^3.4.4",
     "ts-command-line-args": "^2.5.1",
     "typescript": "^5.1.6",
+    "typescript-cubic-spline": "^1.0.1",
     "winston": "^3.11.0",
     "zod": "^3.22.4"
   },
@@ -31,10 +35,12 @@
     "@types/js-yaml": "^4.0.5",
     "@types/luxon": "^3.4.2",
     "@types/node": "^20.8.9",
+    "axios-mock-adapter": "^1.22.0",
     "fixpack": "^4.0.0",
     "gts": "^5.0.0",
     "husky": "^8.0.0",
     "jest": "^29.6.1",
+    "lint-staged": "^15.2.2",
     "release-it": "^16.3.0",
     "rimraf": "^5.0.5",
     "ts-jest": "^29.1.1"
@@ -67,7 +73,9 @@
     "fix": "gts fix",
     "fix:package": "fixpack",
     "ie": "npx ts-node src/index.ts",
+    "if-diff": "npx ts-node src/diff.ts",
     "lint": "gts lint",
+    "pre-commit": "lint-staged",
     "prepare": "husky install",
     "prepublish": "npm run build",
     "release": "release-it",

package/src/builtins/README.md

@@ -231,9 +231,9 @@ initialize:
     sci-e:
       method: SciE
       path: '@grnsft/if-plugins'
-    sci-m:
-      path: '@grnsft/if-plugins'
-      method: SciM
+    sci-embodied:
+      path: 'builtin'
+      method: SciEmbodied
     sci-o:
       method: SciO
       path: '@grnsft/if-plugins'
@@ -250,13 +250,13 @@ tree:
       pipeline:
         - teads-curve
         - sci-e
-        - sci-m
+        - sci-embodied
         - sci-o
         - time-sync
       config:
         teads-curve:
           cpu/thermal-design-power: 65
-        sci-m:
+        sci-embodied:
           device/emissions-embodied: 251000 # gCO2eq
           time-reserved: 3600 # 1 hour in s
           device/expected-lifespan: 126144000 # 4 years in seconds

package/src/builtins/coefficient/README.md

@@ -0,0 +1,92 @@
+# Coefficient
+
+`Coefficient` is a generic plugin for multiplying a value in an `input` array by a given coefficient.
+
+You provide the name of the value you want to multiply, a coefficient value, and a name to use to append the product to the output array.
+
+For example, you could multiply `cpu/energy` by 10 and name the result `energy-product`. `energy-product` would then be added to every observation in your input array as the product of `cpu/energy` and 10.
+
+## Parameters
+
+### Plugin global config
+
+Three parameters are required in global config: `input-parameter`, `coefficient` and `output-parameter`.
+
+- `input-parameter`: a string matching an existing key in the `inputs` array
+- `coefficient`: the value to multiply `input-parameter` by.
+- `output-parameter`: a string defining the name to use to add the product of the input parameters to the output array.
+
+### Inputs
+
+All of `input-parameters` must be available in the input array.
+
+## Returns
+
+- `output-parameter`: the product of all `input-parameters` with the parameter name defined by `output-parameter` in global config.
+
+## Calculation
+
+```pseudocode
+output = input * coefficient
+```
+
+## Implementation
+
+To run the plugin from a Typescript app, you must first create an instance of `Coefficient`. Then, you can call `execute()`.
+
+```typescript
+const config = {
+  'input-parameter': 'carbon',
+  coefficient: 10,
+  'output-parameter': 'carbon-product',
+};
+
+const coeff = Coefficient(config);
+const result = coeff.execute([
+  {
+    duration: 3600,
+    timestamp: '2021-01-01T00:00:00Z',
+    carbon: 3,
+  },
+]);
+```
+
+## Example manifest
+
+IF users will typically call the plugin as part of a pipeline defined in a manifest file. In this case, instantiating the plugin is handled by `ie` and does not have to be done explicitly by the user. The following is an example manifest that calls `coefficient`:
+
+```yaml
+name: coefficient-demo
+description:
+tags:
+initialize:
+  outputs:
+    - yaml
+  plugins:
+    coefficient:
+      method: Coefficient
+      path: 'builtin'
+      global-config:
+        input-parameter: 'carbon'
+        coefficient: 3
+        output-parameter: 'carbon-product'
+tree:
+  children:
+    child:
+      pipeline:
+        - coefficient
+      config:
+        coefficient:
+      inputs:
+        - timestamp: 2023-08-06T00:00
+          duration: 3600
+          carbon: 30
+```
+
+You can run this example by saving it as `./examples/manifests/coefficient.yml` and executing the following command from the project root:
+
+```sh
+ie --manifest ./examples/manifests/coefficient.yml --output ./examples/outputs/coefficient.yml
+```
+
+The results will be saved to a new `yaml` file in `./examples/outputs`