@grnsft/if 0.1.9 → 0.2.0

package/examples/manifests/pipeline-demo-2.yml

@@ -0,0 +1,149 @@
+name: pipeline-demo
+description:
+tags:
+aggregation:
+  metrics:
+    - "carbon"
+  type: "both"
+initialize:
+  plugins:
+    "teads-curve":
+      path: "@grnsft/if-unofficial-plugins"
+      method: TeadsCurve
+      global-config:
+        interpolation: spline
+    "sum":
+      path: "@grnsft/if-plugins"
+      method: Sum
+      global-config:
+        input-parameters:
+          - cpu/energy
+          - network/energy
+        output-parameter: carbon-plus-energy'
+    "sci-m":
+      path: "@grnsft/if-plugins"
+      method: SciM
+    "sci-o":
+      path: "@grnsft/if-plugins"
+      method: SciO
+    "sci":
+      path: "@grnsft/if-plugins"
+      method: Sci
+      global-config:
+        functional-unit: "requests"
+        functional-unit-time: "1 minute"
+    "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
+    "group-by":
+      path: builtin
+      method: GroupBy
+tree:
+  children:
+    child-1:
+      pipeline:
+        - teads-curve
+        - sum
+        - sci-m
+        - sci-o
+        - time-sync
+        - sci
+      config:
+        group-by:
+          group:
+            - region
+            - instance-type
+      defaults:
+        cpu/thermal-design-power: 100
+        grid/carbon-intensity: 800
+        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
+        functional-unit-time: "1 min"
+      inputs:
+        - timestamp: "2023-12-12T00:00:00.000Z"
+          instance-type: A1
+          region: uk-west
+          duration: 1
+          cpu/utilization: 10
+          network/energy: 10
+          energy: 5
+        - timestamp: "2023-12-12T00:00:01.000Z"
+          duration: 5
+          cpu/utilization: 20
+          instance-type: A1
+          region: uk-west
+          network/energy: 10
+          energy: 5
+        - timestamp: "2023-12-12T00:00:06.000Z"
+          duration: 7
+          cpu/utilization: 15
+          instance-type: A1
+          region: uk-west
+          network/energy: 10
+          energy: 5
+        - timestamp: "2023-12-12T00:00:13.000Z"
+          duration: 30
+          instance-type: A1
+          region: uk-west
+          cpu/utilization: 15
+          network/energy: 10
+          energy: 5
+    child-2:
+      pipeline:
+        - teads-curve
+        - sum
+        - sci-m
+        - sci-o
+        - time-sync
+        - sci
+      config:
+        group-by:
+          group:
+            - region
+            - instance-type
+      defaults:
+        cpu/thermal-design-power: 100
+        grid/carbon-intensity: 800
+        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
+        functional-unit-time: "1 min"
+      inputs:
+        - timestamp: "2023-12-12T00:00:00.000Z"
+          duration: 1
+          cpu/utilization: 30
+          instance-type: A1
+          region: uk-west
+          network/energy: 10
+          energy: 5
+        - timestamp: "2023-12-12T00:00:01.000Z"
+          duration: 5
+          cpu/utilization: 28
+          instance-type: A1
+          region: uk-west
+          network/energy: 10
+          energy: 5
+        - timestamp: "2023-12-12T00:00:06.000Z"
+          duration: 7
+          cpu/utilization: 40
+          instance-type: A1
+          region: uk-west
+          network/energy: 10
+          energy: 5
+        - timestamp: "2023-12-12T00:00:13.000Z"
+          duration: 30
+          cpu/utilization: 33
+          instance-type: A1
+          region: uk-west
+          network/energy: 10
+          energy: 5

package/examples/manifests/pipeline-demo.yml

