@grnsft/if 0.7.2 → 1.0.0

package/manifests/examples/builtins/csv-import/success.yaml

@@ -0,0 +1,22 @@
+name: csv-import
+description: successful path
+tags:
+initialize:
+  plugins:
+    data-import:
+      method: CSVImport
+      path: 'builtin'
+      config:
+        filepath: manifests/examples/builtins/csv-import/test.csv
+        # filepath: https://raw.githubusercontent.com/Green-Software-Foundation/if-data/main/cloud-metdata-aws-instances.csv
+        output: '*'
+tree:
+  children:
+    child:
+      pipeline:
+        compute:
+          - data-import
+      inputs:
+        - timestamp: 2023-07-06T00:00
+          duration: 300
+          physical-processor: AMD 3020e

package/manifests/examples/builtins/csv-import/test.csv

@@ -0,0 +1,4 @@
+timestamp,duration,cpu-util,energy
+2023-07-06T00:00,1,20,5
+2023-07-06T00:01,1,30,10
+2023-07-06T00:02,1,40,15

package/manifests/outputs/builtins/csv-import/success.yaml

@@ -0,0 +1,84 @@
+name: csv-import
+description: successful path
+tags: null
+initialize:
+  plugins:
+    data-import:
+      path: builtin
+      method: CSVImport
+      config:
+        filepath: manifests/examples/builtins/csv-import/test.csv
+        output: '*'
+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/csv-import/success.yaml -o
+    manifests/outputs/builtins/csv-import/success
+  environment:
+    if-version: 0.7.2
+    os: macOS
+    os-version: 14.6.1
+    node-version: 18.20.4
+    date-time: 2024-12-06T06:45:15.935Z (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.28'
+      - >-
+        @grnsft/if-eco-ci-plugin@0.0.1 extraneous ->
+        file:../../../if-eco-ci-plugin
+      - '@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.7
+      - 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.10
+      - 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:
+          - data-import
+      inputs:
+        - timestamp: 2023-07-06T00:00
+          duration: 300
+          physical-processor: AMD 3020e
+      outputs:
+        - timestamp: 2023-07-06T00:00
+          duration: 300
+          physical-processor: AMD 3020e
+        - timestamp: 2023-07-06T00:00
+          duration: 1
+          cpu-util: 20
+          energy: 5
+        - timestamp: 2023-07-06T00:01
+          duration: 1
+          cpu-util: 30
+          energy: 10
+        - timestamp: 2023-07-06T00:02
+          duration: 1
+          cpu-util: 40
+          energy: 15

package/manifests/regroup.yml

@@ -0,0 +1,49 @@
+# start
+name: regroup
+description: successful path
+initialize:
+  plugins: {}
+tree:
+  children:
+    my-app:
+      pipeline:
+        regroup:
+          - cloud/region
+          - cloud/instance-type
+      children:
+        uk-west:
+          children:
+            A1:
+              inputs:
+                - timestamp: 2023-07-06T00:00
+                  duration: 300
+                  cloud/instance-type: A1
+                  cloud/region: uk-west
+                  cpu/utilization: 99
+                - timestamp: 2023-07-06T05:00
+                  duration: 300
+                  cloud/instance-type: A1
+                  cloud/region: uk-west
+                  cpu/utilization: 23
+                - timestamp: 2023-07-06T10:00
+                  duration: 300
+                  cloud/instance-type: A1
+                  cloud/region: uk-west
+                  cpu/utilization: 12
+            B1:
+              inputs:
+                - timestamp: 2023-07-06T00:00
+                  duration: 300
+                  cloud/instance-type: B1
+                  cloud/region: uk-west
+                  cpu/utilization: 11
+                - timestamp: 2023-07-06T05:00
+                  duration: 300
+                  cloud/instance-type: B1
+                  cloud/region: uk-west
+                  cpu/utilization: 67
+                - timestamp: 2023-07-06T10:00
+                  duration: 300
+                  cloud/instance-type: B1
+                  cloud/region: uk-west
+                  cpu/utilization: 1

package/manifests/test.yml

@@ -0,0 +1,524 @@
+name: nesting
+description: a manifest that includes nested child components
+tags:
+  kind: web
+  complexity: moderate
+  category: on-premise
+aggregation:
+  metrics:
+    - carbon
+  type: "both"
+initialize:
+  plugins:
+    "interpolate":
+      method: Interpolation
+      path: "builtin"
+      config:
+        method: linear
+        x: [0, 10, 50, 100]
+        y: [0.12, 0.32, 0.75, 1.02]
+        input-parameter: "cpu/utilization"
+        output-parameter: "cpu-factor"
+      parameter-metadata:
+        inputs:
+          cpu/utilization:
+            unit: percentage
+            description: refers to CPU utilization.
+            aggregation-method:
+              time: avg
+              component: sum
+        outputs:
+          cpu-factor:
+            unit: kWh
+            description: result of interpolate
+            aggregation-method:
+              time: avg
+              component: avg
+    "cpu-factor-to-wattage":
+      method: Multiply
+      path: builtin
+      config:
+        input-parameters: ["cpu-factor", "cpu/thermal-design-power"]
+        output-parameter: "cpu-wattage"
+      parameter-metadata:
+        inputs:
+          cpu-factor:
+            unit: kWh
+            description: result of interpolate
+            aggregation-method:
+              time: avg
+              component: avg
+          cpu/thermal-design-power:
+            unit: kWh
+            description: thermal design power for a processor
+            aggregation-method:
+              time: avg
+              component: avg
+        outputs:
+          cpu-wattage:
+            unit: kWh
+            description: the energy used by the CPU
+            aggregation-method:
+              time: sum
+              component: sum
+    "wattage-times-duration":
+      method: Multiply
+      path: builtin
+      config:
+        input-parameters: ["cpu-wattage", "duration"]
+        output-parameter: "cpu-wattage-times-duration"
+    "wattage-to-energy-kwh":
+      method: Divide
+      path: "builtin"
+      config:
+        numerator: cpu-wattage-times-duration
+        denominator: 3600000
+        output: cpu-energy-raw
+      parameter-metadata:
+        inputs:
+          cpu-wattage-times-duration:
+            unit: kWh
+            description: CPU wattage multiplied by duration
+            aggregation-method:
+              time: sum
+              component: sum
+        outputs:
+          cpu-energy-raw:
+            unit: kWh
+            description: Raw energy used by CPU in kWh
+            aggregation-method:
+              time: sum
+              component: sum
+    "calculate-vcpu-ratio":
+      method: Divide
+      path: "builtin"
+      config:
+        numerator: vcpus-total
+        denominator: vcpus-allocated
+        output: vcpu-ratio
+      parameter-metadata:
+        outputs:
+          vcpu-ratio:
+            unit: none
+            description: Ratio of vCPUs
+            aggregation-method:
+              time: copy
+              component: copy
+    "correct-cpu-energy-for-vcpu-ratio":
+      method: Divide
+      path: "builtin"
+      config:
+        numerator: cpu-energy-raw
+        denominator: vcpu-ratio
+        output: cpu-energy-kwh
+    sci-embodied:
+      path: "builtin"
+      method: SciEmbodied
+    "operational-carbon":
+      method: Multiply
+      path: builtin
+      config:
+        input-parameters: ["cpu-energy-kwh", "grid/carbon-intensity"]
+        output-parameter: "carbon-operational"
+      parameter-metadata:
+        inputs:
+          cpu-energy-kwh:
+            unit: kWh
+            description: Corrected CPU energy in kWh
+            aggregation-method:
+              time: sum
+              component: sum
+          grid/carbon-intensity:
+            unit: gCO2eq/kWh
+            description: Carbon intensity for the grid
+            aggregation-method:
+              time: avg
+              component: avg
+        outputs:
+          carbon-operational:
+            unit: gCO2eq
+            description: Operational carbon footprint
+            aggregation-method:
+              time: sum
+              component: sum
+    sci:
+      path: "builtin"
+      method: Sci
+      config:
+        functional-unit: "requests"
+      parameter-metadata:
+        inputs:
+          requests:
+            unit: none
+            description: expressed the final SCI value
+            aggregation-method:
+              time: sum
+              component: sum
+    "sum-carbon":
+      path: "builtin"
+      method: Sum
+      config:
+        input-parameters:
+          - carbon-operational
+          - embodied-carbon
+        output-parameter: carbon
+      parameter-metadata:
+        inputs:
+          carbon-operational:
+            description: Operational carbon footprint
+            unit: gCO2eq
+            aggregation-method:
+              time: sum
+              component: sum
+          embodied-carbon:
+            description: Embodied carbon footprint
+            unit: gCO2eq
+            aggregation-method:
+              time: sum
+              component: sum
+        outputs:
+          carbon:
+            description: Total carbon footprint
+            unit: gCO2eq
+            aggregation-method:
+              time: sum
+              component: sum
+    time-sync:
+      method: TimeSync
+      path: "builtin"
+      config:
+        start-time: '2023-01-01T00:00:00.000Z'
+        end-time: '2024-01-01T00:00:00.000Z'
+        interval: 100000000
+        allow-padding: true
+      parameter-metadata:
+        inputs:
+          timestamp:
+            unit: RFC3339
+            description: refers to the time of occurrence of the input
+            aggregation-method:
+              time: none
+              component: none
+          duration:
+            unit: seconds
+            description: refers to the duration of the input
+            aggregation-method:
+              time: sum
+              component: sum
+          cloud/instance-type:
+            unit: none
+            description: type of Cloud Instance name used in the cloud provider APIs
+            aggregation-method:
+              time: copy
+              component: copy
+          cloud/region:
+            unit: none
+            description: region cloud instance
+            aggregation-method:
+              time: copy
+              component: copy
+          time-reserved:
+            unit: seconds
+            description: time reserved for a component
+            aggregation-method:
+              time: avg
+              component: avg
+          network/energy:
+            description: "Energy consumed by the Network of the component"
+            unit: "kWh"
+            aggregation-method:
+              time: sum
+              component: sum
+
+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
+        vcpus-allocated: 1
+        vcpus-total: 8
+      pipeline:
+        compute:
+          - interpolate
+          - cpu-factor-to-wattage
+          - wattage-times-duration
+          - wattage-to-energy-kwh
+          - calculate-vcpu-ratio
+          - correct-cpu-energy-for-vcpu-ratio
+          - sci-embodied
+          - operational-carbon
+          - sum-carbon
+          - time-sync
+          - sci
+      inputs:
+        - timestamp: "2023-01-01T00:00:00.000Z"
+          cloud/instance-type: A1
+          cloud/region: uk-west
+          duration: 2629800
+          cpu/utilization: 50
+          network/energy: 0.000001
+          requests: 50
+        - timestamp: "2023-02-01T00:00:00.000Z"
+          duration: 2419200
+          cpu/utilization: 20
+          cloud/instance-type: A1
+          cloud/region: uk-west
+          network/energy: 0.000001
+          requests: 60
+        - timestamp: "2023-03-01T00:00:00.000Z"
+          duration: 2629800
+          cpu/utilization: 15
+          cloud/instance-type: A1
+          cloud/region: uk-west
+          network/energy: 0.000001
+          requests: 70
+        - timestamp: "2023-04-01T00:00:00.000Z"
+          duration: 2592000
+          cloud/instance-type: A1
+          cloud/region: uk-west
+          cpu/utilization: 15
+          network/energy: 0.000001
+          requests: 55
+        - timestamp: "2023-05-01T00:00:00.000Z"
+          duration: 2629800
+          cloud/instance-type: A1
+          cloud/region: uk-west
+          cpu/utilization: 15
+          network/energy: 0.000001
+          requests: 55
+        - timestamp: "2023-06-01T00:00:00.000Z"
+          duration: 2592000
+          cloud/instance-type: A1
+          cloud/region: uk-west
+          cpu/utilization: 15
+          network/energy: 0.000001
+          requests: 55
+        - timestamp: "2023-07-01T00:00:00.000Z"
+          duration: 2629800
+          cloud/instance-type: A1
+          cloud/region: uk-west
+          cpu/utilization: 15
+          network/energy: 0.000001
+          requests: 55
+    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
+        vcpus-allocated: 1
+        vcpus-total: 8
+      pipeline:
+        compute:
+          - interpolate
+          - cpu-factor-to-wattage
+          - wattage-times-duration
+          - wattage-to-energy-kwh
+          - calculate-vcpu-ratio
+          - correct-cpu-energy-for-vcpu-ratio
+          - sci-embodied
+          - operational-carbon
+          - sum-carbon
+          - time-sync
+          - sci
+      inputs:
+        - timestamp: "2023-01-01T00:00:00.000Z"
+          cloud/instance-type: A1
+          cloud/region: uk-west
+          duration: 2629800
+          cpu/utilization: 50
+          network/energy: 0.000001
+          requests: 50
+        - timestamp: "2023-02-01T00:00:00.000Z"
+          duration: 2419200
+          cpu/utilization: 20
+          cloud/instance-type: A1
+          cloud/region: uk-west
+          network/energy: 0.000001
+          requests: 60
+        - timestamp: "2023-03-01T00:00:00.000Z"
+          duration: 2629800
+          cpu/utilization: 15
+          cloud/instance-type: A1
+          cloud/region: uk-west
+          network/energy: 0.000001
+          requests: 70
+        - timestamp: "2023-04-01T00:00:00.000Z"
+          duration: 2592000
+          cloud/instance-type: A1
+          cloud/region: uk-west
+          cpu/utilization: 15
+          network/energy: 0.000001
+          requests: 55
+        - timestamp: "2023-05-01T00:00:00.000Z"
+          duration: 2629800
+          cloud/instance-type: A1
+          cloud/region: uk-west
+          cpu/utilization: 15
+          network/energy: 0.000001
+          requests: 55
+        - timestamp: "2023-06-01T00:00:00.000Z"
+          duration: 2592000
+          cloud/instance-type: A1
+          cloud/region: uk-west
+          cpu/utilization: 15
+          network/energy: 0.000001
+          requests: 55
+        - timestamp: "2023-07-01T00:00:00.000Z"
+          duration: 2629800
+          cloud/instance-type: A1
+          cloud/region: uk-west
+          cpu/utilization: 15
+          network/energy: 0.000001
+          requests: 55
+    child-2:
+      children:
+        child-2-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
+            vcpus-allocated: 1
+            vcpus-total: 8
+          pipeline:
+            compute:
+              - interpolate
+              - cpu-factor-to-wattage
+              - wattage-times-duration
+              - wattage-to-energy-kwh
+              - calculate-vcpu-ratio
+              - correct-cpu-energy-for-vcpu-ratio
+              - sci-embodied
+              - operational-carbon
+              - sum-carbon
+              - time-sync
+              - sci
+          inputs:
+            - timestamp: "2023-01-01T00:00:00.000Z"
+              cloud/instance-type: A1
+              cloud/region: uk-west
+              duration: 2629800
+              cpu/utilization: 50
+              network/energy: 0.000001
+              requests: 50
+            - timestamp: "2023-02-01T00:00:00.000Z"
+              duration: 2629800
+              cpu/utilization: 20
+              cloud/instance-type: A1
+              cloud/region: uk-west
+              network/energy: 0.000001
+              requests: 60
+            - timestamp: "2023-03-01T00:00:00.000Z"
+              duration: 2629800
+              cpu/utilization: 15
+              cloud/instance-type: A1
+              cloud/region: uk-west
+              network/energy: 0.000001
+              requests: 70
+            - timestamp: "2023-04-01T00:00:00.000Z"
+              duration: 2629800
+              cloud/instance-type: A1
+              cloud/region: uk-west
+              cpu/utilization: 15
+              network/energy: 0.000001
+              requests: 55
+            - timestamp: "2023-05-01T00:00:00.000Z"
+              duration: 2629800
+              cloud/instance-type: A1
+              cloud/region: uk-west
+              cpu/utilization: 15
+              network/energy: 0.000001
+              requests: 55
+            - timestamp: "2023-06-01T00:00:00.000Z"
+              duration: 2629800
+              cloud/instance-type: A1
+              cloud/region: uk-west
+              cpu/utilization: 15
+              network/energy: 0.000001
+              requests: 55
+            - timestamp: "2023-07-01T00:00:00.000Z"
+              duration: 2629800
+              cloud/instance-type: A1
+              cloud/region: uk-west
+              cpu/utilization: 15
+              network/energy: 0.000001
+              requests: 55
+        child-2-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
+            vcpus-allocated: 1
+            vcpus-total: 8
+          pipeline:
+            compute:
+              - interpolate
+              - cpu-factor-to-wattage
+              - wattage-times-duration
+              - wattage-to-energy-kwh
+              - calculate-vcpu-ratio
+              - correct-cpu-energy-for-vcpu-ratio
+              - sci-embodied
+              - operational-carbon
+              - sum-carbon
+              - time-sync
+              - sci
+          inputs:
+            - timestamp: "2023-01-01T00:00:00.000Z"
+              cloud/instance-type: A1
+              cloud/region: uk-west
+              duration: 2629800
+              cpu/utilization: 50
+              network/energy: 0.000001
+              requests: 50
+            - timestamp: "2023-02-01T00:00:00.000Z"
+              duration: 2629800
+              cpu/utilization: 20
+              cloud/instance-type: A1
+              cloud/region: uk-west
+              network/energy: 0.000001
+              requests: 60
+            - timestamp: "2023-03-01T00:00:00.000Z"
+              duration: 2629800
+              cpu/utilization: 15
+              cloud/instance-type: A1
+              cloud/region: uk-west
+              network/energy: 0.000001
+              requests: 70
+            - timestamp: "2023-04-01T00:00:00.000Z"
+              duration: 2629800
+              cloud/instance-type: A1
+              cloud/region: uk-west
+              cpu/utilization: 15
+              network/energy: 0.000001
+              requests: 55
+            - timestamp: "2023-05-01T00:00:00.000Z"
+              duration: 2629800
+              cloud/instance-type: A1
+              cloud/region: uk-west
+              cpu/utilization: 15
+              network/energy: 0.000001
+              requests: 55
+            - timestamp: "2023-06-01T00:00:00.000Z"
+              duration: 2629800
+              cloud/instance-type: A1
+              cloud/region: uk-west
+              cpu/utilization: 15
+              network/energy: 0.000001
+              requests: 55
+            - timestamp: "2023-07-01T00:00:00.000Z"
+              duration: 2629800
+              cloud/instance-type: A1
+              cloud/region: uk-west
+              cpu/utilization: 15
+              network/energy: 0.000001
+              requests: 55

package/okrs.md

@@ -0,0 +1,14 @@
+
+# Impact Framework OKRs
+
+The OKRs guiding Impact Framework to the end of 2025 are:
+
+- Objective: grow an open source community of developers and users
+  - Key result: 30 individual contributors to our repositories by end 2025
+  
+- Objective 2: get IF integrated into more production systems in real businesses and organizations
+  - Key result: 20 case studies added to our `if-db` repository
+   
+Individual contributors include people pushing code to IF, sharing plugins on [the Explorer](https://explorer.if.greensoftware.foundation), adding case studies or working on our documentation.
+
+Case studies take the form of manifest files with explanatory notes that show IF being used to measure some real software application.