@grnsft/if 0.0.2

package/examples/impls/case-studies/msft-eshoppen.yaml

@@ -0,0 +1,162 @@
+name: msft-eshoppen
+description: https://github.com/Green-Software-Foundation/sci-guide/blob/dev/use-case-submissions/msft-eShoppen.md
+tags:
+  kind: web
+  complexity: moderate
+  category: cloud
+initialize:
+  models:
+    - name: eshoppen-cpu # calculates e due to memory util ((mem-util * mem-allocated * mem-energy)/1000 = energy-memory)
+      kind: energy-cpu
+      path: false
+      verbose: false
+    - name: eshoppen-mem # calculates e due to memory util ((mem-util * mem-allocated * mem-energy)/1000 = energy-memory)
+      kind: energy-memory
+      path: false
+      verbose: false
+    - name: eshoppen-net # calculates e due to memory util ((mem-util * mem-allocated * mem-energy)/1000 = energy-memory)
+      kind: energy-network
+      path: false
+      verbose: false
+    - name: sci-e # sums energy-cpu and energy-memory
+      kind: builtin
+      path: ''
+      verbose: false
+    - name: sci-m # a model that calculates m from te, tir, el, rr and rtor
+      kind: builtin
+      path: ''
+      verbose: false
+    - name: sci-o # takes in total e and outputs operational emissions
+      kind: builtin
+      path: ''
+    - name: sci # sums SCI components and converts to f.unit
+      kind: builtin
+      path: ''
+graph:
+  children:
+    front-end:
+      pipeline:
+        - eshoppen-cpu # thermal-design-power & cpu -> energy
+        - eshoppen-mem # n-hours * n-chips * thermal-design-power-mem * thermal-design-power-coeff
+        - sci-m # duration & config -> embodied
+        - sci-e # energy & grid-carbon-intensity & embodied -> carbon
+        - sci-o # e -> c
+        - sci # -> f.unit
+      config:
+        energy-memory-thermal-design-power:
+          n-hours: 1
+          n-chips: 1
+          thermal-design-power-mem: 12.16
+          thermal-design-power-coeff: 0.12
+        sci-m:
+          total-embodied-emissions: 350000 # kgCO2eq
+          time-reserved: 3600 # == the duration field
+          expected-lifespan: 126144000 # 4 years in seconds
+          resources-reserved: 1
+          total-resources: 1
+        sci-o:
+          grid-carbon-intensity: 951 # gCO2e/kWh
+        energy-cpu:
+          physical-processor: Intel® Core™ i7-1185G7
+          thermal-design-power: 28 # W
+          thermal-design-power-coeff: 0.12
+          n-hours: 1
+          n-chips: 1
+        sci:
+          functional-unit-duration: 1 
+          functional-duration-time: ''
+          functional-unit: requests # factor to convert per time to per f.unit
+      inputs:
+        - timestamp: 2023-07-06T00:00 # [KEYWORD] [NO-SUBFIELDS] time when measurement occurred
+          duration: 3600 # Secs
+          cpu-util: 0
+    app-server:
+      pipeline: # note: no energy-memory calc applied here
+        - eshoppen-cpu # thermal-design-power & cpu -> energy
+        - sci-e # sums e components
+        - sci-m # duration & config -> embodied
+        - sci-o # energy & grid-carbon-intensity & embodied -> carbon
+        - sci
+      config:
+        sci-m:
+          total-embodied-emissions: 1205520 # kgCO2eq
+          time-reserved: 1 # == duration field
+          expected-lifespan: 35040 # 4 years in seconds
+          resources-reserved: 2 # using cores
+          total-resources: 16 # the original report has a typo, says 16 but actually has 26 cores.
+        sci-o:
+          grid-carbon-intensity: 951 # gCO2e/kWh
+        energy-cpu:
+          physical-processor: Intel® Xeon® Platinum 8272CL
+          thermal-design-power: 205
+          thermal-design-power-coeff: 0.32
+          n-hours: 1
+          n-chips: 1
+        sci:
+          functional-unit-duration: 1 
+          functional-duration-time: ''
+          functional-unit: requests # factor to convert per time to per f.unit
+      inputs:
+        - timestamp: 2023-07-06T00:00 # [KEYWORD] [NO-SUBFIELDS] time when measurement occurred
+          duration: 3600
+          cpu-util: 18.392
+    db-server:
+      pipeline: # no energy-memory calc applied here
+        - eshoppen-cpu # thermal-design-power & cpu & duration-> energy
+        - sci-e # sums e-components
+        - sci-m # duration & config -> embodied
+        - sci-o # energy & grid-carbon-intensity & embodied -> carbon
+      config:
+        sci-o:
+          grid-carbon-intensity: 1000 # gCO2e/kWh
+        sci-m:
+          total-embodied-emissions: 1433120 # kgCO2eq
+          time-reserved: 1 # == duration field
+          expected-lifespan: 35040 # 4 years in hours
+          resources-reserved: 2 # using cores
+          total-resources: 16 # total cores
+        sci-c:
+          grid-carbon-intensity: 951
+        energy-cpu:
+          n-hours: 1
+          n-chips: 1
+          physical-processor: Intel® Xeon® Platinum 8160
+          thermal-design-power: 150 # W
+          thermal-design-power-coeff: 0.32
+        sci:
+          functional-unit-duration: 1 
+          functional-duration-time: ''
+          functional-unit: requests # factor to convert per time to per f.unit
+      inputs:
+        - timestamp: 2023-07-06T00:00 # [KEYWORD] [NO-SUBFIELDS] time when measurement occurred
+          duration: 3600
+          cpu-util: 10
+          grid-carbon-intensity: 1000
+    network:
+      pipeline:
+        - eshoppen-net
+        - sci-e # sums e components
+        - sci-m
+        - sci-o
+        - sci
+      config:
+        sci-m:
+          total-embodied-emissions: 0 # kgCO2eq
+          time-reserved: 1 # == duration field
+          expected-lifespan: 35040 # 4 years in seconds
+          resources-reserved: 1 # using cores
+          total-resources: 1 # total cores
+        energy-network:
+          net-energy: 0.001 #kwh/GB
+        sci:
+          functional-unit-duration: 1 
+          functional-duration-time: ''
+          functional-unit: requests # factor to convert per time to per f.unit
+        sci-o:
+          grid-carbon-intensity: 951
+      inputs:
+        - timestamp: 2023-07-06T00:00
+          duration: 3600
+          data-in: 1.16
+          data-out: 14.3
+

