@grnsft/if 0.3.1 → 0.3.3-beta.0

package/{examples/manifests/pipeline-demo-2.yml → manifests/bugs/aggregation-error-wrong-metric.yml}

@@ -1,9 +1,9 @@
-name: pipeline-demo
-description:
+name: aggregation-error-wrong-metric
+description: a negative test case that fails due to the aggregation feature being passed an incorrect metric
 tags:
 aggregation:
   metrics:
-    - "carbon"
+    - "dummy-param"
   type: "both"
 initialize:
   plugins:
@@ -12,14 +12,9 @@ initialize:
       method: TeadsCurve
       global-config:
         interpolation: spline
-    "sum":
+    "sci-e":
       path: "@grnsft/if-plugins"
-      method: Sum
-      global-config:
-        input-parameters:
-          - cpu/energy
-          - network/energy
-        output-parameter: carbon-plus-energy'
+      method: SciE
     "sci-m":
       path: "@grnsft/if-plugins"
       method: SciM
@@ -48,7 +43,7 @@ tree:
     child-1:
       pipeline:
         - teads-curve
-        - sum
+        - sci-e
         - sci-m
         - sci-o
         - time-sync
@@ -56,7 +51,7 @@ tree:
       config:
         group-by:
           group:
-            - region
+            - cloud/region
             - cloud/instance-type
       defaults:
         cpu/thermal-design-power: 100
@@ -70,36 +65,28 @@ tree:
       inputs:
         - timestamp: "2023-12-12T00:00:00.000Z"
           cloud/instance-type: A1
-          region: uk-west
+          cloud/region: uk-west
           duration: 1
           cpu/utilization: 10
-          network/energy: 10
-          energy: 5
         - timestamp: "2023-12-12T00:00:01.000Z"
           duration: 5
           cpu/utilization: 20
           cloud/instance-type: A1
-          region: uk-west
-          network/energy: 10
-          energy: 5
+          cloud/region: uk-west
         - timestamp: "2023-12-12T00:00:06.000Z"
           duration: 7
           cpu/utilization: 15
           cloud/instance-type: A1
-          region: uk-west
-          network/energy: 10
-          energy: 5
+          cloud/region: uk-west
         - timestamp: "2023-12-12T00:00:13.000Z"
           duration: 30
           cloud/instance-type: A1
-          region: uk-west
+          cloud/region: uk-west
           cpu/utilization: 15
-          network/energy: 10
-          energy: 5
     child-2:
       pipeline:
         - teads-curve
-        - sum
+        - sci-e
         - sci-m
         - sci-o
         - time-sync
@@ -107,8 +94,8 @@ tree:
       config:
         group-by:
           group:
-            - region
-            - instance-type
+            - cloud/region
+            - cloud/instance-type
       defaults:
         cpu/thermal-design-power: 100
         grid/carbon-intensity: 800
@@ -123,27 +110,19 @@ tree:
           duration: 1
           cpu/utilization: 30
           cloud/instance-type: A1
-          region: uk-west
-          network/energy: 10
-          energy: 5
+          cloud/region: uk-west
         - timestamp: "2023-12-12T00:00:01.000Z"
           duration: 5
           cpu/utilization: 28
           cloud/instance-type: A1
-          region: uk-west
-          network/energy: 10
-          energy: 5
+          cloud/region: uk-west
         - timestamp: "2023-12-12T00:00:06.000Z"
           duration: 7
           cpu/utilization: 40
           cloud/instance-type: A1
-          region: uk-west
-          network/energy: 10
-          energy: 5
+          cloud/region: uk-west
         - timestamp: "2023-12-12T00:00:13.000Z"
           duration: 30
           cpu/utilization: 33
           cloud/instance-type: A1
-          region: uk-west
-          network/energy: 10
-          energy: 5
+          cloud/region: uk-west

package/manifests/bugs/azure-importer-ignoring-defaults.yml

