@grnsft/if 0.4.0-beta.1 → 0.5.0-beta.0

package/manifests/examples/generics.yml

@@ -3,24 +3,53 @@ description: a pipeline that does arbitrary calculations using our generic arith
 tags:
 initialize:
   plugins:
-    teads-curve:
-      path: "@grnsft/if-unofficial-plugins"
-      method: TeadsCurve
+    "interpolate":
+      method: Interpolation
+      path: 'builtin'
       global-config:
-        interpolation: spline
-    "sum":
+        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"
-      method: Sum
       global-config:
-        input-parameters:
-          - cpu/energy
-          - network/energy
-        output-parameter: energy-sum
+        numerator: cpu-energy-raw
+        denominator: vcpu-ratio
+        output: cpu-energy-kwh
     "coefficient":
       path: "builtin"
       method: Coefficient
       global-config:
-        input-parameter: energy
+        input-parameter: cpu-energy-kwh
         coefficient: 2
         output-parameter: energy-doubled
     "multiply":
@@ -33,13 +62,19 @@ tree:
   children:
     child-1:
       pipeline:
-        - teads-curve
-        - sum
+        - interpolate
+        - cpu-factor-to-wattage
+        - wattage-times-duration
+        - wattage-to-energy-kwh
+        - calculate-vcpu-ratio
+        - correct-cpu-energy-for-vcpu-ratio      
         - coefficient
         - multiply
       config:
       defaults:
         cpu/thermal-design-power: 100
+        vcpus-allocated: 1
+        vcpus-total: 8
       inputs:
         - timestamp: "2023-12-12T00:00:00.000Z"
           cloud/instance-type: A1

package/manifests/examples/instance-metadata.yml

@@ -1,6 +1,6 @@
 name: csv-demo
-description: null
-tags: null
+description:
+tags:
 initialize:
   plugins:
     cloud-instance-metadata:
@@ -19,8 +19,8 @@ initialize:
         parameter: cpu-model-name
         match: /^([^,])+/g
         output: cpu/name
-  outputs:
-    - yaml
+  # outputs:
+  #   - yaml
 tree:
   children:
     child:

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

@@ -21,8 +21,14 @@ initialize:
       global-config:
         interpolation: spline  
     cloud-metadata:
-      method: CloudMetadata
-      path: "@grnsft/if-plugins"   
+      path: builtin
+      method: CSVLookup
+      global-config:
+        filepath: >-
+          https://raw.githubusercontent.com/Green-Software-Foundation/if-data/main/cloud-metdata-azure-instances.csv
+        query:
+          instance-class: cloud/instance-type
+        output: ['cpu-cores-utilized', 'vcpus-allocated']
     mock-observations:
       path: 'builtin'
       method: MockObservations

package/manifests/examples/nesting.yml

@@ -7,31 +7,62 @@ tags:
 aggregation:
   metrics:
     - "carbon"
-    - "energy"
   type: "both"
 params:
 initialize:
-  outputs: ['yaml']
+  # outputs: ['yaml']
   plugins:
-    teads-curve:
-      path: "@grnsft/if-unofficial-plugins"
-      method: TeadsCurve
+    "interpolate":
+      method: Interpolation
+      path: 'builtin'
       global-config:
-        interpolation: spline
-    sum:
+        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"
-      method: Sum
       global-config:
-        input-parameters:
-          - cpu/energy
-          - network/energy
-        output-parameter: energy
+        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-kwh
     sci-embodied:
       path: "builtin"
       method: SciEmbodied
-    sci-o:
-      path: "@grnsft/if-plugins"
-      method: SciO
+    "operational-carbon":
+      method: Multiply
+      path: builtin
+      global-config:
+        input-parameters: ["cpu-energy-kwh", "grid/carbon-intensity"]
+        output-parameter: "carbon-operational"
     sci:
       path: "builtin"
       method: Sci
@@ -62,13 +93,17 @@ tree:
         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
+        vcpus-allocated: 1
+        vcpus-total: 8
       pipeline:
-        - teads-curve
-        - sum
+        - interpolate
+        - cpu-factor-to-wattage
+        - wattage-times-duration
+        - wattage-to-energy-kwh
+        - calculate-vcpu-ratio
+        - correct-cpu-energy-for-vcpu-ratio
         - sci-embodied
-        - sci-o
+        - operational-carbon
         - sum-carbon
         - time-sync
         - sci
@@ -108,13 +143,17 @@ tree:
         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
