@grnsft/if 0.3.4 → 0.4.0-beta.1

package/manifests/examples/mock-cpu-util-to-carbon.yml

@@ -1,13 +1,13 @@
 name: mock-cpu-util-to-carbon
 description: a complete pipeline that starts with mocked CPU utilization data and outputs operational carbon in gCO2eq
 initialize:
-  outputs: ['yaml']
+  #outputs: ['yaml']
   plugins: 
     group-by: 
       path: 'builtin'
       method: GroupBy   
     operational-carbon:
-      path: '@grnsft/if-plugins'
+      path: 'builtin'
       method: Multiply
       global-config:
         input-parameters: ['cpu/energy', 'grid/carbon-intensity']
@@ -24,7 +24,7 @@ initialize:
       method: CloudMetadata
       path: "@grnsft/if-plugins"   
     mock-observations:
-      path: '@grnsft/if-plugins'
+      path: 'builtin'
       method: MockObservations
       global-config:
         timestamp-from: '2024-03-05T00:00:00.000Z'

package/manifests/examples/nesting.yml

@@ -19,25 +19,32 @@ initialize:
       global-config:
         interpolation: spline
     sum:
-      path: "@grnsft/if-plugins"
+      path: "builtin"
       method: Sum
       global-config:
         input-parameters:
           - cpu/energy
           - network/energy
         output-parameter: energy
-    sci-m:
-      path: "@grnsft/if-plugins"
-      method: SciM
+    sci-embodied:
+      path: "builtin"
+      method: SciEmbodied
     sci-o:
       path: "@grnsft/if-plugins"
       method: SciO
     sci:
-      path: "@grnsft/if-plugins"
+      path: "builtin"
       method: Sci
       global-config:
         functional-unit: "requests"
-        functional-unit-time: "1 minute"
+    "sum-carbon":
+      path: "builtin"
+      method: Sum
+      global-config:
+        input-parameters:
+          - carbon-operational
+          - carbon-embodied
+        output-parameter: carbon
     time-sync:
       method: TimeSync
       path: "builtin"
@@ -60,8 +67,9 @@ tree:
       pipeline:
         - teads-curve
         - sum
-        - sci-m
+        - sci-embodied
         - sci-o
+        - sum-carbon
         - time-sync
         - sci
       inputs:
@@ -71,24 +79,28 @@ tree:
           duration: 1
           cpu/utilization: 50
           network/energy: 0.000001
+          requests: 50
         - timestamp: "2023-12-12T00:00:01.000Z"
           duration: 5
           cpu/utilization: 20
           cloud/instance-type: A1
           cloud/region: uk-west
           network/energy: 0.000001
+          requests: 60
         - timestamp: "2023-12-12T00:00:06.000Z"
           duration: 7
           cpu/utilization: 15
           cloud/instance-type: A1
           cloud/region: uk-west
           network/energy: 0.000001
+          requests: 70
         - timestamp: "2023-12-12T00:00:13.000Z"
           duration: 30
           cloud/instance-type: A1
           cloud/region: uk-west
           cpu/utilization: 15
           network/energy: 0.000001
+          requests: 55
     child-1:
       defaults:
         cpu/thermal-design-power: 100
@@ -101,8 +113,9 @@ tree:
       pipeline:
         - teads-curve
         - sum
-        - sci-m
+        - sci-embodied
         - sci-o
+        - sum-carbon
         - time-sync
         - sci
       inputs:
@@ -112,24 +125,28 @@ tree:
           duration: 1
           cpu/utilization: 50
           network/energy: 0.000001
+          requests: 10
         - timestamp: "2023-12-12T00:00:01.000Z"
           duration: 5
           cpu/utilization: 20
           cloud/instance-type: A1
           cloud/region: uk-west
           network/energy: 0.000001
+          requests: 90
         - timestamp: "2023-12-12T00:00:06.000Z"
           duration: 7
           cpu/utilization: 15
           cloud/instance-type: A1
           cloud/region: uk-west
           network/energy: 0.000001
+          requests: 30
         - timestamp: "2023-12-12T00:00:13.000Z"
           duration: 30
           cloud/instance-type: A1
           cloud/region: uk-west
           cpu/utilization: 15
           network/energy: 0.000001
+          requests: 22
     child-2:
       children:
         child-2-0:
@@ -144,8 +161,9 @@ tree:
           pipeline:
             - teads-curve
             - sum
-            - sci-m
+            - sci-embodied
             - sci-o
