@grnsft/if 0.6.0 → 0.7.0

package/manifests/outputs/builtins/sci-embodied/scenario-1.yaml

@@ -0,0 +1,100 @@
+name: embodied-carbon demo
+description: null
+tags: null
+aggregation:
+  metrics:
+    - embodied-carbon
+  type: both
+initialize:
+  plugins:
+    embodied-carbon:
+      path: builtin
+      method: SciEmbodied
+      config:
+        output-parameter: embodied-carbon
+execution:
+  command: >-
+    /Users/manushak/.npm/_npx/1bf7c3c15bf47d04/node_modules/.bin/ts-node
+    /Users/manushak/Documents/Projects/Green-Software/if/src/if-run/index.ts -m
+    manifests/outputs/builtins/sci-embodied/scenario-1.yaml
+  environment:
+    if-version: 0.6.0
+    os: macOS
+    os-version: 14.6.1
+    node-version: 18.20.4
+    date-time: 2024-10-04T09:06:05.353Z (UTC)
+    dependencies:
+      - '@babel/core@7.22.10'
+      - '@babel/preset-typescript@7.23.3'
+      - '@commitlint/cli@18.6.0'
+      - '@commitlint/config-conventional@18.6.0'
+      - '@grnsft/if-core@0.0.25'
+      - '@jest/globals@29.7.0'
+      - '@types/jest@29.5.8'
+      - '@types/js-yaml@4.0.9'
+      - '@types/luxon@3.4.2'
+      - '@types/node@20.9.0'
+      - axios-mock-adapter@1.22.0
+      - axios@1.7.2
+      - cross-env@7.0.3
+      - csv-parse@5.5.6
+      - csv-stringify@6.4.6
+      - fixpack@4.0.0
+      - gts@5.2.0
+      - husky@8.0.3
+      - jest@29.7.0
+      - js-yaml@4.1.0
+      - lint-staged@15.2.2
+      - luxon@3.4.4
+      - release-it@16.3.0
+      - rimraf@5.0.5
+      - ts-command-line-args@2.5.1
+      - ts-jest@29.1.1
+      - typescript-cubic-spline@1.0.1
+      - typescript@5.2.2
+      - winston@3.11.0
+      - zod@3.23.8
+  status: success
+tree:
+  children:
+    child:
+      pipeline:
+        compute:
+          - embodied-carbon
+      inputs:
+        - timestamp: 2023-08-06T00:00
+          duration: 3600
+          hdd: 2
+        - timestamp: 2023-08-06T10:00
+          duration: 3600
+          hdd: 2
+      outputs:
+        - timestamp: 2023-08-06T00:00
+          duration: 3600
+          hdd: 2
+          vCPUs: 1
+          memory: 16
+          ssd: 0
+          gpu: 0
+          usage-ratio: 1
+          embodied-carbon: 34.24657534246575
+        - timestamp: 2023-08-06T10:00
+          duration: 3600
+          hdd: 2
+          vCPUs: 1
+          memory: 16
+          ssd: 0
+          gpu: 0
+          usage-ratio: 1
+          embodied-carbon: 34.24657534246575
+      aggregated:
+        embodied-carbon: 68.4931506849315
+  outputs:
+    - embodied-carbon: 34.24657534246575
+      timestamp: 2023-08-06T00:00
+      duration: 3600
+    - embodied-carbon: 34.24657534246575
+      timestamp: 2023-08-06T10:00
+      duration: 3600
+  aggregated:
+    embodied-carbon: 68.4931506849315

package/manifests/outputs/builtins/sci-embodied/scenario-2.yaml