@@ -0,0 +1,128 @@
+name: realistic-pipeline-demo
+description:
+tags:
+aggregation:
+  metrics:
+    - "carbon"
+  type: "both"
+initialize:
+  plugins:
+    "teads-curve":
+      path: "@grnsft/if-unofficial-plugins"
+      method: TeadsCurve
+      global-config:
+        interpolation: spline
+    "sci-e":
+      path: "@grnsft/if-plugins"
+      method: SciE
+    "sci-m":
+      path: "@grnsft/if-plugins"
+      method: SciM
+    "sci-o":
+      path: "@grnsft/if-plugins"
+      method: SciO
+    "sci":
+      path: "@grnsft/if-plugins"
+      method: Sci
+      global-config:
+        functional-unit: "requests"
+        functional-unit-time: "1 minute"
+    "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
+    "group-by":
+      path: builtin
+      method: GroupBy
+tree:
+  children:
+    child-1:
+      pipeline:
+        - teads-curve
+        - sci-e
+        - sci-m
+        - sci-o
+        - time-sync
+        - sci
+      config:
+        group-by:
+          group:
+            - region
+            - instance-type
+      defaults:
+        cpu/thermal-design-power: 100
+        grid/carbon-intensity: 800
+        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
+        functional-unit-time: "1 min"
+      inputs:
+        - timestamp: "2023-12-12T00:00:00.000Z"
+          instance-type: A1
+          region: uk-west
+          duration: 1
+          cpu/utilization: 10
+        - timestamp: "2023-12-12T00:00:01.000Z"
+          duration: 5
+          cpu/utilization: 20
+          instance-type: A1
+          region: uk-west
+        - timestamp: "2023-12-12T00:00:06.000Z"
+          duration: 7
+          cpu/utilization: 15
+          instance-type: A1
+          region: uk-west
+        - timestamp: "2023-12-12T00:00:13.000Z"
+          duration: 30
+          instance-type: A1
+          region: uk-west
+          cpu/utilization: 15
+    child-2:
+      pipeline:
+        - teads-curve
+        - sci-e
+        - sci-m
+        - sci-o
+        - time-sync
+        - sci
+      config:
+        group-by:
+          group:
+            - region
+            - instance-type
+      defaults:
+        cpu/thermal-design-power: 100
+        grid/carbon-intensity: 800
+        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
+        functional-unit-time: "1 min"
+      inputs:
+        - timestamp: "2023-12-12T00:00:00.000Z"
+          duration: 1
+          cpu/utilization: 30
+          instance-type: A1
+          region: uk-west
+        - timestamp: "2023-12-12T00:00:01.000Z"
+          duration: 5
+          cpu/utilization: 28
+          instance-type: A1
+          region: uk-west
+        - timestamp: "2023-12-12T00:00:06.000Z"
+          duration: 7
+          cpu/utilization: 40
+          instance-type: A1
+          region: uk-west
+        - timestamp: "2023-12-12T00:00:13.000Z"
+          duration: 30
+          cpu/utilization: 33
+          instance-type: A1
+          region: uk-west

package/examples/manifests/pipeline-teads-sci.yml

@@ -0,0 +1,82 @@
+name: pipeline-teads-sci
+description:
+tags:
+initialize:
+  plugins:
+    "teads-curve":
+      path: "@grnsft/if-unofficial-plugins"
+      method: TeadsCurve
+      global-config:
+        interpolation: spline
+    "sum":
+      path: "@grnsft/if-plugins"
+      method: Sum
+      global-config:
+        input-parameters: 
+          - cpu/energy
+          - network/energy
+        output-parameter: energy 
+    "sci-m":
+      path: "@grnsft/if-plugins"
+      method: SciM
+    "sci-o":
+      path: "@grnsft/if-plugins"
+      method: SciO
+    "sci":
+      path: "@grnsft/if-plugins"
+      method: Sci
+      global-config:
+        functional-unit: ''
+        functional-unit-time: '1-day'
+    "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-1:
+      pipeline:
+        - teads-curve
+        - sum
+        - sci-m
+        - sci-o
+        - time-sync
+        - sci
+      config:
+      defaults:
+        cpu/thermal-design-power: 100
+        grid/carbon-intensity: 800
+        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-12-12T00:00:00.000Z"
+          instance-type: A1 
+          region: uk-west
+          duration: 1
+          cpu/utilization: 50
+          network/energy: 0.000001
+        - timestamp: "2023-12-12T00:00:01.000Z"
+          duration: 5
+          cpu/utilization: 20
+          instance-type: A1 
+          region: uk-west
+          network/energy: 0.000001
+        - timestamp: "2023-12-12T00:00:06.000Z"
+          duration: 7
+          cpu/utilization: 15
+          instance-type: A1 
+          region: uk-west
+          network/energy: 0.000001
+        - timestamp: "2023-12-12T00:00:13.000Z"
+          duration: 30
+          instance-type: A1 
+          region: uk-west
+          cpu/utilization: 15
+          network/energy: 0.000001