package/examples/impls/case-studies/msft-green-ai.yaml

@@ -0,0 +1,58 @@
+name: mft-green-ai
+description: "https://github.com/Green-Software-Foundation/sci-guide/blob/dev/use-case-submissions/msft-green-ai.md"
+tags:
+  kind: ml
+  complexity: simple
+  category: cloud
+initialize:
+  models:
+    - name: sci-o # a model that given e, i and m calculates a carbon value (e * i) + m
+      kind: builtin
+      verbose: false
+      path: ''
+    - name: wattime
+      kind: builtin
+      verbose: false
+      path: ''
+    - name: sci
+      kind: builtin
+      verbose: false
+      path: ''
+graph:
+  DenseNet: # an advanced grouping node
+    pipeline: 
+      - sci-o # energy & grid-carbon-intensity & embodied -> carbon
+      - watttime
+      - add-obs
+      - sci
+    config: 
+      sci-o:
+        physical-processor: nvidia-t4-nc16as-v3
+        grid-carbon-intensity: 1 # data not provided in case study
+        embodied-carbon: 0
+        sci:
+          functional-unit-duration: '' # signal to convert /s -> /hr
+          functional-unit: '' # factor to convert per time to per f.unit ()
+    inputs: 
+      - timestamp: 2023-07-06T00:00
+        duration: 1336 # 22.27 min runtime in seconds
+        energy: 17.97
+  InceptionV3: # an advanced grouping node
+    pipeline: 
+      - sci-o # energy & grid-carbon-intensity & embodied -> carbon
+      - watttime
+      - add-obs
+      - sci
+    config: 
+      sci-o:
+        physical-processor: nvidia-t4-nc16as-v3
+        grid-carbon-intensity: 1 # data not provided in case study
+        embodied-carbon: 0
+      sci:
+          functional-unit-duration: 1 
+          functional-duration-time: ''
+          functional-unit: requests # factor to convert per time to per f.unit
+    inputs: 
+      - timestamp: 2023-07-06T00:00
+        duration: 1205 # 22.27 min runtime in seconds
+        energy: 14.37

