@grnsft/if 0.1.8 → 0.2.0

package/examples/impls/case-studies/accenture.yml

@@ -1,155 +0,0 @@
-name: accenture
-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 # a model that sums e components
-      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 sums sci-o + sci-m
-      kind: builtin
-      verbose: false
-      path: '' 
-    - name: sci-accenture # a model that sums sci-o + sci-m
-      kind: builtin
-      verbose: false
-      path: '' 
-graph:
-  children:
-    vms:
-      pipeline:
-        - sci-e
-        - sci-o
-        - sci
-        - sci-accenture
-      config:
-        sci-o:
-          grid-carbon-intensity: 350.861
-        sci:
-          functional-unit-duration: 1 
-          functional-duration-time: ''
-          functional-unit: requests # factor to convert per time to per f.unit
-      children:
-        vm1:
-          inputs: 
-            - timestamp: 2023-07-06T00:00
-              grid-carbon-intensity: 350.861
-              duration: 2419200 # seconds in a month (7 days * 4 weeks)
-              cpu-util: 15
-              ram-util: 75
-              energy-cpu: 4.26 #kwh/month
-              embodied-carbon: 763.33 #gCO2e
-              requests: 89000
-        vm2: 
-          inputs: 
-            - timestamp: 2023-07-06T00:00
-              duration: 2419200 # seconds in a month (7 days * 4 weeks)
-              cpu-util: 12
-              ram-util: 72
-              energy-cpu: 4.26 # kwh/month   
-              embodied-carbon: 763.33 #gCO2e
-              requests: 89000
-        vm3: 
-          inputs: 
-            - timestamp: 2023-07-06T00:00
-              duration: 2419200 # seconds in a month (7 days * 4 weeks)
-              cpu-util: 10
-              ram-util: 65
-              energy-cpu: 4.21 # kwh/month
-              embodied-carbon: 763.33 #gCO2e
-              requests: 89000       
-        vm4: 
-          inputs: 
-            - timestamp: 2023-07-06T00:00
-              duration: 2419200 # seconds in a month (7 days * 4 weeks)
-              cpu-util: 9
-              ram-util: 70
-              energy-cpu: 4.21 # kwh/month    
-              embodied-carbon: 763.33 #gCO2e   
-              requests: 89000    
-        vm5: 
-          inputs: 
-            - timestamp: 2023-07-06T00:00
-              duration: 2419200 # seconds in a month (7 days * 4 weeks)
-              cpu-util: 9
-              ram-util: 70
-              energy-cpu: 4.21 # kwh/month
-              embodied-carbon: 763.33 #gCO2e
-              requests: 89000
-        vm6: 
-          inputs: 
-            - timestamp: 2023-07-06T00:00 
-              duration: 2419200 # seconds in a month (7 days * 4 weeks)
-              cpu-util: 8
-              ram-util: 65
-              energy-cpu: 3.29 # kwh/month   
-              embodied-carbon: 763.33 #gCO2e
-              requests: 89000
-        vm7: 
-          inputs:
-            - timestamp: 2023-07-06T00:00
-              duration: 2419200 # seconds in a month (7 days * 4 weeks)
-              cpu-util: 7
-              ram-util: 72 
-              energy-cpu: 3.29 # kwh/month
-              embodied-carbon: 763.33 #gCO2e
-              requests: 89000
-        vm8: 
-          inputs: 
-            - timestamp: 2023-07-06T00:00
-              duration: 2419200 # seconds in a month (7 days * 4 weeks)
-              cpu-util: 6
-              ram-util: 70
-              energy-cpu: 3.29 # kwh/month       
-              embodied-carbon: 763.33 #gCO2e
-              requests: 89000
-    db:
-      pipeline:
-        - sci-e       # sums e components
-        - sci-o       # calculates carbon for this obervation (energy * grid-carbon-intensity) + embodied.
-        - sci         # calculates sci by dividing carbon by `r`
-        - sci-accenture # multiplies sci value by 1.05  to account for the "app-gateway"
-      config:
-        sci-o:
-          grid-carbon-intensity: 350.861
-        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: 2419200 # seconds in a month (7 days * 4 weeks)
-          cpu-util: 4
-          ram-util: 40
-          energy-cpu: 2.68 # kwh/month
-          embodied-carbon: 763.33 #gCO2e
-          requests: 89000
-    monitoring:
-      pipeline:
-        - sci-e       # sums e components
-        - sci-o       # calculates carbon for this obervation (energy * grid-carbon-intensity) + embodied.
-        - sci         # calculates sci by dividing carbon by `r`
-        - sci-accenture # multiplies sci value by 1.05  to account for the "app-gateway"
-      config:
-        sci-o:
-          grid-carbon-intensity: 350.861
-        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: 2419200 # seconds in a month (7 days * 4 weeks)
-          cpu-util: 4
-          ram-util: 40
-          energy-cpu: 4.62 # kwh/month
-          embodied-carbon: 763.33 #gCO2e
-          requests: 89000