@@ -0,0 +1,101 @@
+name: embodied-carbon demo
+description: null
+tags: null
+initialize:
+  plugins:
+    embodied-carbon:
+      path: builtin
+      method: SciEmbodied
+      config:
+        baseline-vcpus: 1
+        baseline-memory: 16
+        lifespan: 157680000
+        baseline-emissions: 2000000
+        vcpu-emissions-constant: 100000
+        memory-emissions-constant: 1172
+        ssd-emissions-constant: 50000
+        hdd-emissions-constant: 100000
+        gpu-emissions-constant: 150000
+        output-parameter: embodied-carbon
+execution:
+  command: >-
+    /Users/manushak/.npm/_npx/1bf7c3c15bf47d04/node_modules/.bin/ts-node
+    /Users/manushak/Documents/Projects/Green-Software/if/src/if-run/index.ts -m
+    manifests/outputs/builtins/sci-embodied/scenario-2.yaml
+  environment:
+    if-version: 0.6.0
+    os: macOS
+    os-version: 14.6.1
+    node-version: 18.20.4
+    date-time: 2024-10-04T09:08:03.615Z (UTC)
+    dependencies:
+      - '@babel/core@7.22.10'
+      - '@babel/preset-typescript@7.23.3'
+      - '@commitlint/cli@18.6.0'
+      - '@commitlint/config-conventional@18.6.0'
+      - '@grnsft/if-core@0.0.25'
+      - '@jest/globals@29.7.0'
+      - '@types/jest@29.5.8'
+      - '@types/js-yaml@4.0.9'
+      - '@types/luxon@3.4.2'
+      - '@types/node@20.9.0'
+      - axios-mock-adapter@1.22.0
+      - axios@1.7.2
+      - cross-env@7.0.3
+      - csv-parse@5.5.6
+      - csv-stringify@6.4.6
+      - fixpack@4.0.0
+      - gts@5.2.0
+      - husky@8.0.3
+      - jest@29.7.0
+      - js-yaml@4.1.0
+      - lint-staged@15.2.2
+      - luxon@3.4.4
+      - release-it@16.3.0
+      - rimraf@5.0.5
+      - ts-command-line-args@2.5.1
+      - ts-jest@29.1.1
+      - typescript-cubic-spline@1.0.1
+      - typescript@5.2.2
+      - winston@3.11.0
+      - zod@3.23.8
+  status: success
+tree:
+  children:
+    child:
+      pipeline:
+        compute:
+          - embodied-carbon
+      defaults:
+        vCPUs: 4
+        memory: 32
+        ssd: 1
+        hdd: 1
+        gpu: 1
+        total-vcpus: 16
+      inputs:
+        - timestamp: 2023-08-06T00:00
+          duration: 3600
+        - timestamp: 2023-08-06T10:00
+          duration: 3600
+      outputs:
+        - timestamp: 2023-08-06T00:00
+          duration: 3600
+          vCPUs: 4
+          memory: 32
+          ssd: 1
+          hdd: 1
+          gpu: 1
+          total-vcpus: 16
+          usage-ratio: 1
+          embodied-carbon: 487.48858447488584
+        - timestamp: 2023-08-06T10:00
+          duration: 3600
+          vCPUs: 4
+          memory: 32
+          ssd: 1
+          hdd: 1
+          gpu: 1
+          total-vcpus: 16
+          usage-ratio: 1
+          embodied-carbon: 487.48858447488584

package/manifests/outputs/builtins/sci-embodied/success.yaml

@@ -3,32 +3,42 @@ description: successful path
 tags: null
 initialize:
   plugins:
+    csv-lookup:
+      path: builtin
+      method: CSVLookup
+      config:
+        filepath: >-
+          https://raw.githubusercontent.com/Green-Software-Foundation/if-data/main/cloud-metdata-azure-instances.csv
+        query:
+          instance-class: cloud/instance-type
+        output:
+          - cpu-cores-utilized
+          - vcpus-allocated
     sci-embodied:
       path: builtin
       method: SciEmbodied
 execution:
   command: >-
-    /Users/mariamkhalatova/.npm/_npx/1bf7c3c15bf47d04/node_modules/.bin/ts-node
-    /Users/mariamkhalatova/Projects/UK/if/src/index.ts -m
-    manifests/outputs/plugins/sci-embodied/success.yml -o
-    manifests/outputs/plugins/sci-embodied/success
+    /Users/manushak/.npm/_npx/1bf7c3c15bf47d04/node_modules/.bin/ts-node
+    /Users/manushak/Documents/Projects/Green-Software/if/src/if-run/index.ts -m
+    manifests/outputs/builtins/sci-embodied/success.yaml
   environment:
-    if-version: 0.4.0
+    if-version: 0.6.0
     os: macOS
-    os-version: "13.2"
-    node-version: 18.14.2
-    date-time: 2024-07-02T20:42:03.186Z (UTC)
+    os-version: 14.6.1
+    node-version: 18.20.4
+    date-time: 2024-10-04T09:08:28.940Z (UTC)
     dependencies:
-      - "@babel/core@7.22.10"
-      - "@babel/preset-typescript@7.23.3"
-      - "@commitlint/cli@18.6.0"
-      - "@commitlint/config-conventional@18.6.0"
-      - "@grnsft/if-core@0.0.10"
-      - "@jest/globals@29.7.0"
-      - "@types/jest@29.5.8"
-      - "@types/js-yaml@4.0.9"
-      - "@types/luxon@3.4.2"
-      - "@types/node@20.9.0"
+      - '@babel/core@7.22.10'
+      - '@babel/preset-typescript@7.23.3'
+      - '@commitlint/cli@18.6.0'
+      - '@commitlint/config-conventional@18.6.0'
+      - '@grnsft/if-core@0.0.25'
+      - '@jest/globals@29.7.0'
+      - '@types/jest@29.5.8'
+      - '@types/js-yaml@4.0.9'
+      - '@types/luxon@3.4.2'
+      - '@types/node@20.9.0'
       - axios-mock-adapter@1.22.0
       - axios@1.7.2
       - cross-env@7.0.3
