@grnsft/if 0.1.8 → 0.1.9

package/examples/impls/test/new-params-test.yml

@@ -0,0 +1,35 @@
+name: nesting-demo
+description: null
+tags:
+  kind: web
+  complexity: moderate
+  category: on-premise
+params: 
+  - name: carbonSpecial
+    description: dummy
+    aggregation: sum
+    unit: MT
+  - name: carbonExtraSpecial
+    description: dummy
+    aggregation: sum
+    unit: MT
+aggregation:
+  type: both
+  metrics: 
+    - 'cpu-util'
+    - 'energy'
+initialize:
+  models:
+    - name: sci-e
+      path: '@grnsft/if-models'
+      model: SciEModel
+graph:
+  children:
+    child-0:
+      pipeline:
+        - sci-e
+      inputs:
+        - timestamp: 2023-07-06T00:00
+          duration: 10
+          cpu-util: 50
+          energy-network: 1

package/examples/impls/test/sci.yml

@@ -14,8 +14,8 @@ graph:
         - sci
       config:
         sci:
-          functional-unit-duration: 1
-          functional-unit-time: "1 minute"
+          functional-unit-time: 1 minute
+          functional-duration-time: ""
           functional-unit: requests # factor to convert per time to per f.unit
       inputs:
         - timestamp: 2023-07-06T00:00

package/examples/impls/test/teads-cpu.yml

@@ -0,0 +1,18 @@
+name: teads-cpu
+description: simple demo invoking teads-cpu
+tags:
+initialize:
+  models:
+    - name: teads-cpu
+      model: TeadsCurveModel
+      path: "@grnsft/if-unofficial-models"
+graph:
+  children:
+    child:
+      pipeline:
+        - teads-cpu
+      inputs:
+        - timestamp: 2023-07-06T00:00
+          duration: 3600
+          cpu-util: 50
+          thermal-design-power: 300

package/examples/impls/test/time-sync-avoid-padding.yml

@@ -0,0 +1,50 @@
+name: nesting-demo
+description: impl with 2 levels of nesting with non-uniform timing of observations, with flag to avoid padding by erroring out
+tags:
+initialize:
+  models:
+    - name: time-synchronization
+      model: TimeSyncModel
+      path: builtin
+      config:
+        start-time: 2023-12-12T00:00:00.000Z # ISO timestamp
+        end-time: 2023-12-12T00:01:00.000Z # ISO timestamp
+        interval: 5 # seconds
+        allow-padding: true
+graph:
+  children:
+    child: # an advanced grouping node
+      pipeline:
+        - time-synchronization
+      config:
+      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:15.000Z
+              duration: 10
+              cpu-util: 20
+              requests: 300
+            - timestamp: 2023-12-12T00:00:35.000Z
+              duration: 15
+              cpu-util: 20
+              requests: 400
+        child-2:
+          inputs:
+            - timestamp: 2023-12-12T00:00:00.000Z
+              duration: 10
+              cpu-util: 10
+              requests: 300
+            - timestamp: 2023-12-12T00:00:10.000Z
+              duration: 30
+              cpu-util: 20
+              requests: 380
+            - timestamp: 2023-12-12T00:00:50.000Z
+              duration: 20
+              cpu-util: 20
+              requests: 380

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

@@ -18,10 +18,11 @@ initialize:
     - name: time-synchronization
       model: TimeSyncModel
       path: builtin
-      config: 
+      config:
         start-time: 2023-12-12T00:00:00.000Z # ISO timestamp
         end-time: 2023-12-12T00:01:00.000Z # ISO timestamp
         interval: 5 # seconds
+        allow-padding: true
 graph:
   children:
     child: # an advanced grouping node
@@ -37,9 +38,9 @@ graph:
         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 
+          expected-lifespan: 126144000 # 4 years in seconds
+          resources-reserved: 1
+          total-resources: 1
         sci-o:
           grid-carbon-intensity: 457 # gCO2/kwh
       children:
