@grnsft/if 0.1.1 → 0.1.3-beta

package/examples/ompls/test/time-sync.yml

@@ -0,0 +1,255 @@
+name: nesting-demo
+description: impl with 2 levels of nesting with non-uniform timing of observations
+tags: null
+initialize:
+  models:
+    - name: teads-curve
+      path: '@grnsft/if-unofficial-models'
+      model: TeadsCurveModel
+    - name: sci-e
+      path: '@grnsft/if-models'
+      model: SciEModel
+    - name: sci-m
+      path: '@grnsft/if-models'
+      model: SciMModel
+    - name: sci-o
+      path: '@grnsft/if-models'
+      model: SciOModel
+    - name: time-synchronization
+      path: builtin
+      model: TimeSyncModel
+      config:
+        start-time: 2023-12-12T00:00:00.000Z
+        end-time: 2023-12-12T00:01:00.000Z
+        interval: 5
+graph:
+  children:
+    child:
+      pipeline:
+        - teads-curve
+        - sci-e
+        - sci-m
+        - sci-o
+        - time-synchronization
+      config:
+        teads-curve:
+          thermal-design-power: 65
+        sci-m:
+          total-embodied-emissions: 251000
+          time-reserved: 3600
+          expected-lifespan: 126144000
+          resources-reserved: 1
+          total-resources: 1
+        sci-o:
+          grid-carbon-intensity: 457
+      children:
+        child-1:
+          inputs:
+            - timestamp: 2023-12-12T00:00:00.000Z
+              duration: 10
+              cpu-util: 10
+              carbon: 100
+              energy: 100
+              requests: 300
+            - timestamp: 2023-12-12T00:00:10.000Z
+              duration: 10
+              cpu-util: 20
+              requests: 380
+          outputs:
+            - timestamp: '2023-12-12T00:00:00.000Z'
+              duration: 5
+              cpu-util: 8
+              carbon: 50
+              energy: 0.00002888888888888889
+              requests: 150
+              thermal-design-power: 52
+              total-embodied-emissions: 125500
+              time-reserved: 2880
+              expected-lifespan: 63072000
+              resources-reserved: 0.8
+              total-resources: 0.8
+              grid-carbon-intensity: 365.6
+              energy-cpu: 0.00002888888888888889
+              embodied-carbon: 3.58162100456621
+              operational-carbon: 0.013202222222222223
+            - timestamp: '2023-12-12T00:00:05.000Z'
+              duration: 5
+              cpu-util: 8
+              carbon: 50
+              energy: 0.00002888888888888889
+              requests: 150
+              thermal-design-power: 52
+              total-embodied-emissions: 125500
+              time-reserved: 2880
+              expected-lifespan: 63072000
+              resources-reserved: 0.8
+              total-resources: 0.8
+              grid-carbon-intensity: 365.6
+              energy-cpu: 0.00002888888888888889
+              embodied-carbon: 3.58162100456621
+              operational-carbon: 0.013202222222222223
+            - timestamp: '2023-12-12T00:00:10.000Z'
+              duration: 5
+              cpu-util: 16
+              requests: 190
+              thermal-design-power: 52
+              total-embodied-emissions: 125500
+              time-reserved: 2880
+              expected-lifespan: 63072000
+              resources-reserved: 0.8
+              total-resources: 0.8
+              grid-carbon-intensity: 365.6
+              energy-cpu: 0.000043127731199186996
+              energy: 0.000043127731199186996
+              embodied-carbon: 3.58162100456621
+              operational-carbon: 0.019709373158028454
+            - timestamp: '2023-12-12T00:00:15.000Z'
+              duration: 5
+              cpu-util: 16
+              requests: 190
+              thermal-design-power: 52
+              total-embodied-emissions: 125500
+              time-reserved: 2880
+              expected-lifespan: 63072000
+              resources-reserved: 0.8
+              total-resources: 0.8
+              grid-carbon-intensity: 365.6
+              energy-cpu: 0.000043127731199186996
+              energy: 0.000043127731199186996
+              embodied-carbon: 3.58162100456621
+              operational-carbon: 0.019709373158028454
+            - timestamp: '2023-12-12T00:00:20.000Z'
+              duration: 5
+              cpu-util: 0
+              requests: 0
+              thermal-design-power: 0
+              total-embodied-emissions: 0
+              time-reserved: 0.8
+              expected-lifespan: 0
+              resources-reserved: 0.8
+              total-resources: 0.8
+              grid-carbon-intensity: 0
+              energy-cpu: 0
+              energy: 0
+              embodied-carbon: 0
+              operational-carbon: 0
+            - timestamp: '2023-12-12T00:00:25.000Z'
+              duration: 5
+              cpu-util: 0
+              requests: 0
+              thermal-design-power: 0
+              total-embodied-emissions: 0
+              time-reserved: 0.8
+              expected-lifespan: 0
+              resources-reserved: 0.8
+              total-resources: 0.8
+              grid-carbon-intensity: 0
+              energy-cpu: 0
+              energy: 0
+              embodied-carbon: 0
+              operational-carbon: 0
+            - timestamp: '2023-12-12T00:00:30.000Z'
+              duration: 5
+              cpu-util: 0
+              requests: 0
+              thermal-design-power: 0
+              total-embodied-emissions: 0
+              time-reserved: 0.8
+              expected-lifespan: 0
+              resources-reserved: 0.8
+              total-resources: 0.8
+              grid-carbon-intensity: 0
+              energy-cpu: 0
+              energy: 0
+              embodied-carbon: 0
+              operational-carbon: 0
+            - timestamp: '2023-12-12T00:00:35.000Z'
+              duration: 5
+              cpu-util: 0
+              requests: 0
+              thermal-design-power: 0
+              total-embodied-emissions: 0
+              time-reserved: 0.8
+              expected-lifespan: 0
+              resources-reserved: 0.8
+              total-resources: 0.8
+              grid-carbon-intensity: 0
+              energy-cpu: 0
+              energy: 0
+              embodied-carbon: 0
+              operational-carbon: 0
+            - timestamp: '2023-12-12T00:00:40.000Z'
+              duration: 5
+              cpu-util: 0
+              requests: 0
+              thermal-design-power: 0
+              total-embodied-emissions: 0
+              time-reserved: 0.8
+              expected-lifespan: 0
+              resources-reserved: 0.8
+              total-resources: 0.8
+              grid-carbon-intensity: 0
+              energy-cpu: 0
+              energy: 0
+              embodied-carbon: 0
+              operational-carbon: 0
+            - timestamp: '2023-12-12T00:00:45.000Z'
+              duration: 5
+              cpu-util: 0
+              requests: 0
+              thermal-design-power: 0
+              total-embodied-emissions: 0
+              time-reserved: 0.8
+              expected-lifespan: 0
+              resources-reserved: 0.8
+              total-resources: 0.8
+              grid-carbon-intensity: 0
+              energy-cpu: 0
+              energy: 0
+              embodied-carbon: 0
+              operational-carbon: 0
+            - timestamp: '2023-12-12T00:00:50.000Z'
+              duration: 5
+              cpu-util: 0
+              requests: 0
+              thermal-design-power: 0
+              total-embodied-emissions: 0
+              time-reserved: 0.8
+              expected-lifespan: 0
+              resources-reserved: 0.8
+              total-resources: 0.8
+              grid-carbon-intensity: 0
+              energy-cpu: 0
+              energy: 0
+              embodied-carbon: 0
+              operational-carbon: 0
+            - timestamp: '2023-12-12T00:00:55.000Z'
+              duration: 5
+              cpu-util: 0
+              requests: 0
+              thermal-design-power: 0
+              total-embodied-emissions: 0
+              time-reserved: 0.8
+              expected-lifespan: 0
+              resources-reserved: 0.8
+              total-resources: 0.8
+              grid-carbon-intensity: 0
+              energy-cpu: 0
+              energy: 0
+              embodied-carbon: 0
+              operational-carbon: 0
+            - timestamp: '2023-12-12T00:01:00.000Z'
+              duration: 1
+              cpu-util: 0
+              requests: 0
+              thermal-design-power: 0
+              total-embodied-emissions: 0
+              time-reserved: 0
+              expected-lifespan: 0
+              resources-reserved: 0
+              total-resources: 0
+              grid-carbon-intensity: 0
+              energy-cpu: 0
+              energy: 0
+              embodied-carbon: 0
+              operational-carbon: 0