+            - sum-carbon
             - time-sync
             - sci
           inputs:
@@ -155,24 +173,28 @@ tree:
               duration: 1
               cpu/utilization: 50
               network/energy: 0.000001
+              requests: 50
             - timestamp: "2023-12-12T00:00:01.000Z"
               duration: 5
               cpu/utilization: 20
               cloud/instance-type: A1
               cloud/region: uk-west
               network/energy: 0.000001
+              requests: 65
             - timestamp: "2023-12-12T00:00:06.000Z"
               duration: 7
               cpu/utilization: 15
               cloud/instance-type: A1
               cloud/region: uk-west
               network/energy: 0.000001
+              requests: 80
             - timestamp: "2023-12-12T00:00:13.000Z"
               duration: 30
               cloud/instance-type: A1
               cloud/region: uk-west
               cpu/utilization: 15
               network/energy: 0.000001
+              requests: 40
         child-2-1:
           defaults:
             cpu/thermal-design-power: 100
@@ -185,8 +207,9 @@ tree:
           pipeline:
             - teads-curve
             - sum
-            - sci-m
+            - sci-embodied
             - sci-o
+            - sum-carbon
             - time-sync
             - sci
           inputs:
@@ -196,21 +219,25 @@ tree:
               duration: 1
               cpu/utilization: 50
               network/energy: 0.000001
+              requests: 50
             - timestamp: "2023-12-12T00:00:01.000Z"
               duration: 5
               cpu/utilization: 20
               cloud/instance-type: A1
               cloud/region: uk-west
               network/energy: 0.000001
+              requests: 50
             - timestamp: "2023-12-12T00:00:06.000Z"
               duration: 7
               cpu/utilization: 15
               cloud/instance-type: A1
               cloud/region: uk-west
               network/energy: 0.000001
+              requests: 60
             - timestamp: "2023-12-12T00:00:13.000Z"
               duration: 30
               cloud/instance-type: A1
               cloud/region: uk-west
               cpu/utilization: 15
               network/energy: 0.000001
+              requests: 40

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

@@ -9,25 +9,32 @@ initialize:
       global-config:
         interpolation: spline
     "sum":
-      path: "@grnsft/if-plugins"
+      path: "builtin"
       method: Sum
       global-config:
         input-parameters:
           - cpu/energy
           - network/energy
         output-parameter: energy
-    "sci-m":
-      path: "@grnsft/if-plugins"
-      method: SciM
+    "sci-embodied":
+      path: "builtin"
+      method: SciEmbodied
     "sci-o":
       path: "@grnsft/if-plugins"
       method: SciO
     "sci":
-      path: "@grnsft/if-plugins"
+      path: "builtin"
       method: Sci
       global-config:
-        functional-unit: ""
-        functional-unit-time: "1-day"
+        functional-unit: "component"
+    "sum-carbon":
+      path: "builtin"
+      method: Sum
+      global-config:
+        input-parameters:
+          - carbon-operational
+          - carbon-embodied
+        output-parameter: carbon
     "time-sync":
       method: TimeSync
       path: "builtin"
@@ -42,9 +49,9 @@ tree:
       pipeline:
         - teads-curve
         - sum
-        - sci-m
+        - sci-embodied
         - sci-o
-        - time-sync
+        - sum-carbon
         - sci
       config:
       defaults:
@@ -55,6 +62,7 @@ tree:
         device/expected-lifespan: 94608000 # 3 years in seconds
         resources-reserved: 1
         resources-total: 8
+        component: 1
       inputs:
         - timestamp: "2023-12-12T00:00:00.000Z"
           cloud/instance-type: A1

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

@@ -15,18 +15,25 @@ initialize:
     "sci-e":
       path: "@grnsft/if-plugins"
       method: SciE
-    "sci-m":
-      path: "@grnsft/if-plugins"
-      method: SciM
+    "sci-embodied":
+      path: "builtin"
+      method: SciEmbodied
     "sci-o":
       path: "@grnsft/if-plugins"
       method: SciO
     "sci":
-      path: "@grnsft/if-plugins"
+      path: "builtin"
       method: Sci
       global-config:
         functional-unit: "requests"
-        functional-unit-time: "1 minute"
+    "sum-carbon":
+      path: "builtin"
+      method: Sum
+      global-config:
+        input-parameters:
+          - carbon-operational
+          - carbon-embodied
+        output-parameter: carbon
     "time-sync":
       method: TimeSync
       path: "builtin"