+        vcpus-allocated: 1
+        vcpus-total: 8
       pipeline:
-        - teads-curve
-        - sum
+        - interpolate
+        - cpu-factor-to-wattage
+        - wattage-times-duration
+        - wattage-to-energy-kwh
+        - calculate-vcpu-ratio
+        - correct-cpu-energy-for-vcpu-ratio
         - sci-embodied
-        - sci-o
+        - operational-carbon
         - sum-carbon
         - time-sync
         - sci
@@ -156,13 +195,17 @@ tree:
             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
+            vcpus-allocated: 1
+            vcpus-total: 8
           pipeline:
-            - teads-curve
-            - sum
+            - interpolate
+            - cpu-factor-to-wattage
+            - wattage-times-duration
+            - wattage-to-energy-kwh
+            - calculate-vcpu-ratio
+            - correct-cpu-energy-for-vcpu-ratio
             - sci-embodied
-            - sci-o
+            - operational-carbon
             - sum-carbon
             - time-sync
             - sci
@@ -202,13 +245,17 @@ tree:
             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
+            vcpus-allocated: 1
+            vcpus-total: 8
           pipeline:
-            - teads-curve
-            - sum
+            - interpolate
+            - cpu-factor-to-wattage
+            - wattage-times-duration
+            - wattage-to-energy-kwh
+            - calculate-vcpu-ratio
+            - correct-cpu-energy-for-vcpu-ratio
             - sci-embodied
-            - sci-o
+            - operational-carbon
             - sum-carbon
             - time-sync
             - sci

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

@@ -3,25 +3,57 @@ description: a full pipeline seeded with some hardcoded input data and yielding
 tags:
 initialize:
   plugins:
-    "teads-curve":
-      path: "@grnsft/if-unofficial-plugins"
-      method: TeadsCurve
+    "interpolate":
+      method: Interpolation
+      path: 'builtin'
       global-config:
-        interpolation: spline
-    "sum":
+        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"
-      method: Sum
       global-config:
-        input-parameters:
-          - cpu/energy
-          - network/energy
-        output-parameter: energy
+        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-kwh
     "sci-embodied":
       path: "builtin"
       method: SciEmbodied
-    "sci-o":
-      path: "@grnsft/if-plugins"
-      method: SciO
+    "operational-carbon":
+      method: Multiply
+      path: builtin
+      global-config:
+        input-parameters: ["cpu-energy-kwh", "grid/carbon-intensity"]
+        output-parameter: "carbon-operational"
     "sci":
       path: "builtin"
       method: Sci
@@ -47,10 +79,14 @@ tree:
   children:
     child-1:
       pipeline:
-        - teads-curve
-        - sum
+        - interpolate
+        - cpu-factor-to-wattage
+        - wattage-times-duration
+        - wattage-to-energy-kwh
+        - calculate-vcpu-ratio
+        - correct-cpu-energy-for-vcpu-ratio
         - sci-embodied
-        - sci-o
+        - operational-carbon
         - sum-carbon
         - sci
       config:
@@ -60,8 +96,8 @@ tree:
         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
+        vcpus-total: 8
+        vcpus-allocated: 1
         component: 1
       inputs:
         - timestamp: "2023-12-12T00:00:00.000Z"

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

@@ -7,25 +7,62 @@ aggregation:
   type: "both"
 initialize:
   plugins:
-    "teads-curve":
-      path: "@grnsft/if-unofficial-plugins"
-      method: TeadsCurve
+    "interpolate":
+      method: Interpolation
+      path: 'builtin'
       global-config:
-        interpolation: spline
-    "sci-e":
-      path: "@grnsft/if-plugins"
-      method: SciE
+        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-kwh
     "sci-embodied":
       path: "builtin"
       method: SciEmbodied
-    "sci-o":
-      path: "@grnsft/if-plugins"
-      method: SciO
+    "operational-carbon":
+      method: Multiply
+      path: builtin
+      global-config:
+        input-parameters: ["cpu-energy-kwh", "grid/carbon-intensity"]
+        output-parameter: "carbon-operational"
     "sci":
       path: "builtin"
       method: Sci
       global-config:
-        functional-unit: "requests"
+        functional-unit: requests # factor to convert per time to per f.unit
     "sum-carbon":
       path: "builtin"
       method: Sum
@@ -42,17 +79,18 @@ initialize:
         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
