@grnsft/if 0.3.2 → 0.3.4

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@grnsft/if",
   "description": "Impact Framework",
-  "version": "v0.3.2",
+  "version": "0.3.4",
   "author": {
     "name": "Green Software Foundation",
     "email": "info@gsf.com"
@@ -24,7 +24,7 @@
     "zod": "^3.22.4"
   },
   "devDependencies": {
-    "@babel/core": "7.22.10",
+    "@babel/core": "^7.22.10",
     "@babel/preset-typescript": "^7.22.5",
     "@jest/globals": "^29.6.1",
     "@types/jest": "^29.5.7",
@@ -35,6 +35,7 @@
     "gts": "^5.0.0",
     "husky": "^8.0.0",
     "jest": "^29.6.1",
+    "release-it": "^16.3.0",
     "rimraf": "^5.0.5",
     "ts-jest": "^29.1.1"
   },
@@ -69,6 +70,7 @@
     "lint": "gts lint",
     "prepare": "husky install",
     "prepublish": "npm run build",
+    "release": "release-it",
     "test": "jest --verbose --testPathPattern=src/__tests__/unit",
     "test:integration": "jest --verbose --testPathPattern=src/__tests__/integration"
   },

package/src/__tests__/integration/manifest/sci-e.yaml

@@ -0,0 +1,23 @@
+name: integration-template
+description: null
+tags: null
+initialize:
+  plugins:
+    sci-e:
+      method: SciE
+      path: '@grnsft/if-plugins'
+  outputs:
+    - log
+tree:
+  children:
+    child:
+      pipeline:
+        - sci-e
+      config:
+        sci-e: {}
+      inputs:
+        - timestamp: 2023-08-06T00:00
+          duration: 3600
+          cpu/energy: 10
+          memory/energy: 100
+          network/energy: 100

package/examples/manifests/azure-importer.yml

@@ -1,24 +0,0 @@
-name: azure-importer
-description: example impl invoking Azure Importer model
-tags:
-initialize:
-  plugins:
-    azure-importer:
-      path: "@grnsft/if-unofficial-plugins"
-      method: AzureImporter
-      kind: plugin
-tree:
-  children:
-    child:
-      pipeline:
-        - azure-importer
-      config:
-        azure-importer:
-          azure-observation-window: 5 min # value and unit must be space separated
-          azure-observation-aggregation: "average"
-          azure-subscription-id: 42a3c589-87ce-4478-8ed6-9adc11b81965
-          azure-resource-group: Group1
-          azure-vm-name: VM1
-      inputs:
-        - timestamp: "2023-11-02T10:35:31.820Z"
-          duration: 3600

package/examples/manifests/basic-demo.yml

@@ -1,70 +0,0 @@
-name: basic-demo
-description: null
-tags: null
-initialize:
-  plugins:
-    mock-observations:
-      path: "@grnsft/if-plugins"
-      method: MockObservations
-      global-config:
-        timestamp-from: 2024-02-26T00:00
-        timestamp-to: 2024-02-26T00:10
-        duration: 60
-        components:
-          - cloud/instance-type: Standard_A1_v2
-          - cloud/instance-type: Standard_A2_v2
-        generators:
-          common:
-            cloud/vendor: azure
-            cloud/region: uk-west
-            geolocation: 37.7749,-122.4194
-          randint:
-            cpu/utilization:
-              min: 1
-              max: 99
-    teads-curve:
-      path: "@grnsft/if-unofficial-plugins"
-      method: TeadsCurve
-      global-config:
-        interpolation: spline
-    group-by:
-      path: "builtin"
-      method: GroupBy
-    cloud-metadata:
-      method: CloudMetadata
-      path: "@grnsft/if-plugins"
-    operational-carbon:
-      path: "@grnsft/if-plugins"
-      method: Multiply
-      global-config:
-        input-parameters: ["cpu/energy", "grid/carbon-intensity"]
-        output-parameter: "cpu/carbon"
-    watttime:
-      path: "@grnsft/if-unofficial-plugins"
-      method: WattTimeGridEmissions
-tree:
-  children:
-    application:
-      pipeline:
-        - mock-observations
-        # - group-by
-        - cloud-metadata
-        - teads-curve
-        - watttime
-        - operational-carbon
-      defaults:
-        grid/carbon-intensity: 250
-        geolocation: 48.8567,2.3522
-      # config:
-      #   group-by:
-      #     group:
-      #       - cloud/region
-      #       - cloud/instance-type
-      inputs:
-        - timestamp: "2024-02-26 00:00:00"
-          duration: 60
-          cloud/instance-type: Standard_A1_v2
-          cloud/vendor: azure
-          cloud/region: francesouth
-          geolocation: 48.8567,2.3522
-          cpu/utilization: 15