@@ -48,28 +49,28 @@ graph:
             - timestamp: 2023-12-12T00:00:00.000Z
               duration: 10
               cpu-util: 10
-              carbon: 100 
-              energy: 100   
+              carbon: 100
+              energy: 100
               requests: 300
             - timestamp: 2023-12-12T00:00:15.000Z
               duration: 10
-              cpu-util: 20    
+              cpu-util: 20
               requests: 300
             - timestamp: 2023-12-12T00:00:35.000Z
               duration: 15
-              cpu-util: 20    
+              cpu-util: 20
               requests: 400
         child-2:
-          inputs: 
+          inputs:
             - timestamp: 2023-12-12T00:00:00.000Z
               duration: 10
-              cpu-util: 10    
+              cpu-util: 10
               requests: 300
             - timestamp: 2023-12-12T00:00:10.000Z
               duration: 30
-              cpu-util: 20    
+              cpu-util: 20
               requests: 380
             - timestamp: 2023-12-12T00:00:50.000Z
               duration: 20
-              cpu-util: 20    
-              requests: 380
+              cpu-util: 20
+              requests: 380

package/examples/ompls/aggregation-test2.yml

@@ -0,0 +1,83 @@
+name: nesting-demo
+description: null
+tags:
+  kind: web
+  complexity: moderate
+  category: on-premise
+params:
+  - name: carbon
+    description: dummy
+    aggregation: sum
+    unit: MT
+aggregation:
+  type: both
+  metrics:
+    - cpu-util
+    - energy
+initialize:
+  models:
+    - name: sci-e
+      path: '@grnsft/if-models'
+      model: SciEModel
+graph:
+  children:
+    child-0:
+      pipeline:
+        - sci-e
+      children:
+        child-0-1:
+          pipeline:
+            - sci-e
+          config: null
+          inputs:
+            - timestamp: 2023-07-06T00:00
+              duration: 10
+              cpu-util: 50
+              energy-network: 1
+          outputs:
+            - timestamp: 2023-07-06T00:00
+              duration: 10
+              cpu-util: 50
+              energy-network: 1
+              energy: 1
+          aggregated-outputs:
+            aggregated-cpu-util: 50
+            aggregated-energy: 1
+        child:0-2:
+          children:
+            child-0-2-1:
+              pipeline:
+                - sci-e
+              config: null
+              inputs:
+                - timestamp: 2023-07-06T00:00
+                  duration: 10
+                  cpu-util: 50
+                  energy-network: 1
+              outputs:
+                - timestamp: 2023-07-06T00:00
+                  duration: 10
+                  cpu-util: 50
+                  energy-network: 1
+                  energy: 1
+              aggregated-outputs:
+                aggregated-cpu-util: 50
+                aggregated-energy: 1
+            child-0-2-2:
+              pipeline:
+                - sci-e
+              config: null
+              inputs:
+                - timestamp: 2023-07-06T00:00
+                  duration: 10
+                  cpu-util: 50
+                  energy-network: 1
+              outputs:
+                - timestamp: 2023-07-06T00:00
+                  duration: 10
+                  cpu-util: 50
+                  energy-network: 1
+                  energy: 1
+              aggregated-outputs:
+                aggregated-cpu-util: 50
+                aggregated-energy: 1

package/examples/ompls/{azure.yml → azure-importer.yml}

@@ -1,10 +1,10 @@
-name: ccf-demo
-description: example impl invoking CCF model
+name: azure-importer
+description: example impl invoking Azure Importer model
 tags: null
 initialize:
   models:
     - name: azure-importer
-      path: if-models
+      path: "@grnsft/if-unofficial-models"
       model: AzureImporterModel
       kind: plugin
 graph:
@@ -15,7 +15,7 @@ graph:
       config:
         azure-importer: null
       inputs:
-        - timestamp: '2023-11-02T10:35:31.820Z'
+        - timestamp: "2023-11-02T10:35:31.820Z"
           duration: 3600
           azure-observation-window: 5 min
           azure-observation-aggregation: average