package/examples/impls/case-studies/aggregation.yml

@@ -1,97 +0,0 @@
-name: nesting-demo
-description:
-aggregation:
-  aggregation-metrics: ['carbon', 'energy']
-  aggregation-method: 'sum' # should default to sum if no value given
-tags:
-  kind: web
-  complexity: moderate
-  category: on-premise
-initialize:
-  models:
-    - name: teads-curve
-      model: TeadsCurveModel
-      path: "@grnsft/if-unofficial-models"
-    - name: sci-e
-      model: SciEModel
-      path: "@grnsft/if-models"
-    - name: sci-m
-      path: "@grnsft/if-models"
-      model: SciMModel
-    - name: sci-o
-      model: SciOModel
-      path: "@grnsft/if-models"
-    - name: sci
-      model: SciModel
-      path: "@grnsft/if-models"
-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
-              carbon: 10
-              energy: 20
-            - timestamp: 2023-07-06T00:00
-              duration: 10
-              cpu-util: 50
-              e-net: 0.000811 #kwh     
-              requests: 380
-              carbon: 10
-              energy: 20
-            - timestamp: 2023-07-06T00:00
-              duration: 10
-              cpu-util: 50
-              e-net: 0.000811 #kwh     
-              requests: 380
-              carbon: 10
-              energy: 20
-        child-2:
-          inputs: 
-            - timestamp: 2023-07-06T00:00
-              duration: 10
-              cpu-util: 50
-              e-net: 0.000811 #kwh     
-              requests: 380
-              carbon: 10
-              energy: 20
-            - timestamp: 2023-07-06T00:00
-              duration: 10
-              cpu-util: 50
-              e-net: 0.000811 #kwh     
-              requests: 380
-              carbon: 10
-              energy: 20
-            - timestamp: 2023-07-06T00:00
-              duration: 10
-              cpu-util: 50
-              e-net: 0.000811 #kwh     
-              requests: 380
-              carbon: 10
-              energy: 20

package/examples/impls/case-studies/aveva.yaml

@@ -1,48 +0,0 @@
-name: aveva
-description: https://github.com/Green-Software-Foundation/sci-guide/blob/dev/use-case-submissions/AVEVA_case_study.md
-tags:
-  kind: web
-  complexity: moderate
-  category: on-premise
-initialize:
-  models:
-    - name: aveva # a model that takes in power inputs and returns e.
-      kind: builtin
-    - name: sci-o # a model that given e, i and m calculates a carbon value (e * i) + m
-      kind: builtin
-    - name: sci-e # a model that given e, i and m calculates a carbon value (e * i) + m
-      kind: builtin
-    - name: sci-m  # a model that calculates m from te, tir, el, rr and rtor.          
-      kind: builtin
-    - name: sci # sums SCI components and converts to f.unit
-      kind: builtin
-graph:
-  children:
-    pc: 
-      pipeline:
-      - aveva
-      - sci-e
-      - sci-m
-      - sci-o
-      config:
-        aveva:
-        sci-e:
-        sci-m:
-          total-embodied-emissions: 350000 # kgCO2eq
-          time-reserved: 1 # 1 year in seconds
-          expected-lifespan: 5 # 5 years in seconds        
-          resources-reserved: 1
-          total-resources: 1
-        sci-o:
-          grid-carbon-intensity: 474.8 #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 
-          pl: 16.009 # average over timespan
-          pb: 11.335 # average over timespan
-          time: 8322 # (hours in year * average uptime e.g. 95%)
-
-

package/examples/impls/case-studies/azure-yassine.yaml