package/examples/manifests/boavizta-cloud.yml

@@ -1,20 +0,0 @@
-name: boavizta cloud demo
-description: calls boavizta api
-tags:
-initialize:
-  plugins:
-    "boavizta-cloud":
-      method: BoaviztaCloudOutput
-      path: "@grnsft/if-unofficial-plugins"
-tree:
-  children:
-    child:
-      pipeline:
-        - boavizta-cloud
-      defaults:
-        instance-type: r6g.medium
-        provider: aws
-      inputs:
-        - timestamp: "2021-01-01T00:00:00Z"
-          duration: 15 # Secs
-          cpu/utilization: 34

package/examples/manifests/boavizta.yml

@@ -1,26 +0,0 @@
-name: boavizta
-description: calls boavizta api
-tags:
-initialize:
-  plugins:
-    "boavizta-cpu":
-      method: BoaviztaCpuOutput
-      path: "@grnsft/if-unofficial-plugins"
-      global-config:
-        allocation: LINEAR
-        verbose: true
-tree:
-  children:
-    child:
-      pipeline:
-        - boavizta-cpu
-      defaults:
-        cpu/number-cores: 24
-        cpu/name: Intel® Core™ i7-1185G7
-      inputs:
-        - timestamp: 2023-07-06T00:00 # [KEYWORD] [NO-SUBFIELDS] time when measurement occurred
-          duration: 3600 # Secs
-          cpu/utilization: 18.392
-        - timestamp: 2023-08-06T00:00 # [KEYWORD] [NO-SUBFIELDS] time when measurement occurred
-          duration: 3600 # Secs
-          cpu/utilization: 16

package/examples/manifests/ccf.yml

@@ -1,20 +0,0 @@
-name: ccf-demo
-description: example impl invoking CCF model
-tags:
-initialize:
-  plugins:
-    ccf:
-      method: CloudCarbonFootprint
-      path: "@grnsft/if-unofficial-plugins"
-tree:
-  children:
-    child:
-      pipeline:
-        - ccf
-      defaults:
-        cloud/vendor: "aws"
-        cloud/instance-type: "m5n.large"
-      inputs:
-        - timestamp: 2023-07-06T00:00 # [KEYWORD] [NO-SUBFIELDS] time when measurement occurred
-          duration: 1
-          cpu/utilization: 10

package/examples/manifests/cloud-metadata-teads.yml

@@ -1,41 +0,0 @@
-name: cloud-metadata-demo
-description: null
-tags: null
-initialize:
-  plugins:
-    teads-curve:
-      path: "@grnsft/if-unofficial-plugins"
-      method: TeadsCurve
-      global-config:
-        interpolation: spline
-    cloud-metadata:
-      method: CloudMetadata
-      path: "@grnsft/if-plugins"
-tree:
-  children:
-    child-0:
-      defaults:
-        cpu/thermal-design-power: 100
-        cloud/vendor: aws
-        cloud/instance-type: m5n.large
-      pipeline:
-        - teads-curve
-        - cloud-metadata
-      inputs:
-        - timestamp: 2023-07-06T00:00
-          duration: 10
-          cpu/utilization: 80
-        - timestamp: 2023-07-06T00:01
-          duration: 10
-          cpu/utilization: 80
-      outputs:
-        - timestamp: 2023-07-06T00:00
-          duration: 10
-          cpu/utilization: 80
-          cpu/thermal-design-power: 100
-          cpu/energy: 0.00025568089430894314
-        - timestamp: 2023-07-06T00:01
-          duration: 10
-          cpu/utilization: 80
-          cpu/thermal-design-power: 100
-          cpu/energy: 0.00025568089430894314

package/examples/manifests/co2js.yml