package/examples/impls/case-studies/ntt-data-on-premise.yaml

@@ -0,0 +1,201 @@
+name: ntt-data-on-premise
+description: https://github.com/Green-Software-Foundation/sci-guide/blob/dev/use-case-submissions/nttdatta-On-Premise-Web-system.md
+tags:
+  kind: web
+  complexity: moderate
+  category: on-premise
+initialize:
+  models:
+    - name: sci-e
+      kind: builtin
+      verbose: false
+      path: ''
+    - name: sci-m # a model that calculates m from te, tir, el, rr and rtor
+      kind: builtin
+      verbose: false
+      path: ''
+    - name: sci-o # a model that given e, i and m calculates a carbon value (e * i) + m
+      kind: builtin
+      verbose: false
+      path: ''
+    - name: sci # a model that given e, i and m calculates a carbon value (e * i) + m
+      kind: builtin
+      verbose: false
+      path: ''
+graph:
+  children:
+    layer-3-switch: # an advanced grouping node
+      pipeline:
+        - sci-e
+        - sci-m
+        - sci-o
+        - sci
+      config:
+        sci-m:
+          total-embodied-emissions: 251000 # gCO2eq
+          time-reserved: 3600 # 1 hour in s
+          expected-lifespan: 126144000 # 4 years in seconds    
+          resources-reserved: 1 
+          total-resources: 1 
+        sci-o:
+          grid-carbon-intensity: 457 # gCO2/kwh
+        sci:
+          functional-unit-duration: 1 
+          functional-duration-time: ''
+          functional-unit: requests # factor to convert per time to per f.unit
+      inputs: 
+        - timestamp: 2023-07-06T00:00
+          duration: 3600
+          five-min-input-ratotal-embodied-emissions: 100
+          five-min-output-ratotal-embodied-emissions: 100
+          grid-carbon-intensity: 457 # gCO2e/kWh
+          energy-network: 0.00496 # 3.85e-3 * 24 ports * 1.5 (pue)
+          requests: 38032740
+    layer-2-switch:
+      pipeline:
+        - sci-e
+        - sci-m
+        - sci-o
+        - sci
+      config:
+        sci-m:
+          total-embodied-emissions: 251000 # gCO2eq
+          time-reserved: 3600 # get from the duration field
+          expected-lifespan: 126144000 # 4 years in seconds    
+          resources-reserved: 1
+          total-resources: 1
+        sci-o:
+          grid-ci: 457 # gCO2/kwh 
+        sci:
+          functional-unit-duration: 1 
+          functional-duration-time: ''
+          functional-unit: requests # factor to convert per time to per f.unit
+      children:
+        switch-1:
+          inputs:
+            - timestamp: 2023-07-06T00:00
+              duration: 1
+              energy-network: 0.000811 #kwh     
+              grid-carbon-intensity: 457 # gCO2e/kWh
+              requests: 38032740
+        switch-2:
+          inputs: 
+            - timestamp: 2023-07-06T00:00
+              duration: 1
+              energy-network: 0 # no traffic at all
+              grid-carbon-intensity: 457 # gCO2e/kWh
+              requests: 38032740
+        switch-3:
+          inputs:
+            - timestamp: 2023-07-06T00:00
+              duration: 1
+              energy-network: 0.000955 #kwh
+              grid-carbon-intensity: 457 # gCO2e/kWh
+              requests: 38032740
+        switch-4:
+          inputs:
+            - timestamp: 2023-07-06T00:00
+              duration: 1
+              energy-network: 1.14e-8 #kwh
+              grid-carbon-intensity: 457 # gCO2e/kWh
+              requests: 38032740
+    db-servers:
+      pipeline:
+        - sci-e
+        - sci-m
+        - sci-o
+        - sci
+      config:
+        sci-m:
+          total-embodied-emissions: 6270000 # gCO2eq
+          time-reserved: duration # get from the duration field
+          expected-lifespan: 126144000 # 4 years in seconds
+          resources-reserved: 1
+          total-resources: 1
+        sci-o:
+          grid-carbon-intensity: 457 # gCO2/kwh
+        sci:
+          functional-unit-duration: ''
+          functional-unit: requests
+      children:
+        db-server1:
+          inputs:
+            - timestamp: 2023-07-06T00:00
+              energy-cpu: 0.258
+              duration: 1 #s
+              grid-carbon-intensity: 457 # gCO2e/kWh
+              requests: 38032740
+        db-server2:
+          inputs:
+            - timestamp: 2023-07-06T00:00
+              energy-cpu: 0.193
+              duration: 1 #s
+              grid-carbon-intensity: 457 # gCO2e/kWh
+              requests: 38032740
+    app-servers:
+      pipeline:
+        - sci-e
+        - sci-m
+        - sci-o
+        - sci
+      config:
+        sci-m:
+          total-embodied-emissions: 6270000 # gCO2eq
+          time-reserved: duration # get from the duration field
+          expected-lifespan: 126144000 # 4 years in seconds    
+          resources-reserved: 1 
+          total-resources: 1 
+        sci-o:
+          grid-carbon-intensity: 457 # gCO2/kwh
+        sci:
+          functional-unit-duration: 1 
+          functional-duration-time: ''
+          functional-unit: requests # factor to convert per time to per f.unit 
+      children:
+        app-server1:
+          inputs: 
+            - timestamp: 2023-07-06T00:00
+              duration: 1
+              energy-cpu: 0.149
+              grid-carbon-intensity: 457 # gCO2e/kWh
+        app-server2:
+          inputs:  
+            - timestamp: 2023-07-06T00:00
+              duration: 1
+              energy-cpu: 0.147
+              grid-carbon-intensity: 457 # gCO2e/kWh
+              requests: 38032740
+    web-servers:
+      pipeline: 
+        - sci-e
+        - sci-m
+        - sci-o
+        - sci
+      config:
+        sci-m:
+          total-embodied-emissions: 6270000 # gCO2eq
+          time-reserved: duration # get from the duration field
+          expected-lifespan: 126144000 # 4 years in seconds    
+          resources-reserved: 1 
+          total-resources: 1 
+        sci-o:
+          grid-carbon-intensity: 457 # gCO2/kwh
+        sci:
+          functional-unit-duration: 1 
+          functional-duration-time: ''
+          functional-unit: requests # factor to convert per time to per f.unit
+      children:
+        web-server1:
+          inputs: 
+            - timestamp: 2023-07-06T00:00
+              duration: 1
+              energy-cpu: 0.139
+              grid-carbon-intensity: 951 # gCO2e/kWh
+              requests: 38032740
+        web-server2:
+          inputs: 
+            - timestamp: 2023-07-06T00:00
+              duration: 1
+              energy-cpu: 0.116
+              grid-carbon-intensity: 951 # gCO2e/kWh
+              requests: 38032740