@@ -44,8 +51,9 @@ tree:
       pipeline:
         - teads-curve
         - sci-e
-        - sci-m
+        - sci-embodied
         - sci-o
+        - sum-carbon
         - time-sync
         - sci
       config:
@@ -61,34 +69,38 @@ tree:
         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"
           cloud/instance-type: A1
           cloud/region: uk-west
           duration: 1
           cpu/utilization: 10
+          requests: 10
         - timestamp: "2023-12-12T00:00:01.000Z"
           duration: 5
           cpu/utilization: 20
           cloud/instance-type: A1
           cloud/region: uk-west
+          requests: 5
         - timestamp: "2023-12-12T00:00:06.000Z"
           duration: 7
           cpu/utilization: 15
           cloud/instance-type: A1
           cloud/region: uk-west
+          requests: 15
         - timestamp: "2023-12-12T00:00:13.000Z"
           duration: 30
           cloud/instance-type: A1
           cloud/region: uk-west
           cpu/utilization: 15
+          requests: 30
     child-2:
       pipeline:
         - teads-curve
         - sci-e
-        - sci-m
+        - sci-embodied
         - sci-o
+        - sum-carbon
         - time-sync
         - sci
       config:
@@ -104,25 +116,28 @@ tree:
         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
           cloud/instance-type: A1
           cloud/region: uk-west
+          requests: 100
         - timestamp: "2023-12-12T00:00:01.000Z"
           duration: 5
           cpu/utilization: 28
           cloud/instance-type: A1
           cloud/region: uk-west
+          requests: 150
         - timestamp: "2023-12-12T00:00:06.000Z"
           duration: 7
           cpu/utilization: 40
           cloud/instance-type: A1
           cloud/region: uk-west
+          requests: 110
         - timestamp: "2023-12-12T00:00:13.000Z"
           duration: 30
           cpu/utilization: 33
           cloud/instance-type: A1
           cloud/region: uk-west
+          requests: 180

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

@@ -10,7 +10,7 @@ initialize:
     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
@@ -33,18 +33,25 @@ initialize:
     "sci-e":
       path: "@grnsft/if-plugins"
       method: SciE
-    "sci-m":
-      path: "@grnsft/if-plugins"
-      method: SciM
+    "sci-embodied":
+      path: "builtin"
+      method: SciEmbodied
     "sci-o":
       path: "@grnsft/if-plugins"
       method: SciO
+    "sum-carbon":
+      path: "builtin"
+      method: Sum
+      global-config:
+        input-parameters:
+          - carbon-operational
+          - carbon-embodied
+        output-parameter: carbon
     "sci":
-      path: "@grnsft/if-plugins"
+      path: "builtin"
       method: Sci
       global-config:
         functional-unit: "requests"
-        functional-unit-time: "1 minute"
     "time-sync":
       method: TimeSync
       path: "builtin"
@@ -56,15 +63,16 @@ initialize:
     "group-by":
       path: builtin
       method: GroupBy
-  outputs: ['yaml']
+  # outputs: ['yaml']
 tree:
   children:
     child-1:
       pipeline:
         - teads-curve
         - sci-e
-        - sci-m
+        - sci-embodied
         - sci-o
+        - sum-carbon
         - time-sync
         - sci
       config:
@@ -87,27 +95,32 @@ tree:
           cloud/region: uk-west
           duration: 1
           cpu/utilization: 10
+          requests: 30
         - timestamp: "2023-12-12T00:00:01.000Z"
           duration: 5
           cpu/utilization: 20
           cloud/instance-type: A1
           cloud/region: uk-west
+          requests: 40
         - timestamp: "2023-12-12T00:00:06.000Z"
           duration: 7
           cpu/utilization: 15
           cloud/instance-type: A1
           cloud/region: uk-west
+          requests: 30
         - timestamp: "2023-12-12T00:00:13.000Z"
           duration: 30
           cloud/instance-type: A1
           cloud/region: uk-west
           cpu/utilization: 15
+          requests: 50
     child-2:
       pipeline:
         - teads-curve
         - sci-e
-        - sci-m
+        - sci-embodied
         - sci-o
+        - sum-carbon
         - time-sync
         - sci
       config:
@@ -130,18 +143,22 @@ tree:
           cpu/utilization: 30
           cloud/instance-type: A1
           cloud/region: uk-west
+          requests: 30
         - timestamp: "2023-12-12T00:00:01.000Z"
           duration: 5
           cpu/utilization: 28
           cloud/instance-type: A1
           cloud/region: uk-west