@@ -1,67 +0,0 @@
-name: azure-metrics
-description: "https://github.com/yelghali/imapct-engine-framework/blob/main/src/lib/components/azure-vm.py"
-tags:
-initialize:
-  models:
-    - name: metrics-exporter # model that grabs Azure metrics and uses them to enrich confg and obs in impl 
-      kind: plugin
-      verbose: false
-      path: /usr/local/bin 
-    - name: teads-curve # a model that returns an embodied value given the sci embodied attribution equation.
-      kind: builtin
-      verbose: false
-      path: ''
-    - name: energy-memory # a model that calculates e for memory utilization (0.38 * mem-util)
-      kind: builtin  
-      path: ''
-    - name: sci-e # sums e components (can be e-cpu, e-gpu, e-mem, e-network) - in this case energy-memory and e-cpu from teads
-      kind: builtin  
-      path: ''
-    - name: sci-m # a model that calculates m from te, tir, el, rr and rtor
-      kind: builtin
-      verbose: false
-      path: ''
-    - name: sci-o # takes in total e and outputs operational emissions
-      kind: builtin
-      verbose: false
-      path: ''
-    - name: sci # a model that sums sci-o + sci-m and applies functional unit
-      kind: builtin
-      verbose: false
-      path: '' 
-# Single input
-graph:
-  backend: # an advanced grouping node
-    pipeline: 
-      - metrics-exporter - # grabs obs from azure-sdk and enriches impl
-      - teads-cpu # tdp & cpu -> energy
-      - energy-memory # calculates energy used by memory as component of sci-m
-      - sci-m # duration & config -> embodied
-      - sci-e # sums e components (can be e-cpu, e-gpu, e-mem, e-network) - in this case energy-memory and e-cpu from teads
-      - sci-o # takes in total e and outputs operational emissions
-      - sci # sum sci-m and sci-o and apply functional unit
-    config: 
-      vendor: azure
-      region: east-us  # lookup carbon intensity from region
-      energy-memory:
-        mem-allocation: 32 # GB
-        mem-energy: 0.38 # kwh/GB
-      sci-m:
-        total-embodied-emissions: 1200 # kgCO2eq
-        tr: 3600 # 1hr in s
-        expected-lifespan: 126144000 # 4 years in seconds        
-        resources-reserved: 2
-        total-resources: 16
-      sci-e:
-        i: 100 # gCO2e/kWh
-      sci:
-        time: hour # signal to convert /s -> /hr
-        factotal-resources: 32000
-    inputs: 
-      - timestamp: 2023-07-06T00:00
-        duration: 86400 # 1 day
-        subscription-id: c60d99da-0c45-4dfa-bc21-87e3c4cb4716
-        resource-group: my-application
-        name: batch-servers
-        input-window: 3600 # 1 min buckets
-

package/examples/impls/case-studies/dow_msft.yml