package/examples/impls/tdp-finder-test.yml

@@ -0,0 +1,19 @@
+name: tdp-tester
+initialize:
+  models:
+    - name: tdp-finder # a model that returns an embodied value given the sci embodied attribution equation.
+      kind: builtin
+      verbose: false
+      path: ''
+graph:
+  children:
+    backend:
+      pipeline: 
+        - tdp-finder
+      config:
+        tdp-finder:
+          tdp:
+      observations:
+        - timestamp: 2023-07-06T00:00
+          physical-processor: AMD 3020e
+

package/examples/impls/test/azure.yml

@@ -0,0 +1,26 @@
+name: ccf-demo
+description: example impl invoking CCF model
+tags:
+initialize:
+  models:
+    - name: azure-importer
+      path: if-models
+      model: AzureImporterModel
+      kind: plugin
+graph:
+  children:
+    child:
+      pipeline:
+        - azure-importer
+      config:
+        azure-importer:
+      inputs:
+          - timestamp: '2023-11-02T10:35:31.820Z'
+            duration: 3600
+            azure-observation-window: 5 min # value and unit must be space separated 
+            azure-observation-aggregation: 'average'
+            azure-subscription-id: 9de7e19f-8a18-4e73-9451-45fc74e7d0d3
+            azure-resource-group: vm1_group
+            azure-vm-name: vm1
+
+