package/examples/manifests/pipeline-with-generics.yml

@@ -0,0 +1,147 @@
+name: pipeline-with-generics-demo
+description:
+tags:
+aggregation:
+  metrics:
+    - 'carbon'
+  type: 'both'
+initialize:
+  plugins:
+    "teads-curve":
+      path: "@grnsft/if-unofficial-plugins"
+      method: TeadsCurve
+      global-config:
+        interpolation: spline
+    "sum":
+      path: "@grnsft/if-plugins"
+      method: Sum
+      global-config:
+        input-parameters: 
+          - cpu/energy
+          - network/energy
+        output-parameter: energy-sum 
+    "coefficient":
+      path: "@grnsft/if-plugins"
+      method: Coefficient
+      global-config:
+        input-parameter: energy
+        coefficient: 2
+        output-parameter: energy-doubled 
+    "sci-m":
+      path: "@grnsft/if-plugins"
+      method: SciM
+    "sci-o":
+      path: "@grnsft/if-plugins"
+      method: SciO
+    "sci":
+      path: "@grnsft/if-plugins"
+      method: Sci
+      global-config:
+        functional-unit: "requests"
+        functional-unit-time: "1 minute"
+    "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-1:
+      pipeline:
+        - teads-curve
+        - sum
+        - sci-m
+        - sci-o
+        - time-sync
+        - coefficient
+        - sci
+      config:
+      defaults:
+        cpu/thermal-design-power: 100
+        grid/carbon-intensity: 800
+        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
+        functional-unit-time: "1 min"
+      inputs:
+        - timestamp: "2023-12-12T00:00:00.000Z"
+          instance-type: A1 
+          region: uk-west
+          duration: 1
+          cpu/utilization: 50
+          network/energy: 10
+          energy: 5
+        - timestamp: "2023-12-12T00:00:01.000Z"
+          duration: 5
+          cpu/utilization: 20
+          instance-type: A1 
+          region: uk-west
+          network/energy: 10
+          energy: 5
+        - timestamp: "2023-12-12T00:00:06.000Z"
+          duration: 7
+          cpu/utilization: 15
+          instance-type: A1 
+          region: uk-west
+          network/energy: 10
+          energy: 5
+        - timestamp: "2023-12-12T00:00:13.000Z"
+          duration: 30
+          instance-type: A1 
+          region: uk-west
+          cpu/utilization: 15
+          network/energy: 10
+          energy: 5
+    child-2:
+      pipeline:
+        - teads-curve
+        - sum
+        - sci-m
+        - sci-o
+        - time-sync
+        - coefficient
+        - sci
+      config:
+      defaults:
+        cpu/thermal-design-power: 100
+        grid/carbon-intensity: 800
+        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
+        functional-unit-time: "1 min"
+      inputs:
+        - timestamp: "2023-12-12T00:00:00.000Z"
+          duration: 1
+          cpu/utilization: 30
+          instance-type: A1 
+          region: uk-west
+          network/energy: 10
+          energy: 5
+        - timestamp: "2023-12-12T00:00:01.000Z"
+          duration: 5
+          cpu/utilization: 28
+          instance-type: A1 
+          region: uk-west
+          network/energy: 10
+          energy: 5
+        - timestamp: "2023-12-12T00:00:06.000Z"
+          duration: 7
+          cpu/utilization: 40
+          instance-type: A1 
+          region: uk-west
+          network/energy: 10
+          energy: 5
+        - timestamp: "2023-12-12T00:00:13.000Z"
+          duration: 30
+          cpu/utilization: 33
+          instance-type: A1 
+          region: uk-west
+          network/energy: 10
+          energy: 5

package/examples/manifests/pipeline-with-mocks.yml

