Merge branch 'dev' into rimpl-spec

Signed-off-by: Narek Hovhannisyan <[email protected]>

.eslintrc.json

@@ -1,3 +1,8 @@
 {
-  "extends": "./node_modules/gts/"
+  "extends": "./node_modules/gts/",
+  "rules": {
+    "@typescript-eslint/no-explicit-any": [
+      "off"
+    ]
+  }
 }

.github/ISSUE_TEMPLATE/agenda.md

@@ -1,17 +1,17 @@
 ---
 name: Agenda
 about: The standard agenda template for carbon ql
-title: "GSF Carbon QL Meeting Agenda yyyy-mm-dd"
+title: "GSF IEF Meeting Agenda yyyy-mm-dd"
 labels: agenda
 assignees: ''
 
 ---
 
-Time 12:00pm (GMT) - See the time in your [timezone](link)
+Time 11:30am (GMT) / 4:00pm (IST) - See the time in your [timezone](https://everytimezone.com/s/e7e219dd)
 
 - Lead – @srini1978 (Microsoft)
 - Co-Lead @navveenb (Accenture)
-- PM – @Oleg-Zhymolokhov  (GSF)
+- PM – @jawache (GSF)
 
 ## Antitrust Policy
 Joint Development Foundation meetings may involve participation by industry competitors, and it is the intention of the Joint Development Foundation to conduct all of its activities in accordance with applicable antitrust and competition laws. It is therefore extremely important that attendees adhere to meeting agendas, and be aware of, and not participate in, any activities that are prohibited under applicable US state, federal or foreign antitrust and competition laws.
@@ -23,10 +23,14 @@ Please add 'Attended' to this issue during the meeting to denote attendance.
 Any untracked attendees will be added by the GSF team below:
 
 ## Agenda
-- [ ] 
-- [ ] AOB
+- [ ] Press Record!
 
-## Decisions 
+### PRs
+- [ ] 
 
+### Discussions
+- [ ] 
 
-## Actions
+### Issues
+- [ ] Discuss in-progress/blocked issues on project board: https://github.com/orgs/Green-Software-Foundation/projects/26/views/1
+- [ ] AOB

.github/ISSUE_TEMPLATE/model-plugin.md

@@ -0,0 +1,63 @@
+---
+name: Model Plugin
+about: Submiting a request to create a model plugin
+title: "Model Plugin - "
+labels: model
+assignees: ''
+---
+
+- **What**: 
+- **Why**: 
+- **DoD**:
+- [ ] Does the model meet the specification?
+- [ ] Does the model have complete test coverage, including edge cases, happy path and error cases?
+- [ ] Is the code documented?
+
+## Config
+- `variable`: If this variable is present in the top level config what behaviour does it trigger? What is the default value if none is provided?
+
+## Observation
+_List the variables this model expects in an input observation_
+- `variable`: Description
+
+## Impacts
+_List the variables this model exports out as an impact_
+- `variable`: Description
+
+## Behavior
+What does the model do to turn the observations into impacts? List any important equations or references.
+
+## Assumptions
+What are the core assumptions this model makes?
+
+## Limitations
+In what situations is this model limited in it's function, behaviour, accuracy etc...
+
+## Example
+Provide at least one example of some input config and observations. This is in pimpl format not rimpl format, so the config is the global config and all parameters must be present on the observation.
+
+### Input
+
+```yaml
+config:
+ key: value
+observations: 
+  - timestamp: 2023-07-06T00:00
+    duration: 3600
+```
+
+### Output
+
+```yaml
+config:
+ key: value
+observations: 
+  - timestamp: 2023-07-06T00:00
+    duration: 3600
+    yyyy: zzzz
+impacts: 
+  - timestamp: 2023-07-06T00:00
+    duration: 3600
+    yyyy: zzzz
+    aaaa: bbbb
+```

.github/ISSUE_TEMPLATE/user-story.md

@@ -1,6 +1,6 @@
 ---
 name: User story
-about: This describes a user story for the carbon ql
+about: This describes a user story for IEF
 title: "[User story] ...."
 labels: user-story
 assignees: ''

.github/workflows/nodejs-ci.yml

@@ -16,10 +16,17 @@ jobs:
           node-version: 18
           cache: 'yarn'
 
+      - name: 'setup python'
+        uses: actions/setup-python@v4
+        with:
+          python-version: '3.11'
 
       - name: Install dependencies
         run: yarn install
 
+      - name: Copy Sample CLI Mocker to bin folder
+        run: pip3 install pyyaml && cp src/lib/shell-imp/sampler /usr/local/bin/sampler && chmod +x /usr/local/bin/sampler
+
       - name: Run lint
         run: yarn lint
 

.gitignore

@@ -1,4 +1,3 @@
-
 src/**/*.js
 src/**/*.d.ts
 lib/**/*.js
@@ -11,3 +10,4 @@ tsconfig.json
 .jsii
 yarn-error.log
 build
+examples/ompls

Makefile

@@ -11,3 +11,6 @@ ccf-data:
 	cat third-party/ccf-coefficients/data/azure-instances.csv | python -c 'import csv, json, sys; print(json.dumps([dict(r) for r in csv.DictReader(sys.stdin)]))' > lib/ccf/azure-instances.json
 	cat third-party/ccf-coefficients/output/coefficients-azure-use.csv | python -c 'import csv, json, sys; print(json.dumps([dict(r) for r in csv.DictReader(sys.stdin)]))' > lib/ccf/azure-use.json
 	cat third-party/ccf-coefficients/output/coefficients-azure-embodied.csv | python -c 'import csv, json, sys; print(json.dumps([dict(r) for r in csv.DictReader(sys.stdin)]))' > lib/ccf/azure-embodied.json
+
+install-shell-imp:
+  cp src/lib/shell-imp/sampler /usr/local/bin/sampler

docs/Computation Pipeline.md

@@ -124,19 +124,19 @@ component:
         location: west-us
         energy: 43 mWh
         grid-intensity: 500 gCO2e / kWh
-        operational-emissions: 4.7g gCO2e
+        operational-carbon: 4.7g gCO2e
       - timestamp: 2023-07-06T15:00
         duration: 5 mins
         location: west-us
         energy: 20 mWh
         grid-intensity: 490 gCO2e / kWh
-        operational-emissions: 2.9 gCO2e       
+        operational-carbon: 2.9 gCO2e       
       - timestamp: 2023-07-06T25:00
         duration: 5 mins
         location: west-us
         energy: 18 mWh  
         grid-intensity: 470 gCO2e / kWh
-        operational-emissions: 2.8g gCO2e         
+        operational-carbon: 2.8g gCO2e         
 ```
 
 ## Normalization
@@ -187,31 +187,31 @@ component:
         location: west-us
         energy: 14.3 mWh
         grid-intensity: 500 gCO2e / kWh
-        operational-emissions: 1.57g gCO2e
+        operational-carbon: 1.57g gCO2e
       - timestamp: 2023-07-06T05:00
         duration: 5 mins
         location: west-us
         energy: 14.3 mWh
         grid-intensity: 500 gCO2e / kWh
-        operational-emissions: 1.57g gCO2e
+        operational-carbon: 1.57g gCO2e
       - timestamp: 2023-07-06T10:00
         duration: 5 mins
         location: west-us
         energy: 14.3 mWh
         grid-intensity: 500 gCO2e / kWh
-        operational-emissions: 1.57g gCO2e                
+        operational-carbon: 1.57g gCO2e                
       - timestamp: 2023-07-06T15:00
         duration: 5 mins
         location: west-us
         energy: 20 mWh
         grid-intensity: 490 gCO2e / kWh
-        operational-emissions: 2.9 gCO2e       
+        operational-carbon: 2.9 gCO2e       
       - timestamp: 2023-07-06T25:00
         duration: 5 mins
         location: west-us
         energy: 18 mWh  
         grid-intensity: 470 gCO2e / kWh
-        operational-emissions: 2.8g gCO2e         
+        operational-carbon: 2.8g gCO2e         
   observations: 
       - timestamp: 2023-07-06T00:00
         duration: 15 mins
@@ -355,4 +355,4 @@ component:
 
 > [!tip] 
 > 
-> The same normalization plugin code could provide this time series of functional unit denominators. We pass in a fake component with observations that represent the functional unit denominators, pass through the normalization phase, and generate a series of users for the global time series of impact durations.
+> The same normalization plugin code could provide this time series of functional unit denominators. We pass in a fake component with observations that represent the functional unit denominators, pass through the normalization phase, and generate a series of users for the global time series of impact durations.

docs/Impact Engine Framework.md

@@ -29,7 +29,8 @@ A Framework to **M**odel, **M**easure, si**M**ulate and **M**onitor the environm
 - ✅ [Impl (Impact YAML)](Impl%20(Impact%20YAML).md)
 - 👷🏽‍♂️[Impact Model](Impact%20Model.md)
 - ✅ [Impact Model Plugin](Impact%20Model%20Plugin.md)
-- 🦖 ~~[Computation Pipeline](Computation%20Pipeline.md)~~
+- ✅ [Model Pipeline](Model%20Pipeline.md)
+- 👷🏽‍♂️ [Computation Pipeline](Computation%20Pipeline.md)
 - 👷🏽‍♂️ Computation Pipeline Plugin 🔥
 - 👷🏽‍♂️ [Impact Metric](Impact%20Metric) 🔥
 - ✍🏽 [Rimpl](Rimpl.md)