@grnsft/if 0.0.6 → 0.1.1

package/examples/impls/test/azure.yml

@@ -4,7 +4,7 @@ tags:
 initialize:
   models:
     - name: azure-importer
-      path: if-models
+      path: "@grnsft/if-unofficial-models"
       model: AzureImporterModel
       kind: plugin
 graph:
@@ -15,12 +15,12 @@ graph:
       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
+        - 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

@@ -1,9 +1,11 @@
 name: ccf-demo
 description: example impl invoking CCF model
+tags:
 initialize:
   models:
     - name: ccf
-      kind: builtin
+      model: CloudCarbonFootprint
+      path: "@grnsft/if-unofficial-models"
 graph:
   children:
     child:
@@ -11,8 +13,8 @@ graph:
         - ccf
       config:
         ccf:
-          vendor: aws
-          instance-type: m5n.large
+          vendor: 'aws'
+          instance-type: 'm5n.large'
       inputs:
         - timestamp: 2023-07-06T00:00 # [KEYWORD] [NO-SUBFIELDS] time when measurement occurred
           duration: 1

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

@@ -4,21 +4,29 @@ tags:
 initialize:
   models:
     - name: azure-importer
-      kind: builtin
+      model: AzureImporterModel
+      path: "@grnsft/if-unofficial-models"
     - name: cloud-instance-metadata
-      kind: builtin
+      model: CloudInstanceMetadataModel
+      path: "@grnsft/if-models"
     - name: teads-curve
-      kind: builtin
+      model: TeadsCurveModel
+      path: "@grnsft/if-unofficial-models"
     - name: sci-e
-      kind: builtin
+      model: SciEModel
+      path: "@grnsft/if-models"
     - name: sci-o
-      kind: builtin
+      model: SciOModel
+      path: "@grnsft/if-models"
     - name: sci-e
-      kind: builtin
+      model: SciEModel
+      path: "@grnsft/if-models"
     - name: sci-m
-      kind: builtin
+      model: SciMModel
+      path: "@grnsft/if-models"
     - name: sci
-      kind: builtin
+      model: SciModel
+      path: "@grnsft/if-models"
 graph:
   children:
     child:
@@ -31,6 +39,8 @@ graph:
         - sci-m
         - sci
       config:
+        sci-o:
+          grid-carbon-intensity: 951
         sci:
           functional-unit: ''
           functional-unit-time: hour
@@ -43,9 +53,9 @@ graph:
             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

@@ -1,10 +1,11 @@
-name: sci-m
+name: cloud-instance-metadata
 description: simple demo invoking metadata lookup
 tags: null
 initialize:
   models:
     - name: cloud-instance-metadata
-      kind: builtin
+      model: CloudInstanceMetadataModel
+      path: "@grnsft/if-models"
 graph:
   children:
     child:

package/examples/impls/test/nesting.yml

@@ -7,23 +7,20 @@ tags:
 initialize:
   models:
     - name: teads-curve
-      kind: builtin
+      model: TeadsCurveModel
+      path: "@grnsft/if-unofficial-models"
     - name: sci-e
-      kind: builtin
-      verbose: false
-      path: ''
+      model: SciEModel
+      path: "@grnsft/if-models"
     - name: sci-m
-      kind: builtin
-      verbose: false
-      path: ''
+      path: "@grnsft/if-models"
+      model: SciMModel
     - name: sci-o
-      kind: builtin
-      verbose: false
-      path: ''
+      model: SciOModel
+      path: "@grnsft/if-models"
     - name: sci
-      kind: builtin
-      verbose: false
-      path: ''
+      model: SciModel
+      path: "@grnsft/if-models"
 graph:
   children:
     child: # an advanced grouping node

package/examples/impls/test/sci-e.yml

@@ -7,7 +7,7 @@ initialize:
       kind: plugin
       verbose: false
       model: SciEModel
-      path: if-models
+      path: "@grnsft/if-models"
 graph:
   children:
     child:

package/examples/impls/test/sci-m.yml

@@ -4,9 +4,9 @@ tags:
 initialize:
   models:
     - name: sci-m # a model that calculates m from te, tir, el, rr and rtor