@@ -0,0 +1,61 @@
+name: pipeline-demo
+description: https://github.com/Green-Software-Foundation/if-unofficial-plugins/issues/81
+tags:
+# aggregation:
+# metrics:
+# - "carbon"
+# - "energy"
+#type: "both"
+initialize:
+  outputs:
+    - yaml
+    # - csv
+  plugins:
+    "azure-importer":
+      method: AzureImporter
+      path: "@grnsft/if-unofficial-plugins"
+    "try-defaults-1":
+      path: "@grnsft/if-plugins"
+      method: Coefficient
+      global-config:
+        input-parameter: grid/carbon-intensity
+        coefficient: 0.1
+        output-parameter: grid/carbon-intensity
+    "try-defaults-2":
+      path: "@grnsft/if-plugins"
+      method: Coefficient
+      global-config:
+        input-parameter: network/energy
+        coefficient: 1000
+        output-parameter: network/energy
+    "sci-o":
+      method: SciO
+      path: "@grnsft/if-plugins"
+    "group-by":
+      path: "builtin"
+      method: GroupBy
+tree:
+  children:
+    web-front: # name this according to the sub-system, e.g. portal, APIs/backend, DB
+      pipeline:
+        - azure-importer
+        #- try-defaults-1
+        #- try-defaults-2
+        - sci-o
+      config:
+        group-by:
+          group:
+            - instance-type
+        azure-importer:
+          azure-observation-window: 60 min
+          azure-observation-aggregation: "average"
+          azure-subscription-id: 30b6e171-af2c-4fe6-b00d-d4c70f6291fe
+          azure-resource-group: gcf-app_group
+          azure-vm-name: gcf-app
+      defaults:
+        grid/carbon-intensity: 800 # adjust for SG grid
+        network/energy: 0.001 # review for naming accuracy
+      inputs:
+        - timestamp: "2024-04-04T08:00:00.001Z"
+          duration: 3600
+          energy: 100

package/manifests/bugs/azure-importer-incorrect-calculation.yml

@@ -0,0 +1,56 @@
+name: pipeline-demo
+description: https://github.com/Green-Software-Foundation/if-unofficial-plugins/issues/81
+tags: null
+initialize:
+  plugins:
+    azure-importer:
+      path: '@grnsft/if-unofficial-plugins'
+      method: AzureImporter
+    try-defaults-1:
+      path: '@grnsft/if-plugins'
+      method: Coefficient
+      global-config:
+        input-parameter: grid/carbon-intensity
+        coefficient: 0.1
+        output-parameter: grid/carbon-intensity
+    try-defaults-2:
+      path: '@grnsft/if-plugins'
+      method: Coefficient
+      global-config:
+        input-parameter: network/energy
+        coefficient: 1000
+        output-parameter: network/energy
+    sci-o:
+      path: '@grnsft/if-plugins'
+      method: SciO
+    group-by:
+      path: builtin
+      method: GroupBy
+  outputs:
+    - yaml
+if-version: v0.3.2
+tree:
+  children:
+    web-front:
+      pipeline:
+        - azure-importer
+        - try-defaults-1
+        - try-defaults-2
+      config:
+        group-by:
+          group:
+            - instance-type
+        azure-importer:
+          azure-observation-window: 60 min
+          azure-observation-aggregation: average
+          azure-subscription-id: 30b6e171-af2c-4fe6-b00d-d4c70f6291fe
+          azure-resource-group: gcf-app_group
+          azure-vm-name: gcf-app
+      defaults:
+        grid/carbon-intensity: 800
+        network/energy: 0.001
+      inputs:
+        - timestamp: '2024-04-04T08:00:00.001Z'
+          duration: 3600
+          energy: 100
+   

package/manifests/bugs/initialize-error-no-config.yml

@@ -0,0 +1,27 @@
+name: initialize-error-no-config
+description: a negative test case that fails due to plugin initialization missing some required config 
+tags:
+initialize:
+  plugins:
+    teads-curve: 
+      path: '@grnsft/if-unofficial-plugins'
+      method: TeadsCurve
+      global-config:
+  outputs: ['yaml']
+tree:
+  children:
+    child-0:
+      defaults:
+        cpu/thermal-design-power: 100
+      pipeline:
+        - teads-curve
+      inputs:
+        - timestamp: 2023-07-06T00:00
+          duration: 1
+          cpu/utilization: 20
+        - timestamp: 2023-07-06T00:01
+          duration: 1
+          cpu/utilization: 80
+        - timestamp: 2023-07-06T00:02
+          duration: 1
+          cpu/utilization: 20

package/manifests/bugs/initialize-error-no-path.yml