@@ -1,173 +0,0 @@
-name: dow-msft
-description: "https://github.com/Green-Software-Foundation/sci-guide/blob/dev/use-case-submissions/dow-msft-Graph-DB.md"
-tags:
-  kind: db-api
-  complexity: simple
-  category: cloud
-initialize:
-  models:
-    - name: teads-curve # a model that returns an embodied value given the sci embodied attribution equation.
-      kind: builtin
-      verbose: false
-      path: ''
-    - name: emem # a model that calculates e for memory utilization (0.38 * mem-util = e-mem in kwH)
-      kind: builtin  
-      path: ''
-    - name: sci-e # sums e components (can be e-cpu, e-gpu, e-mem, e-network) - in this case emem and e-cpu from teads
-      kind: builtin  
-      path: ''
-    - name: sci-m # a model that calculates m from te, tir, el, rr and rtor
-      kind: builtin
-      verbose: false
-      path: ''
-    - name: sci-o # takes in total e and outputs operational emissions
-      kind: builtin
-      verbose: false
-      path: ''
-    - name: sci # a model that sums sci-o + sci-m and applies functional unit
-      kind: builtin
-      verbose: false
-      path: '' 
-# Single input
-graph:
-  children:
-    backend:
-      pipeline: 
-        - teads-curve # tdp & cpu -> energy
-        - emem # calculates energy used by memory as component of sci-m
-        - sci-m # duration & config -> embodied
-        - sci-e # energy & grid-carbon-intensity & embodied -> carbon
-        - sci-o # takes in total e and outputs operational emissions
-        - sci # add cpu and memory components and convert to f.unit
-      config:
-        teads-curve: # use thermal-design-power to derive energy-cpu (kwh)
-          physical-processor: Intel-xeon-platinum-8380
-          thermal-design-power: 270
-        emem: # mem-util * mem-alloc * mem-energy = emem (kwh)
-          mem-alloc: 32 # GB
-          mem-energy: 0.38 # wh/GB
-        sci-m:
-          total-embodied-emissions: 1533.120 # gCO2eq
-          time-reserved: 1 # s per hour
-          expected-lifespan: 3 # 3 years in seconds        
-          resources-reserved: 1
-          total-resources: 8
-        sci-o:
-          grid-carbon-intensity: 554 # gCO2e/kWh
-        sci:
-          functional-unit-duration: 1 
-          functional-duration-time: ''
-          functional-unit: requests # factor to convert per time to per f.unit
-      children:
-        tiger-databasenergy-cpu:
-          config:
-            sci-m:
-              total-embodied-emissions: 1533.120 # gCO2eq
-              time-reserved: 1 # s per hour
-              expected-lifespan: 35040 # 3 years in seconds        
-              resources-reserved: 2
-              total-resources: 64
-          inputs: 
-            - timestamp: 2023-07-06T00:00
-              duration: 3600
-              cpu-util: 17
-              mem-util: 19 # % of available
-              requests: 32000
-        tiger-databasenergy-memory:
-          config:
-            sci-m:
-              total-embodied-emissions: 1216.620 # gCO2eq
-              time-reserved: 1 # s per hour
-              expected-lifespan: 35040 # 3 years in seconds        
-              resources-reserved: 1
-              total-resources: 8
-          inputs: 
-            - timestamp: 2023-07-06T00:00
-              duration: 1
-              cpu-util: 0
-              mem-util: 0 # % of available
-              requests: 32000
-        tiger-api-cpu: # a leaf component
-          config:
-            teads-curve:
-              physical-processor: Intel-xeon-platinum-8270
-              thermal-design-power: 205
-            emem:
-              mem-alloc: 1.75
-            sci-m:
-              total-embodied-emissions: 1216.620
-          inputs:     
-            - timestamp: 2023-08-06T00:00
-              duration: 3600
-              cpu-util: 25
-              mem-util: 70 # % of total
-              requests: 32000
-        tiger-api-mem:
-          config:
-            sci-m:
-              total-embodied-emissions: 1216.620
-          inputs:     
-            - timestamp: 2023-08-06T00:00
-              duration: 3600
-              cpu-util: 0
-              mem-util: 0 # % of total
-              requests: 32000        
-        neo4j-databasenergy-cpu: # a leaf component
-          config:
-            sci-m:
-              total-embodied-emissions: 1216.620 # gCO2eq
-              time-reserved: 1 # s per hour
-              expected-lifespan: 35040 # 3 years in seconds        
-              resources-reserved: 1
-              total-resources: 8
-            sci-o:
-              grid-carbon-intensity: 554 # gCO2e/kWh
-          inputs:
-            - timestamp: 2023-07-06T00:00
-              duration: 3600 # this data is using span, but the model expects duration
-              cpu-util: 28.05
-              mem-util: 19.375
-              requests: 32000
-        neo4j-databasenergy-memory: # a leaf component
-          config:
-            sci-m:
-              total-embodied-emissions: 1216.62 # gCO2eq
-              resources-reserved: 2
-              total-resources: 64
-          inputs:
-            - timestamp: 2023-07-06T00:00
-              duration: 1 # this data is using span, but the model expects duration
-              cpu-util: 0
-              mem-util: 0
-              requests: 32000
-        neo4j-api-cpu: # a leaf component
-          config:
-            teads-curve:
-              physical-processor: Intel-xeon-platinum-8270
-              thermal-design-power: 205
-            emem:
-              mem-alloc: 1.75 # GB
-            sci-m:
-              total-embodied-emissions: 1216.620 # gCO2eq
-              time-reserved: 1 # s per hour
-              expected-lifespan: 35040 # 3 years in seconds        
-              resources-reserved: 2
-              total-resources: 64
-          inputs:    
-            - timestamp: 2023-08-06T00:00
-              duration: 3600
-              cpu-util: 14
-              mem-util: 65
-              requests: 32000
-        neo4j-api-mem: # a leaf component
-          config:
-            sci-m:
-              total-embodied-emissions: 1216.620 # gCO2eq     
-              resources-reserved: 1
-              total-resources: 8
-          inputs:    
-            - timestamp: 2023-08-06T00:00
-              duration: 3600
-              cpu-util: 0
-              mem-util: 0
-              requests: 32000

package/examples/impls/case-studies/farm-insights.yaml