package/examples/impls/test/ccf.yml

@@ -0,0 +1,19 @@
+name: ccf-demo
+description: example impl invoking CCF model
+initialize:
+  models:
+    - name: ccf
+      kind: builtin
+graph:
+  children:
+    child:
+      pipeline:
+        - ccf
+      config:
+        ccf:
+          vendor: aws
+          instance-type: m5n.large
+      inputs:
+        - timestamp: 2023-07-06T00:00 # [KEYWORD] [NO-SUBFIELDS] time when measurement occurred
+          duration: 1
+          cpu-util: 10

package/examples/impls/test/complex-pipeline.yml

@@ -0,0 +1,67 @@
+name: gsf-demo-pipeline
+description:
+  More complex pipeline example
+tags:
+  kind: web
+  complexity: moderate
+  category: cloud
+initialize:
+  models:
+    - name: teads-curve
+      kind: builtin
+    - name: sci-m
+      kind: builtin
+    - name: sci-o
+      kind: builtin
+    - name: sci-e
+      kind: builtin
+    - name: eshoppen-net
+      kind: builtin
+    - name: eshoppen-mem
+      kind: builtin
+    - name: eshoppen-cpu
+      kind: builtin
+    - name: sampler
+      kind: shell
+graph:
+  children:
+    child:
+      pipeline:
+        - eshoppen-mem
+        - eshoppen-cpu
+        - eshoppen-net
+        - sci-e
+        - sci-o
+        - sampler
+      config:
+        teads-curve:
+          thermal-design-power: 1
+        sampler:
+          executable: python3 /usr/local/bin/sampler
+      inputs:
+        - timestamp: 2023-07-06T00:00 # [KEYWORD] [NO-SUBFIELDS] time when measurement occurred
+          processor: Intel® Core™ i7-1185G7
+          data-in: 1
+          data-out: 1
+          net-energy: 1
+          n-hours: 1
+          n-chips: 1
+          tdp-mem: 1
+          tdp-coeff: 1
+          duration: 3600 # Secs
+          thermal-design-power: 28 # W
+          cpu-util: 18.392
+          grid-carbon-intensity: 951 # gCO2e/kWh
+        - timestamp: 2023-08-06T00:00 # [KEYWORD] [NO-SUBFIELDS] time when measurement occurred
+          processor: Intel® Core™ i7-1185G7
+          data-in: 1
+          data-out: 1
+          net-energy: 1
+          n-hours: 1
+          n-chips: 1
+          tdp-mem: 1
+          tdp-coeff: 1
+          duration: 3600 # Secs
+          thermal-design-power: 20 # W
+          cpu-util: 16
+          grid-carbon-intensity: 800 # gCO2e/kWh