@@ -48,13 +58,14 @@ execution:
       - typescript-cubic-spline@1.0.1
       - typescript@5.2.2
       - winston@3.11.0
-      - zod@3.22.4
+      - zod@3.23.8
   status: success
 tree:
   children:
     child:
       pipeline:
         compute:
+          - csv-lookup
           - sci-embodied
       defaults:
         device/emissions-embodied: 1533.12
@@ -65,12 +76,25 @@ tree:
       inputs:
         - timestamp: 2023-07-06T00:00
           duration: 3600
+          cloud/vendor: intel
+          cloud/instance-type: Standard_A1_v2
+          cpu/utilization: 10
       outputs:
         - timestamp: 2023-07-06T00:00
           duration: 3600
+          cloud/vendor: intel
+          cloud/instance-type: Standard_A1_v2
+          cpu/utilization: 10
           device/emissions-embodied: 1533.12
           time-reserved: 3600
           device/expected-lifespan: 94608000
           resources-reserved: 1
           resources-total: 8
-          carbon-embodied: 0.007292237442922374
+          vcpus-allocated: 1
+          vCPUs: 1
+          memory: 16
+          ssd: 0
+          hdd: 0
+          gpu: 0
+          usage-ratio: 1
+          embodied-carbon: 28.538812785388128

package/manifests/outputs/builtins/shell/failure-invalid-command.yaml

@@ -1,12 +1,12 @@
 name: shell
-description: falure with `global-config.command` being number instead od string
+description: falure with `config.command` being number instead od string
 tags: null
 initialize:
   plugins:
     shell:
       method: Shell
       path: builtin
-      global-config:
+      config:
         command: 1000
 execution:
   status: fail

package/manifests/outputs/builtins/shell/success.yaml

@@ -6,7 +6,7 @@ initialize:
     shell:
       path: builtin
       method: Shell
-      global-config:
+      config:
         command: python3 /usr/local/bin/sampler
 execution:
   command: >-

package/manifests/outputs/builtins/subtract/success.yaml

@@ -6,7 +6,7 @@ initialize:
     subtract:
       path: builtin
       method: Subtract
-      global-config:
+      config:
         input-parameters:
           - cpu/energy
           - network/energy

package/manifests/outputs/builtins/sum/failure-missing-input-param.yaml

@@ -1,12 +1,12 @@
 name: sum
-description: failure with `inputs[0]` misses one of `global-config.input-parameters`
+description: failure with `inputs[0]` misses one of `config.input-parameters`
 tags: null
 initialize:
   plugins:
     sum:
       method: Sum
       path: builtin
-      global-config:
+      config:
         input-parameters:
           - cpu/energy
           - network/energy

package/manifests/outputs/builtins/sum/failure-missing-output-param.yaml

@@ -1,12 +1,12 @@
 name: sum
-description: missing `output-parameter` in global-config
+description: missing `output-parameter` in config
 tags: null
 initialize:
   plugins:
     sum:
       method: Sum
       path: builtin
-      global-config:
+      config:
         input-parameters:
           - cpu/energy
           - network/energy

package/manifests/outputs/builtins/sum/success.yaml

@@ -6,7 +6,7 @@ initialize:
     sum:
       path: builtin
       method: Sum
-      global-config:
+      config:
         input-parameters:
           - cpu/energy
           - network/energy

package/manifests/outputs/builtins/time-converter/success.yaml