@@ -23,123 +23,123 @@ graph:
           azure-resource-group: vm1_group
           azure-vm-name: vm1
       outputs:
-        - timestamp: '2023-11-02T10:35:00.000Z'
+        - timestamp: "2023-11-02T10:35:00.000Z"
           duration: 300
           cloud-vendor: azure
-          cpu-util: '0.314'
+          cpu-util: "0.314"
           mem-availableGB: 0.488636416
           mem-usedGB: 0.5113635839999999
-          total-memoryGB: '1'
+          total-memoryGB: "1"
           mem-util: 51.13635839999999
           location: uksouth
           cloud-instance-type: Standard_B1s
-        - timestamp: '2023-11-02T10:40:00.000Z'
+        - timestamp: "2023-11-02T10:40:00.000Z"
           duration: 300
           cloud-vendor: azure
-          cpu-util: '0.314'
+          cpu-util: "0.314"
           mem-availableGB: 0.48978984960000005
           mem-usedGB: 0.5102101504
-          total-memoryGB: '1'
+          total-memoryGB: "1"
           mem-util: 51.021015039999995
           location: uksouth
           cloud-instance-type: Standard_B1s
-        - timestamp: '2023-11-02T10:45:00.000Z'
+        - timestamp: "2023-11-02T10:45:00.000Z"
           duration: 300
           cloud-vendor: azure
-          cpu-util: '0.301'
+          cpu-util: "0.301"
           mem-availableGB: 0.490733568
           mem-usedGB: 0.509266432
-          total-memoryGB: '1'
+          total-memoryGB: "1"
           mem-util: 50.9266432
           location: uksouth
           cloud-instance-type: Standard_B1s
-        - timestamp: '2023-11-02T10:50:00.000Z'
+        - timestamp: "2023-11-02T10:50:00.000Z"
           duration: 300
           cloud-vendor: azure
-          cpu-util: '0.298'
+          cpu-util: "0.298"
           mem-availableGB: 0.490733568
           mem-usedGB: 0.509266432
-          total-memoryGB: '1'
+          total-memoryGB: "1"
           mem-util: 50.9266432
           location: uksouth
           cloud-instance-type: Standard_B1s
-        - timestamp: '2023-11-02T10:55:00.000Z'
+        - timestamp: "2023-11-02T10:55:00.000Z"
           duration: 300
           cloud-vendor: azure
-          cpu-util: '0.301'
+          cpu-util: "0.301"
           mem-availableGB: 0.49178214400000003
           mem-usedGB: 0.5082178559999999
-          total-memoryGB: '1'
+          total-memoryGB: "1"
           mem-util: 50.82178559999999
           location: uksouth
           cloud-instance-type: Standard_B1s
-        - timestamp: '2023-11-02T11:00:00.000Z'
+        - timestamp: "2023-11-02T11:00:00.000Z"
           duration: 300
           cloud-vendor: azure
-          cpu-util: '0.298'
+          cpu-util: "0.298"
           mem-availableGB: 0.49178214400000003
           mem-usedGB: 0.5082178559999999
-          total-memoryGB: '1'
+          total-memoryGB: "1"
           mem-util: 50.82178559999999
           location: uksouth
           cloud-instance-type: Standard_B1s
-        - timestamp: '2023-11-02T11:05:00.000Z'
+        - timestamp: "2023-11-02T11:05:00.000Z"
           duration: 300
           cloud-vendor: azure
-          cpu-util: '0.304'
+          cpu-util: "0.304"
           mem-availableGB: 0.492306432
           mem-usedGB: 0.507693568
-          total-memoryGB: '1'
+          total-memoryGB: "1"
           mem-util: 50.7693568
           location: uksouth
           cloud-instance-type: Standard_B1s
-        - timestamp: '2023-11-02T11:10:00.000Z'
+        - timestamp: "2023-11-02T11:10:00.000Z"
           duration: 300
           cloud-vendor: azure
-          cpu-util: '0.3'
+          cpu-util: "0.3"
           mem-availableGB: 0.49283072000000006
           mem-usedGB: 0.50716928