+        - interpolate
+        - cpu-factor-to-wattage
+        - wattage-times-duration
+        - wattage-to-energy-kwh
+        - calculate-vcpu-ratio
+        - correct-cpu-energy-for-vcpu-ratio
         - sci-embodied
-        - sci-o
+        - operational-carbon
         - sum-carbon
         - time-sync
         - sci
@@ -67,8 +105,8 @@ tree:
         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
+        vcpus-total: 8
+        vcpus-allocated: 1
       inputs:
         - timestamp: "2023-12-12T00:00:00.000Z"
           cloud/instance-type: A1
@@ -96,10 +134,14 @@ tree:
           requests: 30
     child-2:
       pipeline:
-        - teads-curve
-        - sci-e
+        - interpolate
+        - cpu-factor-to-wattage
+        - wattage-times-duration
+        - wattage-to-energy-kwh
+        - calculate-vcpu-ratio
+        - correct-cpu-energy-for-vcpu-ratio
         - sci-embodied
-        - sci-o
+        - operational-carbon
         - sum-carbon
         - time-sync
         - sci
@@ -114,8 +156,8 @@ tree:
         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
+        vcpus-total: 8
+        vcpus-allocated: 1
       inputs:
         - timestamp: "2023-12-12T00:00:00.000Z"
           duration: 1

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

@@ -25,20 +25,57 @@ initialize:
             cpu/utilization:
               min: 1
               max: 99
-    "teads-curve":
-      path: "@grnsft/if-unofficial-plugins"
-      method: TeadsCurve
+    "interpolate":
+      method: Interpolation
+      path: 'builtin'
       global-config:
-        interpolation: spline
-    "sci-e":
-      path: "@grnsft/if-plugins"
-      method: SciE
+        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-kwh
     "sci-embodied":
       path: "builtin"
       method: SciEmbodied
-    "sci-o":
-      path: "@grnsft/if-plugins"
-      method: SciO
+    "operational-carbon":
+      method: Multiply
+      path: builtin
+      global-config:
+        input-parameters: ["cpu-energy-kwh", "grid/carbon-intensity"]
+        output-parameter: "carbon-operational"
     "sum-carbon":
       path: "builtin"
       method: Sum
@@ -68,10 +105,14 @@ tree:
   children:
     child-1:
       pipeline:
-        - teads-curve
-        - sci-e
+        - interpolate
+        - cpu-factor-to-wattage
+        - wattage-times-duration
+        - wattage-to-energy-kwh
+        - calculate-vcpu-ratio
+        - correct-cpu-energy-for-vcpu-ratio
         - sci-embodied
-        - sci-o
+        - operational-carbon
         - sum-carbon
         - time-sync
         - sci
@@ -86,9 +127,8 @@ tree:
         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"
+        vcpus-total: 8
+        vcpus-allocated: 1
       inputs:
         - timestamp: "2023-12-12T00:00:00.000Z"
           cloud/instance-type: A1
@@ -116,10 +156,14 @@ tree:
           requests: 50
     child-2:
       pipeline:
-        - teads-curve
-        - sci-e
+        - interpolate
+        - cpu-factor-to-wattage
+        - wattage-times-duration
+        - wattage-to-energy-kwh
+        - calculate-vcpu-ratio
+        - correct-cpu-energy-for-vcpu-ratio
         - sci-embodied
-        - sci-o
+        - operational-carbon
         - sum-carbon
         - time-sync
         - sci
@@ -134,9 +178,8 @@ tree:
         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"
+        vcpus-total: 8
+        vcpus-allocated: 1
       inputs:
         - timestamp: "2023-12-12T00:00:00.000Z"
           duration: 1

package/manifests/examples/region-metadata.yml

@@ -0,0 +1,26 @@
+name: csv-demo
+description:
+tags:
+initialize:
+  plugins:
+    cloud-region-metadata:
+      method: CSVLookup
+      path: "builtin"
+      global-config:
+        filepath: https://raw.githubusercontent.com/Green-Software-Foundation/if-data/main/region-metadata.csv
+        query:
+          cloud-provider: cloud-provider 
+          cloud-region: cloud-region
+        output: "*"
+tree:
+  children:
+    child:
+      pipeline:
+        - cloud-region-metadata
+      inputs:
+        - timestamp: 2023-08-06T00:00
+          duration: 3600
+          cpu/energy: 0.001
+          instance-id: AMD A10-9700
+          cloud-provider: "Google Cloud"
+          cloud-region: "asia-east1"