package/examples/ompls/time-sync.yml

@@ -0,0 +1,212 @@
+name: nesting-demo
+description: impl with 2 levels of nesting with non-uniform timing of observations
+tags: null
+initialize:
+  models:
+    - name: teads-curve
+      path: '@grnsft/if-unofficial-models'
+      model: TeadsCurveModel
+    - name: sci-e
+      path: '@grnsft/if-models'
+      model: SciEModel
+    - name: sci-m
+      path: '@grnsft/if-models'
+      model: SciMModel
+    - name: sci-o
+      path: '@grnsft/if-models'
+      model: SciOModel
+    - name: time-synchronization
+      path: builtin
+      model: TimeSyncModel
+      config:
+        start-time: 2023-12-12T00:00:00.000Z
+        end-time: 2023-12-12T00:01:00.000Z
+        interval: 5
+graph:
+  children:
+    child:
+      pipeline:
+        - teads-curve
+        - sci-e
+        - sci-m
+        - sci-o
+        - time-synchronization
+      config:
+        teads-curve:
+          thermal-design-power: 65
+        sci-m:
+          total-embodied-emissions: 251000
+          time-reserved: 3600
+          expected-lifespan: 126144000
+          resources-reserved: 1
+          total-resources: 1
+        sci-o:
+          grid-carbon-intensity: 457
+      children:
+        child-1:
+          inputs:
+            - timestamp: 2023-12-12T00:00:00.000Z
+              duration: 10
+              cpu-util: 10
+              requests: 300
+          outputs:
+            - timestamp: '2023-12-12T00:00:00.000Z'
+              duration: 10
+              cpu-util: 10
+              requests: 30
+              thermal-design-power: 65
+              total-embodied-emissions: 251000
+              time-reserved: 3600
+              expected-lifespan: 126144000
+              resources-reserved: 1
+              total-resources: 1
+              grid-carbon-intensity: 457
+              energy-cpu: 0.000057777777777777776
+              energy: 0.000057777777777777776
+              embodied-carbon: 7.16324200913242
+              operational-carbon: 0.026404444444444442
+              carbon: 7.189646453576864
+            - timestamp: '2023-12-12T00:00:01.000Z'
+              duration: 10
+              cpu-util: 10
+              requests: 30
+              thermal-design-power: 65
+              total-embodied-emissions: 251000
+              time-reserved: 3600
+              expected-lifespan: 126144000
+              resources-reserved: 1
+              total-resources: 1
+              grid-carbon-intensity: 457
+              energy-cpu: 0.000057777777777777776
+              energy: 0.000057777777777777776
+              embodied-carbon: 7.16324200913242
+              operational-carbon: 0.026404444444444442
+              carbon: 7.189646453576864
+            - timestamp: '2023-12-12T00:00:02.000Z'
+              duration: 10
+              cpu-util: 10
+              requests: 30
+              thermal-design-power: 65
+              total-embodied-emissions: 251000
+              time-reserved: 3600
+              expected-lifespan: 126144000
+              resources-reserved: 1
+              total-resources: 1
+              grid-carbon-intensity: 457
+              energy-cpu: 0.000057777777777777776
+              energy: 0.000057777777777777776
+              embodied-carbon: 7.16324200913242
+              operational-carbon: 0.026404444444444442
+              carbon: 7.189646453576864
+            - timestamp: '2023-12-12T00:00:03.000Z'
+              duration: 10
+              cpu-util: 10
+              requests: 30
+              thermal-design-power: 65
+              total-embodied-emissions: 251000
+              time-reserved: 3600
+              expected-lifespan: 126144000
+              resources-reserved: 1
+              total-resources: 1
+              grid-carbon-intensity: 457
+              energy-cpu: 0.000057777777777777776
+              energy: 0.000057777777777777776
+              embodied-carbon: 7.16324200913242
+              operational-carbon: 0.026404444444444442
+              carbon: 7.189646453576864
+            - timestamp: '2023-12-12T00:00:04.000Z'
+              duration: 10
+              cpu-util: 10
+              requests: 30
+              thermal-design-power: 65
+              total-embodied-emissions: 251000
+              time-reserved: 3600
+              expected-lifespan: 126144000
+              resources-reserved: 1
+              total-resources: 1
+              grid-carbon-intensity: 457
+              energy-cpu: 0.000057777777777777776
+              energy: 0.000057777777777777776
+              embodied-carbon: 7.16324200913242
+              operational-carbon: 0.026404444444444442
+              carbon: 7.189646453576864
+            - timestamp: '2023-12-12T00:00:05.000Z'
+              duration: 10
+              cpu-util: 10
+              requests: 30
+              thermal-design-power: 65
+              total-embodied-emissions: 251000
+              time-reserved: 3600
+              expected-lifespan: 126144000
+              resources-reserved: 1
+              total-resources: 1
+              grid-carbon-intensity: 457
+              energy-cpu: 0.000057777777777777776
+              energy: 0.000057777777777777776
+              embodied-carbon: 7.16324200913242
+              operational-carbon: 0.026404444444444442
+              carbon: 7.189646453576864
+            - timestamp: '2023-12-12T00:00:06.000Z'
+              duration: 10
+              cpu-util: 10
+              requests: 30
+              thermal-design-power: 65
+              total-embodied-emissions: 251000
+              time-reserved: 3600
+              expected-lifespan: 126144000
+              resources-reserved: 1
+              total-resources: 1
+              grid-carbon-intensity: 457
+              energy-cpu: 0.000057777777777777776
+              energy: 0.000057777777777777776
+              embodied-carbon: 7.16324200913242
+              operational-carbon: 0.026404444444444442
+              carbon: 7.189646453576864
+            - timestamp: '2023-12-12T00:00:07.000Z'
+              duration: 10
+              cpu-util: 10
+              requests: 30
+              thermal-design-power: 65
+              total-embodied-emissions: 251000
+              time-reserved: 3600
+              expected-lifespan: 126144000
+              resources-reserved: 1
+              total-resources: 1
+              grid-carbon-intensity: 457
+              energy-cpu: 0.000057777777777777776
+              energy: 0.000057777777777777776
+              embodied-carbon: 7.16324200913242
+              operational-carbon: 0.026404444444444442
+              carbon: 7.189646453576864
+            - timestamp: '2023-12-12T00:00:08.000Z'
+              duration: 10
+              cpu-util: 10
+              requests: 30
+              thermal-design-power: 65
+              total-embodied-emissions: 251000
+              time-reserved: 3600
+              expected-lifespan: 126144000
+              resources-reserved: 1
+              total-resources: 1
+              grid-carbon-intensity: 457
+              energy-cpu: 0.000057777777777777776
+              energy: 0.000057777777777777776
+              embodied-carbon: 7.16324200913242
+              operational-carbon: 0.026404444444444442
+              carbon: 7.189646453576864
+            - timestamp: '2023-12-12T00:00:09.000Z'
+              duration: 10
+              cpu-util: 10
+              requests: 30
+              thermal-design-power: 65
+              total-embodied-emissions: 251000
+              time-reserved: 3600
+              expected-lifespan: 126144000
+              resources-reserved: 1
+              total-resources: 1
+              grid-carbon-intensity: 457
+              energy-cpu: 0.000057777777777777776
+              energy: 0.000057777777777777776
+              embodied-carbon: 7.16324200913242
+              operational-carbon: 0.026404444444444442
+              carbon: 7.189646453576864

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@grnsft/if",
   "description": "Impact Framework",