-      kind: builtin
+      model: SciMModel
       verbose: false
-      path: ''
+      path: "@grnsft/if-models"
 graph:
   children:
     child:

package/examples/impls/test/sci-o.yml

@@ -5,14 +5,12 @@ initialize:
   models:
     - name: sci-e
       kind: plugin
-      verbose: false
       model: SciEModel
-      path: if-models
+      path: "@grnsft/if-models"
     - name: sci-o
-      kind: plugin
       verbose: false
       model: SciOModel
-      path: if-models
+      path: "@grnsft/if-models"
 graph:
   children:
     child:

package/examples/impls/test/sci.yml

@@ -1,27 +1,50 @@
-name: sci-demo
-description: example invoking sci model
+name: example
+description: a simple example manifest
 tags:
 initialize:
   models:
-    - name: sci 
-      kind: plugin
-      verbose: false
+    - name: teads-curve
+      model: TestBadImpl
+      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: if-models
+      path: "@grnsft/if-models"
 graph:
   children:
-    child:
+    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-unit-time: 'minutes'
+          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
-          energy: 5
-          operational-carbon: 5
-          embodied-carbon: 0.02
-          requests: 100
+        - timestamp: '2023-07-06T00:00'
+          duration: 10
+          cpu-util: 50
+          e-net: 0.000811 #kwh
+          requests: 380

package/examples/impls/test/shell.yml

@@ -4,7 +4,8 @@ tags:
 initialize:
   models:
     - name: sampler
-      kind: shell
+      model: ShellModel
+      path: "@grnsft/if-models"
 graph:
   children:
     child:

package/examples/impls/{tdp-finder-test.yml → test/tdp-finder.yml}

@@ -1,19 +1,19 @@
-name: tdp-tester
+name: tdp-finder
+description: demo
+tags:
 initialize:
   models:
     - name: tdp-finder # a model that returns an embodied value given the sci embodied attribution equation.
-      kind: builtin
-      verbose: false
-      path: ''
+      model: TdpFinderModel 
+      path: "@grnsft/if-models"
 graph:
   children:
-    backend:
+    child:
       pipeline: 
         - tdp-finder
       config:
-        tdp-finder:
-          tdp:
-      observations:
+      inputs:
         - timestamp: 2023-07-06T00:00
+          duration: 300
           physical-processor: AMD 3020e
 

package/examples/ompls/ccf.yml

@@ -1,9 +1,11 @@
 name: ccf-demo
 description: example impl invoking CCF model
+tags:
 initialize:
   models:
     - name: ccf
-      kind: builtin
+      model: CloudCarbonMetadataModel
+      path: if-models
 graph:
   children:
     child:

package/examples/ompls/if-demo.yml

@@ -1,21 +1,32 @@
-name: ccf-demo
-description: example impl invoking CCF model
+name: if-demo
+description: demo pipeline
+tags: null
 initialize:
   models:
     - name: azure-importer
-      kind: builtin
+      path: if-models
+      model: AzureImporterModel
     - name: cloud-instance-metadata
-      kind: builtin
+      path: if-models
+      model: CloudInstanceMetadataModel
     - name: teads-curve
-      kind: builtin
+      path: if-community-models
+      model: TeadsCurveModel
     - name: sci-e
-      kind: builtin
+      path: if-models
+      model: SciEModel
     - name: sci-o
-      kind: builtin
+      path: if-models
+      model: SciOModel
+    - name: sci-e
+      path: if-models
+      model: SciEModel
     - name: sci-m
-      kind: builtin
+      path: if-models
+      model: SciMModel
     - name: sci
-      kind: builtin
+      path: if-models
+      model: SciModel
 graph:
   children:
     child:
@@ -28,6 +39,8 @@ graph:
         - sci-m
         - sci
       config:
+        sci-o:
+          grid-carbon-intensity: 951
         sci:
           functional-unit: ''
           functional-unit-time: hour
@@ -40,7 +53,6 @@ graph:
           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
@@ -62,12 +74,12 @@ graph:
           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
           resources-reserved: 1
           total-resources: 64