@@ -1,30 +0,0 @@
-name: co2js-demo
-description: example impl invoking CO2.JS model
-tags:
-initialize:
-  plugins:
-    co2js:
-      method: Co2js
-      path: "@grnsft/if-unofficial-plugins"
-      global-config:
-        options:
-          dataReloadRatio: 0.6
-          firstVisitPercentage: 0.9
-          returnVisitPercentage: 0.1
-          gridIntensity:
-            device: 560.98
-            dataCenter:
-              country: "TWN"
-tree:
-  children:
-    child:
-      pipeline:
-        - co2js
-      config:
-        co2js:
-          type: swd
-          green-web-host: true
-      inputs:
-        - timestamp: 2023-07-06T00:00
-          duration: 1
-          network/data/bytes: 1000000

package/examples/manifests/csv-export.yml

@@ -1,34 +0,0 @@
-name: csv-export-demo
-description: example exporting output to a csv file
-tags:
-initialize:
-  plugins:
-    csv-exporter:
-      method: CsvExport
-      path: "@grnsft/if-plugins"
-tree:
-  children:
-    child:
-      pipeline:
-        - csv-exporter
-      config:
-        csv-exporter:
-          output-path: ./examples/outputs/csv-test.csv
-          headers:
-            - timestamp
-            - duration
-            - carbon
-            - energy
-      inputs:
-        - timestamp: 2023-07-06T00:00
-          duration: 1
-          operational-carbon: 0.02
-          embodied-carbon: 5
-          energy: 3.5
-          carbon: 5.02
-        - timestamp: 2023-07-06T00:10
-          duration: 1
-          operational-carbon: 0.03
-          embodied-carbon: 4
-          energy: 2.9
-          carbon: 4.03

package/examples/manifests/e-mem.yml

@@ -1,21 +0,0 @@
-name: e-mem
-description:
-tags:
-initialize:
-  plugins:
-    e-mem:
-      method: EMem
-      path: "@grnsft/if-plugins"
-      global-config:
-        energy-per-gb: 0.002
-tree:
-  children:
-    child:
-      pipeline:
-        - e-mem
-      config:
-      inputs:
-        - timestamp: 2023-08-06T00:00
-          duration: 3600
-          memory/utilization: 40
-          memory/capacity: 1

package/examples/manifests/e-net.yml

@@ -1,22 +0,0 @@
-name: e-net-demo
-description:
-tags:
-initialize:
-  plugins:
-    e-net:
-      method: ENet
-      path: "@grnsft/if-plugins"
-      global-config:
-        energy-per-gb: 0.02
-tree:
-  children:
-    child:
-      pipeline:
-        - e-net
-      config:
-        e-net:
-      inputs:
-        - timestamp: 2023-08-06T00:00
-          duration: 3600
-          network/data-in: 1
-          network/data-out: 2

package/examples/manifests/nesting-demo.yml

@@ -1,89 +0,0 @@
-name: nesting-demo
-description: null
-tags:
-  kind: web
-  complexity: moderate
-  category: on-premise
-params:
-aggregation:
-  type: vertical
-  metrics:
-    - "energy"
-initialize:
-  plugins:
-    teads-curve:
-      path: "@grnsft/if-unofficial-plugins"
-      method: TeadsCurve
-      global-config:
-        interpolation: spline
-    sci-e:
-      path: "@grnsft/if-plugins"
-      method: SciE
-    sci-m:
-      path: "@grnsft/if-plugins"
-      method: SciM
-    sci-o:
-      path: "@grnsft/if-plugins"
-      method: SciO
-    "time-sync":
-      method: TimeSync
-      path: "builtin"
-      global-config:
-        start-time: "2023-12-12T00:00:00.000Z"
-        end-time: "2023-12-12T00:01:00.000Z"
-        interval: 5
-        allow-padding: true
-    sci:
-      path: "@grnsft/if-plugins"
-      method: Sci
-      global-config:
-        functional-unit: "requests"
-        functional-unit-time: "1 minute"
-tree:
-  children:
-    child-0:
-      defaults:
-        cpu/thermal-design-power: 100
-        grid/carbon-intensity: 800
-        device/emissions-embodied: 1533.120 # gCO2eq
-        time-reserved: 3600 # 1hr in seconds
-        device/expected-lifespan: 94608000 # 3 years in seconds
-        resources-reserved: 1
-        resources-total: 8
-        functional-unit-time: "1 min"
-      pipeline:
-        - teads-curve
-        - sci-e
-        - sci-m
-        - sci-o
-        - time-sync
-        - sci
-      inputs:
-        - timestamp: "2023-12-12T00:00:00.000Z"
-          duration: 10
-          cpu/utilization: 50
-          network/energy: 1
-          energy: 1
-    child-1:
-      defaults:
-        cpu/thermal-design-power: 100
-        grid/carbon-intensity: 800
-        device/emissions-embodied: 1533.120 # gCO2eq
-        time-reserved: 3600 # 1hr in seconds
-        device/expected-lifespan: 94608000 # 3 years in seconds
-        resources-reserved: 1
-        resources-total: 8
-        functional-unit-time: "1 min"
-      pipeline:
-        - teads-curve
-        - sci-e
-        - sci-m
-        - sci-o
-        - time-sync
-        - sci
-      inputs:
-        - timestamp: "2023-12-12T00:00:00.000Z"
-          duration: 10
-          cpu/utilization: 30
-          network/energy: 1
-          energy: 1