-          total-memoryGB: '1'
+          total-memoryGB: "1"
           mem-util: 50.716927999999996
           location: uksouth
           cloud-instance-type: Standard_B1s
-        - timestamp: '2023-11-02T11:15:00.000Z'
+        - timestamp: "2023-11-02T11:15:00.000Z"
           duration: 300
           cloud-vendor: azure
-          cpu-util: '0.636'
+          cpu-util: "0.636"
           mem-availableGB: 0.5062524928000001
           mem-usedGB: 0.49374750719999994
-          total-memoryGB: '1'
+          total-memoryGB: "1"
           mem-util: 49.374750719999994
           location: uksouth
           cloud-instance-type: Standard_B1s
-        - timestamp: '2023-11-02T11:20:00.000Z'
+        - timestamp: "2023-11-02T11:20:00.000Z"
           duration: 300
           cloud-vendor: azure
-          cpu-util: '0.29500000000000004'
+          cpu-util: "0.29500000000000004"
           mem-availableGB: 0.509607936
           mem-usedGB: 0.490392064
-          total-memoryGB: '1'
+          total-memoryGB: "1"
           mem-util: 49.039206400000005
           location: uksouth
           cloud-instance-type: Standard_B1s
-        - timestamp: '2023-11-02T11:25:00.000Z'
+        - timestamp: "2023-11-02T11:25:00.000Z"
           duration: 300
           cloud-vendor: azure
-          cpu-util: '0.309'
+          cpu-util: "0.309"
           mem-availableGB: 0.5106565120000001
           mem-usedGB: 0.48934348799999994
-          total-memoryGB: '1'
+          total-memoryGB: "1"
           mem-util: 48.934348799999995
           location: uksouth
           cloud-instance-type: Standard_B1s
-        - timestamp: '2023-11-02T11:30:00.000Z'
+        - timestamp: "2023-11-02T11:30:00.000Z"
           duration: 300
           cloud-vendor: azure
-          cpu-util: '0.484'
+          cpu-util: "0.484"
           mem-availableGB: 0.5106565120000001
           mem-usedGB: 0.48934348799999994
-          total-memoryGB: '1'
+          total-memoryGB: "1"
           mem-util: 48.934348799999995
           location: uksouth
           cloud-instance-type: Standard_B1s

package/examples/ompls/boavizta.yml

@@ -0,0 +1,32 @@
+name: boavizta
+description: calls boavizta api
+tags: null
+initialize:
+  models:
+    - name: boavizta-cpu
+      path: '@grnsft/if-unofficial-models'
+      model: BoaviztaCpuOutputModel
+      config:
+        allocation: LINEAR
+        verbose: true
+graph:
+  children:
+    child:
+      pipeline:
+        - boavizta-cpu
+      config:
+        boavizta-cpu:
+          core-units: 24
+          physical-processor: Intel® Core™ i7-1185G7
+      inputs:
+        - timestamp: 2023-07-06T00:00
+          duration: 3600
+          cpu-util: 18.392
+        - timestamp: 2023-08-06T00:00
+          duration: 3600
+          cpu-util: 16
+      outputs:
+        - energy-cpu: 0.2777777777777778
+          embodied-carbon: 0.8
+        - energy-cpu: 0.2777777777777778
+          embodied-carbon: 0.8

package/examples/ompls/cim.yml

@@ -0,0 +1,29 @@
+name: cloud-instance-metadata
+description: example impl invoking Cloud Instance Metadata model
+tags: null
+initialize:
+  models:
+    - name: cloud-instance-metadata
+      path: "@grnsft/if-models"
+      model: CloudInstanceMetadataModel
+graph:
+  children:
+    child:
+      pipeline:
+        - cloud-instance-metadata
+      config: null
+      inputs:
+        - timestamp: '2021-01-01T00:00:00Z'
+          duration: 5
+          cloud-instance-type: m5n.large
+          cloud-vendor: aws
+      outputs:
+        - timestamp: '2021-01-01T00:00:00Z'
+          duration: 5
+          cloud-instance-type: m5n.large
+          cloud-vendor: aws
+          vcpus-allocated: 2
+          vcpus-total: 96
+          memory-available: 8
+          physical-processor: Intel® Xeon® Platinum 8259CL
+          thermal-design-power: 210