@@ -0,0 +1,146 @@
+name: pipeline-with-mock-obs-demo
+description:
+tags:
+aggregation:
+  metrics:
+    - 'carbon'
+  type: 'both'
+initialize:
+  plugins:
+    mock-observations:
+      kind: plugin
+      method: MockObservations
+      path: '@grnsft/if-plugins'
+      global-config:
+        timestamp-from: 2023-07-06T00:00
+        timestamp-to: 2023-07-06T00:10
+        duration: 60
+        components:
+          - instance-type: A1
+        generators:
+          common:
+            region: uk-west
+            common-key: common-val
+          randint:
+            cpu/utilization:
+              min: 1
+              max: 99
+    "teads-curve":
+      path: "@grnsft/if-unofficial-plugins"
+      method: TeadsCurve
+      global-config:
+        interpolation: spline
+    "sci-e":
+      path: "@grnsft/if-plugins"
+      method: SciE
+    "sci-m":
+      path: "@grnsft/if-plugins"
+      method: SciM
+    "sci-o":
+      path: "@grnsft/if-plugins"
+      method: SciO
+    "sci":
+      path: "@grnsft/if-plugins"
+      method: Sci
+      global-config:
+        functional-unit: "requests"
+        functional-unit-time: "1 minute"
+    "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
+    'group-by':
+      path: builtin
+      method: GroupBy
+tree:
+  children:
+    child-1:
+      pipeline:
+        - teads-curve
+        - sci-e
+        - sci-m
+        - sci-o
+        - time-sync
+        - sci
+      config:
+        group-by:
+          group:
+            - region
+            - instance-type
+      defaults:
+        cpu/thermal-design-power: 100
+        grid/carbon-intensity: 800
+        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
+        functional-unit-time: "1 min"
+      inputs:
+        - timestamp: "2023-12-12T00:00:00.000Z"
+          instance-type: A1 
+          region: uk-west
+          duration: 1
+          cpu/utilization: 10
+        - timestamp: "2023-12-12T00:00:01.000Z"
+          duration: 5
+          cpu/utilization: 20
+          instance-type: A1 
+          region: uk-west
+        - timestamp: "2023-12-12T00:00:06.000Z"
+          duration: 7
+          cpu/utilization: 15
+          instance-type: A1 
+          region: uk-west
+        - timestamp: "2023-12-12T00:00:13.000Z"
+          duration: 30
+          instance-type: A1 
+          region: uk-west
+          cpu/utilization: 15
+    child-2:
+      pipeline:
+        - teads-curve
+        - sci-e
+        - sci-m
+        - sci-o
+        - time-sync
+        - sci
+      config:
+        group-by:
+          group:
+            - region
+            - instance-type
+      defaults:
+        cpu/thermal-design-power: 100
+        grid/carbon-intensity: 800
+        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
+        functional-unit-time: "1 min"
+      inputs:
+        - timestamp: "2023-12-12T00:00:00.000Z"
+          duration: 1
+          cpu/utilization: 30
+          instance-type: A1 
+          region: uk-west
+        - timestamp: "2023-12-12T00:00:01.000Z"
+          duration: 5
+          cpu/utilization: 28
+          instance-type: A1 
+          region: uk-west
+        - timestamp: "2023-12-12T00:00:06.000Z"
+          duration: 7
+          cpu/utilization: 40
+          instance-type: A1 
+          region: uk-west
+        - timestamp: "2023-12-12T00:00:13.000Z"
+          duration: 30
+          cpu/utilization: 33
+          instance-type: A1 
+          region: uk-west

package/examples/{impls/test → manifests}/sci-e.yml

@@ -2,13 +2,11 @@ name: sci-e-demo
 description:
 tags:
 initialize:
-  models:
-    - name: sci-e
-      kind: plugin
-      verbose: false
-      model: SciEModel
-      path: "@grnsft/if-models"
-graph:
+  plugins:
+    "sci-e":
+      method: SciE
+      path: "@grnsft/if-plugins"
+tree:
   children:
     child:
       pipeline:
@@ -18,4 +16,4 @@ graph:
       inputs:
         - timestamp: 2023-08-06T00:00
           duration: 3600
-          energy-cpu: 0.001
+          cpu/energy: 0.001

package/examples/manifests/sci-m.yml

@@ -0,0 +1,23 @@
+name: sci-m
+description: simple demo invoking sci-m
+tags:
+initialize:
+  plugins:
+    "sci-m": # a model that calculates m from te, tir, el, rr and rtor
+      method: SciM
+      verbose: false
+      path: "@grnsft/if-plugins"
+tree:
+  children:
+    child:
+      pipeline:
+        - sci-m # 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