package/examples/manifests/pipeline-demo-1.yml

@@ -1,85 +0,0 @@
-name: pipeline-demo
-description:
-tags:
-initialize:
-  plugins:
-    boavizta-cpu:
-      method: BoaviztaCpuOutput
-      path: "@grnsft/if-unofficial-plugins"
-      global-config:
-        allocation: LINEAR
-        verbose: true
-    "sum":
-      path: "@grnsft/if-plugins"
-      method: Sum
-      global-config:
-        input-parameters:
-          - cpu/energy
-          - network/energy
-        output-parameter: energy
-    "sci-m":
-      path: "@grnsft/if-plugins"
-      method: SciM
-    "sci-o":
-      path: "@grnsft/if-plugins"
-      method: SciO
-    "sci":
-      path: "@grnsft/if-plugins"
-      method: Sci
-      global-config:
-        functional-unit: ""
-        functional-unit-time: "1-day"
-    "time-sync":
-      method: TimeSync
-      path: "builtin"
-      global-config:
-        start-time: "2023-12-12T00:00:00.000Z"
-        end-time: "2023-12-12T00:01:00.000Z"
-        interval: 5
-        allow-padding: true
-tree:
-  children:
-    child-1:
-      pipeline:
-        - boavizta-cpu
-        - sum
-        - sci-m
-        - sci-o
-        - time-sync
-        - sci
-      config:
-      defaults:
-        cpu/thermal-design-power: 100
-        grid/carbon-intensity: 800
-        device/emissions-embodied: 1533.120 # gCO2eq
-        time-reserved: 3600 # 1hr in seconds
-        device/expected-lifespan: 94608000 # 3 years in seconds
-        resources-reserved: 1
-        resources-total: 8
-        cpu/number-cores: 24
-        cpu/name: Intel® Core™ i7-1185G7
-      inputs:
-        - timestamp: "2023-12-12T00:00:00.000Z"
-          cloud/instance-type: A1
-          cloud/region: uk-west
-          duration: 1
-          cpu/utilization: 50
-          network/energy: 0.000001
-        - timestamp: "2023-12-12T00:00:01.000Z"
-          duration: 5
-          cpu/utilization: 20
-          cloud/instance-type: A1
-          cloud/region: uk-west
-          network/energy: 0.000001
-        - timestamp: "2023-12-12T00:00:06.000Z"
-          duration: 7
-          cpu/utilization: 15
-          cloud/instance-type: A1
-          cloud/region: uk-west
-          network/energy: 0.000001
-        - timestamp: "2023-12-12T00:00:13.000Z"
-          duration: 30
-          cloud/instance-type: A1
-          cloud/region: uk-west
-          cpu/utilization: 15
-          network/energy: 0.000001

package/examples/manifests/pipeline-with-generics.yml