+          grid-carbon-intensity: 951
           functional-unit: ''
           functional-unit-time: hour
           functional-unit-duration: 1
@@ -83,6 +95,7 @@ graph:
           energy: 0.0028475446387886973
           operational-carbon: 2.708014951488051
           embodied-carbon: 0.00007616949023199022
+          carbon: 0.009026970403260942
           sci: 32.49709345173939
         - timestamp: '2023-11-02T10:35:31.820Z'
           cloud-vendor: azure
@@ -99,12 +112,12 @@ graph:
           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
           resources-reserved: 1
           total-resources: 64
+          grid-carbon-intensity: 951
           functional-unit: ''
           functional-unit-time: hour
           functional-unit-duration: 1
@@ -120,6 +133,7 @@ graph:
           energy: 0.0028475446387886973
           operational-carbon: 2.708014951488051
           embodied-carbon: 0.00007616949023199022
+          carbon: 0.009026970403260942
           sci: 32.49709345173939
         - timestamp: '2023-11-02T10:35:31.820Z'
           cloud-vendor: azure
@@ -136,12 +150,12 @@ graph:
           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
           resources-reserved: 1
           total-resources: 64
+          grid-carbon-intensity: 951
           functional-unit: ''
           functional-unit-time: hour
           functional-unit-duration: 1
@@ -157,6 +171,7 @@ graph:
           energy: 0.0028414365818491432
           operational-carbon: 2.7022061893385354
           embodied-carbon: 0.00007616949023199022
+          carbon: 0.009007607862762558
           sci: 32.42738830594521
         - timestamp: '2023-11-02T10:35:31.820Z'
           cloud-vendor: azure
@@ -173,12 +188,12 @@ graph:
           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
           resources-reserved: 1
           total-resources: 64
+          grid-carbon-intensity: 951
           functional-unit: ''
           functional-unit-time: hour
           functional-unit-duration: 1
@@ -194,6 +209,7 @@ graph:
           energy: 0.0028400270215236593
           operational-carbon: 2.700865697469
           embodied-carbon: 0.00007616949023199022
+          carbon: 0.009003139556530775
           sci: 32.41130240351079
         - timestamp: '2023-11-02T10:35:31.820Z'
           cloud-vendor: azure
@@ -210,12 +226,12 @@ graph:
           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
           resources-reserved: 1
           total-resources: 64
+          grid-carbon-intensity: 951
           functional-unit: ''
           functional-unit-time: hour
           functional-unit-duration: 1
@@ -231,6 +247,7 @@ graph:
           energy: 0.0028414365818491432
           operational-carbon: 2.7022061893385354
           embodied-carbon: 0.00007616949023199022
+          carbon: 0.009007607862762558
           sci: 32.42738830594521
         - timestamp: '2023-11-02T10:35:31.820Z'
           cloud-vendor: azure
@@ -247,12 +264,12 @@ graph:
           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
           resources-reserved: 1
           total-resources: 64
+          grid-carbon-intensity: 951
           functional-unit: ''
           functional-unit-time: hour
           functional-unit-duration: 1
@@ -268,6 +285,7 @@ graph:
           energy: 0.0028400270215236593
           operational-carbon: 2.700865697469
           embodied-carbon: 0.00007616949023199022
+          carbon: 0.009003139556530775
           sci: 32.41130240351079
         - timestamp: '2023-11-02T10:35:31.820Z'
           cloud-vendor: azure
@@ -284,12 +302,12 @@ graph:
           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
           resources-reserved: 1
           total-resources: 64
+          grid-carbon-intensity: 951
           functional-unit: ''
           functional-unit-time: hour
           functional-unit-duration: 1
@@ -305,6 +323,7 @@ graph:
           energy: 0.0028428461389389424
           operational-carbon: 2.7035466781309343
           embodied-carbon: 0.00007616949023199022
+          carbon: 0.00901207615873722
           sci: 32.44347417145399
         - timestamp: '2023-11-02T10:35:31.820Z'
           cloud-vendor: azure
@@ -321,12 +340,12 @@ graph:
           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
           resources-reserved: 1
           total-resources: 64