@@ -0,0 +1,28 @@
+name: initialize-error-no-path
+description: a negative test case that fails because the path is mising in a plugin initialization
+tags:
+initialize:
+  plugins:
+    teads-curve: 
+      path:
+      method: TeadsCurve
+      global-config:
+        interpolation: spline
+  outputs: ['yaml']
+tree:
+  children:
+    child-0:
+      defaults:
+        cpu/thermal-design-power: 100
+      pipeline:
+        - teads-curve
+      inputs:
+        - timestamp: 2023-07-06T00:00
+          duration: 1
+          cpu/utilization: 20
+        - timestamp: 2023-07-06T00:01
+          duration: 1
+          cpu/utilization: 80
+        - timestamp: 2023-07-06T00:02
+          duration: 1
+          cpu/utilization: 20

package/manifests/bugs/initialize-error-no-plugins.yml

@@ -0,0 +1,23 @@
+name: initialize-error-no-path
+description: a negative test case that fails becuase no plugins are included in the initialize block
+tags:
+initialize:
+  plugins:
+  outputs: ['yaml']
+tree:
+  children:
+    child-0:
+      defaults:
+        cpu/thermal-design-power: 100
+      pipeline:
+        - teads-curve
+      inputs:
+        - timestamp: 2023-07-06T00:00
+          duration: 1
+          cpu/utilization: 20
+        - timestamp: 2023-07-06T00:01
+          duration: 1
+          cpu/utilization: 80
+        - timestamp: 2023-07-06T00:02
+          duration: 1
+          cpu/utilization: 20

package/manifests/bugs/input-error-missing-duration.yml

@@ -0,0 +1,21 @@
+name: input-error-missing-duration
+description: a negative test case that fails due to the required `duration` field being omitted from input data
+tags:
+initialize:
+  plugins:
+    teads-curve: 
+      path: '@grnsft/if-unofficial-plugins'
+      method: TeadsCurve
+      global-config:
+        interpolation: spline
+  outputs: ['yaml']
+tree:
+  children:
+    child-0:
+      defaults:
+        cpu/thermal-design-power: 100
+      pipeline:
+        - teads-curve
+      inputs:
+        - timestamp: 2023-07-06T00:00
+          cpu/utilization: 20

package/manifests/bugs/pipeline-error-naming-mismatch.yml

@@ -0,0 +1,28 @@
+name: pipeline-error-naming-mismatch
+description: a negative test case that fails due to the plugin name in the pipeline not matching the name given in initialize 
+tags:
+initialize:
+  plugins:
+    teads-curve: 
+      path: '@grnsft/if-unofficial-plugins'
+      method: TeadsCurve
+      global-config:
+        interpolation: spline
+  outputs: ['yaml']
+tree:
+  children:
+    child-0:
+      defaults:
+        cpu/thermal-design-power: 100
+      pipeline:
+        - wrong-name
+      inputs:
+        - timestamp: 2023-07-06T00:00
+          duration: 1
+          cpu/utilization: 20
+        - timestamp: 2023-07-06T00:01
+          duration: 1
+          cpu/utilization: 80
+        - timestamp: 2023-07-06T00:02
+          duration: 1
+          cpu/utilization: 20

package/manifests/bugs/pipeline-error-uninitialized-plugin.yml

@@ -0,0 +1,29 @@
+name: pipeline-uninitialized-plugin-error
+description: a negative test case that fails due to an uninitialized plugin being invoked in a pipeline
+tags:
+initialize:
+  plugins:
+    teads-curve: 
+      path: '@grnsft/if-unofficial-plugins'
+      method: TeadsCurve
+      global-config:
+        interpolation: spline
+  outputs: ['yaml']
+tree:
+  children:
+    child-0:
+      defaults:
+        cpu/thermal-design-power: 100
+      pipeline:
+        - teads-curve
+        - multiply
+      inputs:
+        - timestamp: 2023-07-06T00:00
+          duration: 1
+          cpu/utilization: 20
+        - timestamp: 2023-07-06T00:01
+          duration: 1
+          cpu/utilization: 80
+        - timestamp: 2023-07-06T00:02
+          duration: 1
+          cpu/utilization: 20

package/{examples/manifests/pipeline-teads-sci.yml → manifests/bugs/pipeline-ordering-error.yml}

@@ -1,5 +1,5 @@
-name: pipeline-teads-sci
-description:
+name: pipeline-ordering-error
+description: a negative test case that fails because sci-o is invoked too early in the pipeline (before its inputs are generated)
 tags:
 initialize:
   plugins:
@@ -12,10 +12,10 @@ initialize:
       path: "@grnsft/if-plugins"
       method: Sum
       global-config:
