Merge pull request #597 from Green-Software-Foundation/main

Release v0.3.2

CONTRIBUTING.md

@@ -1,12 +1,15 @@
 ## Contribution Guidelines <!-- omit from toc -->
 
+> **HACKATHON PARTICIPANTS**: please note that these contribution guidelines are intended for community contributions to IF, and NOT hackathon submissions. If you are building plugins, tooling or other add-ons to IF, please maintain them in your own repositories and submit links to the hackathon judges.**
+
 
 First off, thanks for taking the time to contribute! 🎉
 
 The following document is a rule set of guidelines for contributing.
 
 ## Table of Contents <!-- omit from toc -->
 
+- [What and when to contribute](#what-and-when-to-contribute)
 - [Code Contributions](#code-contributions)
   - [Step 1: Fork](#step-1-fork)
   - [Step 2: Branch](#step-2-branch)
@@ -20,6 +23,11 @@ The following document is a rule set of guidelines for contributing.
     - [Documentation](#documentation)
   - [Writing tests](#writing-tests)
 
+## What and when to contribute
+
+You can contribute anything to the IF, but we are likely to close out unsolicited PRs without merging them. Our issue board is completely open and we have tags (`help-wanted`, `good-first-issue`) to help contributors to choose tasks to work on. We recommend speaking to the core team on Github before starting working on an issue. You can do this by raising an issue or commenting on an existing issue. This helps us to direct your energy is directions that are aligned with our roadmap, prevent multiple people working on the same task, and better manage our board. This all makes it much more likely that your work will get merged.
+
+
 ## Code Contributions
 
 ### Step 1: Fork

README.md

@@ -15,9 +15,12 @@
 > Find out more about CarbonHack 2024 on the [CarbonHack website](https://grnsft.org/hack/github). Check out the [FAQ on GitHub](https://grnsft.org/hack/faq).
 > 
 > Registration opens 15th January!
+>
+> **PLEASE NOTE** hackathon projects are not supposed to be raised as pull requests to this rpeository! Please keep your hackathon plugins in your own repositories and submit links instead of raising PRs!
 ----------------------------
 
 
+
 # Impact Framework
 
 

examples/manifests/boavizta-pipeline.yml

@@ -5,18 +5,18 @@ initialize:
   plugins:
     boavizta-cpu:
       method: BoaviztaCpuOutput
-      path: '@grnsft/if-unofficial-plugins'
+      path: "@grnsft/if-unofficial-plugins"
       global-config:
         allocation: LINEAR
         verbose: true
     "sum":
       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
@@ -27,8 +27,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"
@@ -60,26 +60,26 @@ tree:
         cpu/name: Intel® Core™ i7-1185G7
       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

examples/manifests/cloud-metadata-teads.yml

@@ -0,0 +1,41 @@
+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

examples/manifests/cloud-metadata.yml

@@ -1,41 +1,20 @@
-name: coud-instanmce-metadata-demo
-description: null
-tags: null
+name: cloud-metadata
+description: example impl invoking Cloud Metadata plugin
+tags:
 initialize:
   plugins:
-    teads-curve:
-      path: '@grnsft/if-unofficial-plugins'
-      method: TeadsCurve
-      global-config:
-        interpolation: spline
-    cloud-instance-metadata:
-      method: CloudInstanceMetadata
+    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
+    child:
       pipeline:
-        - teads-curve
-        - cloud-instance-metadata
+        - cloud-metadata
+      config:
       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
+        - timestamp: 2023-07-06T00:00 # [KEYWORD] [NO-SUBFIELDS] time when measurement occurred
+          cloud/vendor: aws
+          cloud/instance-type: m5n.large
+          duration: 100
+          cpu/utilization: 10

examples/manifests/e-net.yml

@@ -1,4 +1,4 @@
-name: sci-e-demo
+name: e-net-demo
 description:
 tags:
 initialize:

examples/manifests/generics.yml

@@ -4,18 +4,18 @@ tags:
 initialize:
   plugins:
     teads-curve:
-      path: '@grnsft/if-unofficial-plugins'
+      path: "@grnsft/if-unofficial-plugins"
       method: TeadsCurve
       global-config:
         interpolation: spline
     "sum":
       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,30 +42,30 @@ 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
           energy: 5
         - 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

examples/manifests/group-by.yml

@@ -2,47 +2,47 @@ name: groupby-demo
 description: demo pipeline
 initialize:
   plugins:
-    group-by: 
-      path: 'builtin'
+    group-by:
+      path: "builtin"
       method: GroupBy
 tree:
   children:
     my-app:
-      pipeline:     
+      pipeline:
         - group-by
       config:
         group-by:
           group:
-            - region
+            - cloud/region
             - cloud/instance-type
       inputs:
         - timestamp: 2023-07-06T00:00
-          duration: 300 
-          cloud/instance-type: A1 
-          region: uk-west
+          duration: 300
+          cloud/instance-type: A1
+          cloud/region: uk-west
           cpu/utilization: 99
-        - timestamp: 2023-07-06T05:00 
-          duration: 300 
-          cloud/instance-type: A1 
-          region: uk-west
-          cpu/utilization: 23	  
+        - 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 
-          region: uk-west
+          cloud/instance-type: A1
+          cloud/region: uk-west
           cpu/utilization: 12
         - timestamp: 2023-07-06T00:00 # note this time restarts at the start timstamp
-          duration: 300 
+          duration: 300
           cloud/instance-type: B1
-          region: uk-west
+          cloud/region: uk-west
           cpu/utilization: 11
-        - timestamp: 2023-07-06T05:00 
-          duration: 300 
+        - timestamp: 2023-07-06T05:00
+          duration: 300
           cloud/instance-type: B1
-          region: uk-west
+          cloud/region: uk-west
           cpu/utilization: 67
         - timestamp: 2023-07-06T10:00
-          duration: 300 
+          duration: 300
           cloud/instance-type: B1
-          region: uk-west
+          cloud/region: uk-west
           cpu/utilization: 1