+          grid-carbon-intensity: 951
           functional-unit: ''
           functional-unit-time: hour
           functional-unit-duration: 1
@@ -342,6 +361,7 @@ graph:
           energy: 0.0028409667287652447
           operational-carbon: 2.701759359055748
           embodied-carbon: 0.00007616949023199022
+          carbon: 0.009006118428486599
           sci: 32.42202634255176
         - timestamp: '2023-11-02T10:35:31.820Z'
           cloud-vendor: azure
@@ -358,12 +378,12 @@ graph:
           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
           resources-reserved: 1
           total-resources: 64
+          grid-carbon-intensity: 951
           functional-unit: ''
           functional-unit-time: hour
           functional-unit-duration: 1
@@ -379,6 +399,7 @@ graph:
           energy: 0.0029988096470848187
           operational-carbon: 2.8518679743776625
           embodied-carbon: 0.00007616949023199022
+          carbon: 0.009506480479559648
           sci: 34.22332972641473
         - timestamp: '2023-11-02T10:35:31.820Z'
           cloud-vendor: azure
@@ -395,12 +416,12 @@ graph:
           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
           resources-reserved: 1
           total-resources: 64
+          grid-carbon-intensity: 951
           functional-unit: ''
           functional-unit-time: hour
           functional-unit-duration: 1
@@ -416,6 +437,7 @@ graph:
           energy: 0.0028386174579947384
           operational-carbon: 2.699525202552996
           embodied-carbon: 0.00007616949023199022
+          carbon: 0.008998671240144094
           sci: 32.39521646451874
         - timestamp: '2023-11-02T10:35:31.820Z'
           cloud-vendor: azure
@@ -432,12 +454,12 @@ graph:
           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
           resources-reserved: 1
           total-resources: 64
+          grid-carbon-intensity: 951
           functional-unit: ''
           functional-unit-time: hour
           functional-unit-duration: 1
@@ -453,6 +475,7 @@ graph:
           energy: 0.0028451953934772694
           operational-carbon: 2.705780819196883
           embodied-carbon: 0.00007616949023199022
+          carbon: 0.009019523295623716
           sci: 32.470283864245374
         - timestamp: '2023-11-02T10:35:31.820Z'
           cloud-vendor: azure
@@ -469,12 +492,12 @@ graph:
           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
           resources-reserved: 1
           total-resources: 64
+          grid-carbon-intensity: 951
           functional-unit: ''
           functional-unit-time: hour
           functional-unit-duration: 1
@@ -490,4 +513,5 @@ graph:
           energy: 0.002927412423351122
           operational-carbon: 2.783969214606917
           embodied-carbon: 0.00007616949023199022
+          carbon: 0.00928015128032383
           sci: 33.40854460916579

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@grnsft/if",
   "description": "Impact Framework",
-  "version": "v0.0.6",
+  "version": "v0.1.1",
   "author": {
     "name": "Green Software Foundation",
     "email": "info@gsf.com"
@@ -31,11 +31,19 @@
     "ts-jest": "^29.1.1"
   },
   "engines": {
-    "node": "18",
-    "yarn": "1.22.19"
+    "node": ">=18",
+    "yarn": ">=1.22",
+    "npm": ">=8"
   },
   "homepage": "https://greensoftware.foundation",
-  "keywords": [],
+  "keywords": [
+    "engine",
+    "green software foundation",
+    "greensoftware",
+    "if",
+    "impact",
+    "models"
+  ],
   "license": "MIT",
   "main": "build/index.js",
   "publishConfig": {
@@ -45,13 +53,13 @@
     "url": "https://github.com/Green-Software-Foundation/if"
   },
   "scripts": {
-    "build": "tsc",
+    "build": "rm -rf build && tsc --project tsconfig.build.json",
     "coverage": "jest --verbose --coverage",
     "fix": "gts fix",
     "fix:package": "fixpack",
-    "impact-engine": "npx ts-node impact-engine.ts",
+    "impact-engine": "npx ts-node src/index.ts",
     "lint": "gts lint",
-    "prepare": "yarn build",
+    "prepublish": "yarn build",
     "test": "jest --verbose"
   },
   "stability": "stable",