@@ -0,0 +1,73 @@
+name: time-converter demo
+description: successful path
+tags: null
+initialize:
+  plugins:
+    time-converter:
+      path: builtin
+      method: TimeConverter
+      config:
+        input-parameter: energy-per-year
+        original-time-unit: year
+        new-time-unit: duration
+        output-parameter: energy-per-duration
+execution:
+  command: >-
+    /Users/manushak/.npm/_npx/1bf7c3c15bf47d04/node_modules/.bin/ts-node
+    /Users/manushak/Documents/Projects/Green-Software/if/src/if-run/index.ts -m
+    manifests/examples/builtins/time-converter/success.yaml -o
+    manifests/outputs/builtins/time-converter/success.yaml
+  environment:
+    if-version: 0.6.0
+    os: macOS
+    os-version: 14.6.1
+    node-version: 18.20.4
+    date-time: 2024-09-12T06:14:08.350Z (UTC)
+    dependencies:
+      - '@babel/core@7.22.10'
+      - '@babel/preset-typescript@7.23.3'
+      - '@commitlint/cli@18.6.0'
+      - '@commitlint/config-conventional@18.6.0'
+      - '@grnsft/if-core@0.0.22'
+      - '@jest/globals@29.7.0'
+      - '@types/jest@29.5.8'
+      - '@types/js-yaml@4.0.9'
+      - '@types/luxon@3.4.2'
+      - '@types/node@20.9.0'
+      - axios-mock-adapter@1.22.0
+      - axios@1.7.2
+      - cross-env@7.0.3
+      - csv-parse@5.5.6
+      - csv-stringify@6.4.6
+      - fixpack@4.0.0
+      - gts@5.2.0
+      - husky@8.0.3
+      - jest@29.7.0
+      - js-yaml@4.1.0
+      - lint-staged@15.2.2
+      - luxon@3.4.4
+      - release-it@16.3.0
+      - rimraf@5.0.5
+      - ts-command-line-args@2.5.1
+      - ts-jest@29.1.1
+      - typescript-cubic-spline@1.0.1
+      - typescript@5.2.2
+      - winston@3.11.0
+      - zod@3.23.8
+  status: success
+tree:
+  children:
+    child:
+      pipeline:
+        compute:
+          - time-converter
+      defaults:
+        energy-per-year: 10000
+      inputs:
+        - timestamp: 2023-08-06T00:00
+          duration: 3600
+      outputs:
+        - timestamp: 2023-08-06T00:00
+          duration: 3600
+          energy-per-year: 10000
+          energy-per-duration: 1.140795

package/manifests/outputs/builtins/time-sync/failure-config-start-later-end.yaml

@@ -1,14 +1,14 @@
 name: time-sync
 description: >-
-  failure with `global-config.start-time` being later than
-  `global-config.end-time`
+  failure with `config.start-time` being later than
+  `config.end-time`
 tags: null
 initialize:
   plugins:
     time-sync:
       method: TimeSync
       path: builtin
-      global-config:
+      config:
         start-time: "2023-12-12T00:01:00.000Z"
         end-time: "2023-12-12T00:00:00.000Z"
         interval: 5

package/manifests/outputs/builtins/time-sync/failure-missing-config.yaml

@@ -0,0 +1,74 @@
+name: time-sync
+description: missing config
+tags: null
+initialize:
+  output:
+    - yaml
+  plugins:
+    time-sync:
+      method: TimeSync
+      path: builtin
+execution:
+  status: fail
+  command: >-
+    /Users/manushak/.npm/_npx/1bf7c3c15bf47d04/node_modules/.bin/ts-node
+    /Users/manushak/Documents/Projects/Green-Software/if/src/if-run/index.ts -m
+    manifests/examples/builtins/time-sync/failure-missing-config.yml -o
+    manifests/outputs/builtins/time-sync/failure-missing-config.yaml
+  environment:
+    if-version: 0.6.0
+    os: macOS
+    os-version: 14.6.1
+    node-version: 18.20.4
+    date-time: 2024-10-04T13:07:11.870Z (UTC)
+    dependencies:
+      - '@babel/core@7.22.10'
+      - '@babel/preset-typescript@7.23.3'
+      - '@commitlint/cli@18.6.0'
+      - '@commitlint/config-conventional@18.6.0'
+      - '@grnsft/if-core@0.0.25'
+      - '@jest/globals@29.7.0'
+      - '@types/jest@29.5.8'
+      - '@types/js-yaml@4.0.9'
+      - '@types/luxon@3.4.2'
+      - '@types/node@20.9.0'
+      - axios-mock-adapter@1.22.0
+      - axios@1.7.2
+      - cross-env@7.0.3
+      - csv-parse@5.5.6
+      - csv-stringify@6.4.6
+      - fixpack@4.0.0
+      - gts@5.2.0
+      - husky@8.0.3
+      - jest@29.7.0
+      - js-yaml@4.1.0
+      - lint-staged@15.2.2
+      - luxon@3.4.4
+      - release-it@16.3.0
+      - rimraf@5.0.5
+      - ts-command-line-args@2.5.1
+      - ts-jest@29.1.1
+      - typescript-cubic-spline@1.0.1
+      - typescript@5.2.2
+      - winston@3.11.0
+      - zod@3.23.8
+  error: 'ConfigError: Config is not provided.'
+tree:
+  children:
+    child:
+      pipeline:
+        compute:
+          - time-sync
+      inputs:
+        - timestamp: '2023-12-12T00:00:00.000Z'
+          duration: 3
+          energy-cpu: 0.001
+        - timestamp: '2023-12-12T00:00:01.000Z'
+          duration: 5
+          energy-cpu: 0.001
+        - timestamp: '2023-12-12T00:00:06.000Z'
+          duration: 7
+          energy-cpu: 0.001
+        - timestamp: '2023-12-12T00:00:13.000Z'
+          duration: 30
+          energy-cpu: 0.001