-  "version": "v0.1.1",
+  "version": "v0.1.3-beta",
   "author": {
     "name": "Green Software Foundation",
     "email": "info@gsf.com"
@@ -14,6 +14,8 @@
   },
   "dependencies": {
     "js-yaml": "^4.1.0",
+    "moment": "^2.29.4",
+    "moment-range": "^4.0.2",
     "ts-command-line-args": "^2.5.1",
     "typescript": "^5.1.6",
     "zod": "^3.22.4"

package/src/config/units.yaml

@@ -18,14 +18,18 @@ duration:
   description: refers to the duration of the input
   unit: seconds
   aggregation: sum
+energy:
+  description: amount of energy utilised by the component
+  unit: kWh
+  aggregation: sum
 energy-cpu:
   description: Energy consumed by the CPU of the component
   unit: kWh
   aggregation: sum
 expected-lifespan:
-  description: expected lifespan for some component
+  description: Total Expected Lifespan of the Component in Seconds
   unit: seconds
-  aggregation: none
+  aggregation: sum
 energy-memory:
   description: Energy consumed by the Memory of the component
   unit: kWh
@@ -34,28 +38,16 @@ embodied-carbon:
   description: Embodied Emissions of the component
   unit: gCO2e
   aggregation: sum
-energy:
-  description: amount of energy utilised by the component
-  unit: kWh
-  aggregation: sum
 energy-network:
   description: Energy consumed by the Network of the component
   unit: kWh
   aggregation: sum
-expected-lifespan:
-  description: Total Expected Lifespan of the Component in Seconds
-  unit: seconds
-  aggregation: None
 functional-unit:
   description: the name of the functional unit in which the final SCI value should be expressed, e.g. requests, users
   unit: none
-  aggregation: none
-functional-unit-duration:
-  description: how many units of functional-unit-time the final SCI value should be expressed in.
-  unit: functional-unit-time
-  aggregation: none
+  aggregation: sum
 functional-unit-time:
-  description: string describing the unit of time in which the final SCI calculation should be expressed
+  description: string describing the unit of time in which the final SCI calculation should be expressed, e.g. "1-min"
   unit: none
   aggregation: none
 gpu-util:
@@ -74,10 +66,6 @@ location:
   description: Geographic location of provider as string (for watt-time model it is provided as latitude and longitude, comma separated, in decimal degrees)
   unit: None (decimal degrees for watt-time model)
   aggregation: None
-embodied-carbon:
-  description: Carbon emitted from component manufacture (returned from Boavizta)
-  unit: gCO2eq
-  aggregation: sum
 operational-carbon:
   description: Operational Emissions of the component
   unit: gCO2e
@@ -85,11 +73,11 @@ operational-carbon:
 physical-processor:
   description: Name of the physical processor 
   unit: None
-  aggregation: None
+  aggregation: none
 vendor:
   description: Name of the cloud service provider in the ccf model. Can be aws, gcp or azure
   unit: None
-  aggregation: None
+  aggregation: none
 ram-alloc:
   description: refers to GB of memory allocated.
   unit: GB
@@ -113,7 +101,7 @@ total-embodied-emissions:
 timestamp:
   description: refers to the time of occurrence of the input
   unit: RFC3339
-  aggregation: None
+  aggregation: none
 time-reserved:
   description: time reserved for a component
   unit: seconds
@@ -122,4 +110,3 @@ total-resources:
   description: total resources available
   unit: count
   aggregation: none
-