+          requests: 40
         - timestamp: "2023-12-12T00:00:06.000Z"
           duration: 7
           cpu/utilization: 40
           cloud/instance-type: A1
           cloud/region: uk-west
+          requests: 50
         - timestamp: "2023-12-12T00:00:13.000Z"
           duration: 30
           cpu/utilization: 33
           cloud/instance-type: A1
           cloud/region: uk-west
+          requests: 60

package/manifests/examples/sci.yml

@@ -0,0 +1,131 @@
+name: pipeline-teads-sci
+description: a full pipeline seeded with some hardcoded input data and yielding an SCI score
+tags:
+initialize:
+  plugins:
+    interpolate:
+      method: Interpolation
+      path: 'builtin'
+      global-config:
+        method: linear
+        x: [0, 10, 50, 100]
+        y: [0.12, 0.32, 0.75, 1.02]
+        input-parameter: 'cpu/utilization'
+        output-parameter: 'cpu-factor'
+    cpu-factor-to-wattage:
+      method: Multiply
+      path: builtin
+      global-config:
+        input-parameters: ["cpu-factor", "cpu/thermal-design-power"]
+        output-parameter: "cpu-wattage"
+    wattage-times-duration:
+      method: Multiply
+      path: builtin
+      global-config:
+        input-parameters: ["cpu-wattage", "duration"]
+        output-parameter: "cpu-wattage-times-duration"
+    wattage-to-energy-kwh:
+      method: Divide
+      path: "builtin"
+      global-config:
+        numerator: cpu-wattage-times-duration
+        denominator: 3600000
+        output: cpu-energy-raw
+    calculate-vcpu-ratio:
+      method: Divide
+      path: "builtin"
+      global-config:
+        numerator: vcpus-total
+        denominator: vcpus-allocated
+        output: vcpu-ratio
+    correct-cpu-energy-for-vcpu-ratio:
+      method: Divide
+      path: "builtin"
+      global-config:
+        numerator: cpu-energy-raw
+        denominator: vcpu-ratio
+        output: cpu/energy
+    sum-energy-components:
+      path: "builtin"
+      method: Sum
+      global-config:
+        input-parameters:
+          - cpu/energy
+          - network/energy
+        output-parameter: energy
+    "embodied-carbon":
+      path: "builtin"
+      method: SciEmbodied
+    "operational-carbon":
+      method: Multiply
+      path: builtin
+      global-config:
+        input-parameters: ["energy", "grid/carbon-intensity"]
+        output-parameter: "carbon-operational"
+    "sum-carbon":
+      path: "builtin"
+      method: Sum
+      global-config:
+        input-parameters:
+          - carbon-operational
+          - carbon-embodied
+        output-parameter: carbon
+    "sci":
+      path: "builtin"
+      method: Sci
+      global-config:
+        functional-unit: "component"
+  outputs:
+    - yaml
+tree:
+  children:
+    child-1:
+      pipeline:
+        - interpolate
+        - cpu-factor-to-wattage
+        - wattage-times-duration
+        - wattage-to-energy-kwh
+        - calculate-vcpu-ratio
+        - correct-cpu-energy-for-vcpu-ratio
+        - sum-energy-components
+        - embodied-carbon
+        - operational-carbon
+        - sum-carbon
+        - sci
+      config:
+      defaults:
+        cpu/thermal-design-power: 100
+        vcpus-total: 8
+        vcpus-allocated: 2
+        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: vcpus-allocated
+        resources-total: vcpus-total
+        component: 1
+      inputs:
+        - timestamp: "2023-12-12T00:00:00.000Z"
+          cloud/instance-type: A1
+          cloud/region: uk-west
+          duration: 1
+          cpu/utilization: 50
+          network/energy: 0.000001
+        - timestamp: "2023-12-12T00:00:01.000Z"
+          duration: 5
+          cpu/utilization: 20
+          cloud/instance-type: A1
+          cloud/region: uk-west
+          network/energy: 0.000001
+        - timestamp: "2023-12-12T00:00:06.000Z"
+          duration: 7
+          cpu/utilization: 15
+          cloud/instance-type: A1
+          cloud/region: uk-west
+          network/energy: 0.000001
+        - timestamp: "2023-12-12T00:00:13.000Z"
+          duration: 30
+          cloud/instance-type: A1
+          cloud/region: uk-west
+          cpu/utilization: 15
+          network/energy: 0.000001