-        input-parameters: 
+        input-parameters:
           - cpu/energy
           - network/energy
-        output-parameter: energy 
+        output-parameter: energy
     "sci-m":
       path: "@grnsft/if-plugins"
       method: SciM
@@ -26,8 +26,8 @@ initialize:
       path: "@grnsft/if-plugins"
       method: Sci
       global-config:
-        functional-unit: ''
-        functional-unit-time: '1-day'
+        functional-unit: ""
+        functional-unit-time: "1-day"
     "time-sync":
       method: TimeSync
       path: "builtin"
@@ -41,9 +41,9 @@ tree:
     child-1:
       pipeline:
         - teads-curve
+        - sci-o
         - sum
         - sci-m
-        - sci-o
         - time-sync
         - sci
       config:
@@ -57,26 +57,26 @@ tree:
         resources-total: 8
       inputs:
         - timestamp: "2023-12-12T00:00:00.000Z"
-          cloud/instance-type: A1 
-          region: uk-west
+          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 
-          region: uk-west
+          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 
-          region: uk-west
+          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 
-          region: uk-west
+          cloud/instance-type: A1
+          cloud/region: uk-west
           cpu/utilization: 15
           network/energy: 0.000001

package/{examples/manifests → manifests/examples}/basic.yml

@@ -1,5 +1,5 @@
-name: basic-demo
-description:
+name: basic
+description: a minimal manifest executing a single plugin on a single component for a single timestep
 tags:
 initialize:
   plugins:
@@ -8,6 +8,7 @@ initialize:
       method: TeadsCurve
       global-config:
         interpolation: spline
+  outputs: ['yaml']
 tree:
   children:
     child-0:

package/{examples/manifests → manifests/examples}/generics.yml

@@ -1,10 +1,10 @@
-name: generic-arithmetic-demo
-description:
+name: generics
+description: a pipeline that does arbitrary calculations using our generic arithmetic builtins
 tags:
 initialize:
   plugins:
     teads-curve:
-      path: '@grnsft/if-unofficial-plugins'
+      path: "@grnsft/if-unofficial-plugins"
       method: TeadsCurve
       global-config:
         interpolation: spline
@@ -12,10 +12,10 @@ initialize:
       path: "@grnsft/if-plugins"
       method: Sum
       global-config:
-        input-parameters: 
+        input-parameters:
           - cpu/energy
           - network/energy
-        output-parameter: energy-sum 
+        output-parameter: energy-sum
     "coefficient":
       path: "@grnsft/if-plugins"
       method: Coefficient
@@ -24,11 +24,11 @@ initialize:
         coefficient: 2
         output-parameter: energy-doubled
     "multiply":
-      path: '@grnsft/if-plugins'
+      path: "@grnsft/if-plugins"
       method: Multiply
       global-config:
-        input-parameters: ['cpu/utilization', 'duration']
-        output-parameter: 'cpu-times-duration'
+        input-parameters: ["cpu/utilization", "duration"]
+        output-parameter: "cpu-times-duration"
 tree:
   children:
     child-1:
@@ -42,8 +42,8 @@ tree:
         cpu/thermal-design-power: 100
       inputs:
         - timestamp: "2023-12-12T00:00:00.000Z"
-          cloud/instance-type: A1 
-          region: uk-west
+          cloud/instance-type: A1
+          cloud/region: uk-west
           duration: 1
           cpu/utilization: 50
           network/energy: 10
@@ -51,21 +51,21 @@ tree:
         - timestamp: "2023-12-12T00:00:01.000Z"
           duration: 5
           cpu/utilization: 20
-          cloud/instance-type: A1 
-          region: uk-west
+          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 
-          region: uk-west
+          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 
-          region: uk-west
+          cloud/instance-type: A1
+          cloud/region: uk-west
           cpu/utilization: 15
           network/energy: 10
           energy: 5

package/{examples/manifests/asim-demo.yml → manifests/examples/mock-cpu-util-to-carbon.yml}

@@ -1,11 +1,7 @@
-name: My Manifest File
-description: My First Manifest File 💚
-# aggregation:
-#   metrics:
-#     - 'carbon'
-#   type: 'both'
+name: mock-cpu-util-to-carbon
+description: a complete pipeline that starts with mocked CPU utilization data and outputs operational carbon in gCO2eq
 initialize:
-  outputs: ['yaml', 'csv']
+  outputs: ['yaml']
   plugins: 
     group-by: 
       path: 'builtin'