@@ -1,152 +0,0 @@
-name: pipeline-with-generics-demo
-description:
-tags:
-aggregation:
-  metrics:
-    - "carbon"
-  type: "both"
-params:
-  - name: energy-sum
-    description: "sum of energies"
-    unit: "kWh"
-    aggregation: sum
-initialize:
-  plugins:
-    "teads-curve":
-      path: "@grnsft/if-unofficial-plugins"
-      method: TeadsCurve
-      global-config:
-        interpolation: spline
-    "sum":
-      path: "@grnsft/if-plugins"
-      method: Sum
-      global-config:
-        input-parameters:
-          - cpu/energy
-          - network/energy
-        output-parameter: energy-sum
-    "coefficient":
-      path: "@grnsft/if-plugins"
-      method: Coefficient
-      global-config:
-        input-parameter: energy
-        coefficient: 2
-        output-parameter: energy-doubled
-    "sci-m":
-      path: "@grnsft/if-plugins"
-      method: SciM
-    "sci-o":
-      path: "@grnsft/if-plugins"
-      method: SciO
-    "sci":
-      path: "@grnsft/if-plugins"
-      method: Sci
-      global-config:
-        functional-unit: "requests"
-        functional-unit-time: "1 minute"
-    "time-sync":
-      method: TimeSync
-      path: "builtin"
-      global-config:
-        start-time: "2023-12-12T00:00:00.000Z"
-        end-time: "2023-12-12T00:01:00.000Z"
-        interval: 5
-        allow-padding: true
-tree:
-  children:
-    child-1:
-      pipeline:
-        - teads-curve
-        - sum
-        - sci-m
-        - sci-o
-        - time-sync
-        - coefficient
-        - sci
-      config:
-      defaults:
-        cpu/thermal-design-power: 100
-        grid/carbon-intensity: 800
-        device/emissions-embodied: 1533.120 # gCO2eq
-        time-reserved: 3600 # 1hr in seconds
-        device/expected-lifespan: 94608000 # 3 years in seconds
-        resources-reserved: 1
-        resources-total: 8
-        functional-unit-time: "1 min"
-      inputs:
-        - timestamp: "2023-12-12T00:00:00.000Z"
-          cloud/instance-type: A1
-          cloud/region: uk-west
-          duration: 1
-          cpu/utilization: 50
-          network/energy: 10
-          energy: 5
-        - timestamp: "2023-12-12T00:00:01.000Z"
-          duration: 5
-          cpu/utilization: 20
-          cloud/instance-type: A1
-          cloud/region: uk-west
-          network/energy: 10
-          energy: 5
-        - timestamp: "2023-12-12T00:00:06.000Z"
-          duration: 7
-          cpu/utilization: 15
-          cloud/instance-type: A1
-          cloud/region: uk-west
-          network/energy: 10
-          energy: 5
-        - timestamp: "2023-12-12T00:00:13.000Z"
-          duration: 30
-          cloud/instance-type: A1
-          cloud/region: uk-west
-          cpu/utilization: 15
-          network/energy: 10
-          energy: 5
-    child-2:
-      pipeline:
-        - teads-curve
-        - sum
-        - sci-m
-        - sci-o
-        - time-sync
-        - coefficient
-        - sci
-      config:
-      defaults:
-        cpu/thermal-design-power: 100
-        grid/carbon-intensity: 800
-        device/emissions-embodied: 1533.120 # gCO2eq
-        time-reserved: 3600 # 1hr in seconds
-        device/expected-lifespan: 94608000 # 3 years in seconds
-        resources-reserved: 1
-        resources-total: 8
-        functional-unit-time: "1 min"
-      inputs:
-        - timestamp: "2023-12-12T00:00:00.000Z"
-          duration: 1
-          cpu/utilization: 30
-          cloud/instance-type: A1
-          cloud/region: uk-west
-          network/energy: 10
-          energy: 5
-        - timestamp: "2023-12-12T00:00:01.000Z"
-          duration: 5
-          cpu/utilization: 28
-          cloud/instance-type: A1
-          cloud/region: uk-west
-          network/energy: 10
-          energy: 5
-        - timestamp: "2023-12-12T00:00:06.000Z"
-          duration: 7
-          cpu/utilization: 40
-          cloud/instance-type: A1
-          cloud/region: uk-west
-          network/energy: 10
-          energy: 5
-        - timestamp: "2023-12-12T00:00:13.000Z"
-          duration: 30
-          cpu/utilization: 33
-          cloud/instance-type: A1
-          cloud/region: uk-west
-          network/energy: 10
-          energy: 5