@@ -1,35 +0,0 @@
-name: farm-insights
-description: https://github.com/Green-Software-Foundation/sci-guide/blob/dev/use-case-submissions/farm-insights-Raspberry-Pi.md
-tags:
-  kind: iot
-  complexity: simple
-  category: device
-initialize:
-  models:
-    - name: sci-o # takes in total e and outputs operational emissions
-      kind: plugin
-      model: SciOModel
-      path: if-models
-      verbose: false
-    - name: sci # a model that sums sci-o + sci-m and applies functional unit
-      kind: plugin
-      verbose: false
-      model: SciModel
-      path: if-models
-graph:
-  children: 
-    rasp-pi: 
-      pipeline: 
-       - sci-o # take e and return e * i (carbon)
-       - sci # take in carbon from sci-o and embodied carbon (m) and return sum in correct time unit (here /yr)
-      config:
-        sci:
-            functional-unit-duration: 1 
-            functional-unit-time: 'minutes'
-            functional-unit: requests # factor to convert per time to per f.unit
-      inputs:
-        - energy: 3.47222222222e-07 # 0.03 kwh/day in kwh/s
-          timestamp: 2023-07-06T00:00
-          grid-carbon-intensity: 713 # g/kwh
-          embodied-carbon: 1.744038559107052e-03 # they give 55kg/year - here in g/second
-          duration: 3600

package/examples/impls/case-studies/gsf-website.yaml

@@ -1,93 +0,0 @@
-name:  "Green Software Foundation Website"
-description: "https://github.com/Green-Software-Foundation/ief/issues/58"
-tags:
-  kind: website
-  complexity: moderate
-  category: cloud
-initialize:
-  models:
-    - name: sci-coefficient # a model that receives a carbon value and normalizes to R.
-      kind: builtin
-      path: ''
-    - name: sci-serve # a model that calculates carbon from server data.
-      kind: builtin
-      path: ''
-    - name: sci # a model that receives a carbon value and normalizes to R.
-      kind: builtin
-      path: ''
-    - name: co2js # a model that receives a carbon value and normalizes to R.
-      kind: plugin
-      path: '...'
-graph:
-  build: 
-    netlify:
-      pipeline:
-        - sci-coefficient 
-      config:
-        sci-coefficient:
-          time: month
-          factotal-resources: 67 # n builds per month
-        inputs:
-          - timestamp: 2023-07-06T00:00 
-            c: 9.92063492063492e-07 #  2.4 g/month in g/s
-    gh-pages:
-      pipeline:
-        - sci-coefficient 
-      config:
-        sci-coefficient:
-          time: month
-          factotal-resources: 67 # n builds per month
-        inputs:
-          - timestamp: 2023-07-06T00:00 
-            c: 9.92063492063492e-07 #  2.4 g/month in g/s
-  serving: 
-    netlify:
-      pipeline:
-        - sci-serve 
-      config:
-        sci-serve:
-          time: month
-        inputs:
-          - timestamp: 2023-07-06T00:00 
-            c: 9.92063492063492e-07 #  2.4 g/month in g/s
-            views-per-user: 2.1
-            users: 2000 # unique users in most recent month
-    gh-pages:
-      pipeline:
-        - sci-serve 
-      config:
-        sci-serve:
-          time: month
-        inputs:
-          - timestamp: 2023-07-06T00:00 
-            c: 9.92063492063492e-07 #  2.4 g/month in g/s
-            views-per-user: 2.1
-            users: 0.0008267195767195768 # 2000 unique users in most recent month, converted to users/s
-  traffic:
-    pipeline:
-      - co2js
-      - sci
-    config:
-      co2js:
-        kind: 1byte # https://developers.thegreenwebfoundation.org/co2js/models/
-        green-hosting: true
-      sci:
-        time: month
-    inputs:
-      - timestamp: 2023-07-06T00:00 
-        data: 8.267195767195768e-06 # 20 GB data transferred in most recent month, converted to GB/s
-        users: 0.0008267195767195768 # 2000 unique users in most recent month, converted to users/s           
-  browser:
-    pipeline:
-      - co2js
-      - sci
-    config:
-      co2js:
-        kind: 1byte # https://developers.thegreenwebfoundation.org/co2js/models/
-        green-hosting: true
-      sci:
-        time: month
-    inputs:
-      - timestamp: 2023-07-06T00:00 
-        data: 8.267195767195768e-06 # 20 GB data transferred in most recent month, converted to GB/s
-        users: 2000 0.0008267195767195768 # 2000 unique users in most recent month, converted to users/s