package/examples/impls/test/if-demo.yml

@@ -0,0 +1,51 @@
+name: if-demo
+description: demo pipeline
+tags:
+initialize:
+  models:
+    - name: azure-importer
+      kind: builtin
+    - name: cloud-instance-metadata
+      kind: builtin
+    - name: teads-curve
+      kind: builtin
+    - name: sci-e
+      kind: builtin
+    - name: sci-o
+      kind: builtin
+    - name: sci-e
+      kind: builtin
+    - name: sci-m
+      kind: builtin
+    - name: sci
+      kind: builtin
+graph:
+  children:
+    child:
+      pipeline:
+        - azure-importer
+        - cloud-instance-metadata
+        - teads-curve
+        - sci-e
+        - sci-o
+        - sci-m
+        - sci
+      config:
+        sci:
+          functional-unit: ''
+          functional-unit-time: hour
+          functional-unit-duration: 1
+      inputs:
+          - timestamp: '2023-11-02T10:35:31.820Z'
+            duration: 3600
+            azure-observation-window: 5 min # value and unit must be space separated 
+            azure-observation-aggregation: 'average'
+            azure-subscription-id: 9de7e19f-8a18-4e73-9451-45fc74e7d0d3
+            azure-resource-group: vm1_group
+            azure-vm-name: vm1
+            grid-carbon-intensity: 951
+            total-embodied-emissions: 1533.12
+            time-reserved: 300
+            expected-lifespan: 94348800 # 3 yrs in seconds
+            resources-reserved: 1
+            total-resources: 64

package/examples/impls/test/metadata.yml

@@ -0,0 +1,20 @@
+name: sci-m
+description: simple demo invoking metadata lookup
+tags: null
+initialize:
+  models:
+    - name: cloud-instance-metadata
+      kind: builtin
+graph:
+  children:
+    child:
+      pipeline:
+        - cloud-instance-metadata
+      config:
+        cloud-instance-metadata:
+      inputs:
+        - timestamp: 2023-07-06T00:00
+          duration: 3600
+          cloud-vendor: 'azure'
+          cloud-instance-type: 'Standard_NC24s_v3'
+

package/examples/impls/test/nesting.yml

@@ -0,0 +1,65 @@
+name: nesting-demo
+description:
+tags:
+  kind: web
+  complexity: moderate
+  category: on-premise
+initialize:
+  models:
+    - name: teads-curve
+      kind: builtin
+    - name: sci-e
+      kind: builtin
+      verbose: false
+      path: ''
+    - name: sci-m
+      kind: builtin
+      verbose: false
+      path: ''
+    - name: sci-o
+      kind: builtin
+      verbose: false
+      path: ''
+    - name: sci
+      kind: builtin
+      verbose: false
+      path: ''
+graph:
+  children:
+    child: # an advanced grouping node
+      pipeline:
+        - teads-curve
+        - sci-e
+        - sci-m
+        - sci-o
+        - sci
+      config:
+        teads-curve:
+          thermal-design-power: 65
+        sci-m:
+          total-embodied-emissions: 251000 # gCO2eq
+          time-reserved: 3600 # 1 hour in s
+          expected-lifespan: 126144000 # 4 years in seconds    
+          resources-reserved: 1 
+          total-resources: 1 
+        sci-o:
+          grid-carbon-intensity: 457 # gCO2/kwh
+        sci:
+          functional-unit-duration: 1 
+          functional-duration-time: ''
+          functional-unit: requests # factor to convert per time to per f.unit
+      children:
+        child-1:
+          inputs:
+            - timestamp: 2023-07-06T00:00
+              duration: 10
+              cpu-util: 50
+              e-net: 0.000811 #kwh     
+              requests: 380
+        child-2:
+          inputs: 
+            - timestamp: 2023-07-06T00:00
+              duration: 10
+              cpu-util: 33
+              e-net: 0.000811 #kwh     
+              requests: 380