package/examples/ompls/e-mem.yml

@@ -0,0 +1,26 @@
+name: e-mem
+description: null
+tags: null
+initialize:
+  models:
+    - name: e-mem
+      path: "@grnsft/if-models"
+      model: EMemModel
+graph:
+  children:
+    child:
+      pipeline:
+        - e-mem
+      config: null
+      inputs:
+        - timestamp: 2023-08-06T00:00
+          duration: 3600
+          mem-util: 40
+          total-memoryGB: 1
+      outputs:
+        - timestamp: 2023-08-06T00:00
+          duration: 3600
+          mem-util: 40
+          total-memoryGB: 1
+          coefficient: 0.38
+          energy-memory: 0.15200000000000002

package/examples/ompls/sci.yml

@@ -4,8 +4,9 @@ tags: null
 initialize:
   models:
     - name: sci
-      kind: builtin
-      path: ""
+      kind: plugin
+      path: "@grnsft/if-models"
+      model: SciModel
 graph:
   children:
     child:
@@ -13,8 +14,7 @@ graph:
         - sci
       config:
         sci:
-          functional-unit-duration: 1
-          functional-unit-time: "1 minute"
+          functional-unit-time: 1 minute
           functional-unit: requests
       inputs:
         - timestamp: 2023-07-06T00:00
@@ -31,7 +31,7 @@ graph:
           embodied-carbon: 0.02
           requests: 100
           functional-unit-duration: 1
-          functional-unit-time: "1 minute"
+          functional-unit-time: 1 minute
           functional-unit: requests
           carbon: 0.0013944444444444442
           sci: 0.0008366666666666665

package/examples/ompls/teads-cpu.yml

@@ -0,0 +1,24 @@
+name: teads-cpu
+description: simple demo invoking teads-cpu
+tags: null
+initialize:
+  models:
+    - name: teads-cpu
+      path: '@grnsft/if-unofficial-models'
+      model: TeadsCurveModel
+graph:
+  children:
+    child:
+      pipeline:
+        - teads-cpu
+      inputs:
+        - timestamp: 2023-07-06T00:00
+          duration: 3600
+          cpu-util: 50
+          thermal-design-power: 300
+      outputs:
+        - timestamp: 2023-07-06T00:00
+          duration: 3600
+          cpu-util: 50
+          thermal-design-power: 300
+          energy-cpu: 0.225

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@grnsft/if",
   "description": "Impact Framework",
-  "version": "v0.1.8",
+  "version": "v0.1.9",
   "author": {
     "name": "Green Software Foundation",
     "email": "info@gsf.com"

package/src/models/README.md

@@ -10,6 +10,7 @@ The following should be defined in the model initialization:
 - `start-time`: global start time as ISO 8061 string
 - `stop`: global end time as ISO 8061 string
 - `interval`: temporal resolution in seconds
+- `error-on-padding`: avoid zero/'zeroish' padding (if needed) and error out instead. `False` by defult.
 
 ### Inputs:
 
@@ -114,6 +115,7 @@ The end result of this gap-filling is that we have continuous 1 second resolutio
     {timestamp: 2023-12-12T00:00:09.000Z, duration: 1, cpu-util: 12, carbon: 2.5, energy: 5, grid-carbon-intensity: 471}
 ]
 ```
+Note that when `error-on-padding` is `true` no gap-filling is performed and the model will error out instead.
 
 #### Trimming and padding
 
@@ -149,7 +151,7 @@ For example, for `startTime = 2023-12-12T00:00:00.000Z` and `endTime = 2023-12-1
 
 ]
 ```
-
+Note that when `error-on-padding` is `true` no padding is performed and the model will error out instead.
 
 #### Resampling rules