@grnsft/if 0.0.6 → 0.1.0

package/.examples/ompls/azure.yml

@@ -0,0 +1,205 @@
+name: ccf-demo
+description: example impl invoking CCF model
+tags: null
+initialize:
+  models:
+    - name: azure-importer
+      kind: plugin
+      path: if-models
+      model: AzureImporterModel
+graph:
+  children:
+    child:
+      pipeline:
+        - azure-importer
+      config:
+        azure-importer: null
+      inputs:
+        - timestamp: '2023-11-02T10:35:31.820Z'
+          duration: 3600
+          azure-observation-window: 5 min
+          azure-observation-aggregation: average
+          azure-subscription-id: 9de7e19f-8a18-4e73-9451-45fc74e7d0d3
+          azure-resource-group: vm1_group
+          azure-vm-name: vm1
+      outputs:
+        - timestamp: '2023-11-02T10:35:31.820Z'
+          cloud-vendor: azure
+          cpu-util: '0.314'
+          mem-availableGB: 0.488636416
+          mem-usedGB: 0.5113635839999999
+          total-memoryGB: '1'
+          mem-util: 51.13635839999999
+          location: uksouth
+          cloud-instance-type: Standard_B1s
+          duration: 300
+          azure-observation-window: 5 min
+          azure-observation-aggregation: average
+          azure-subscription-id: 9de7e19f-8a18-4e73-9451-45fc74e7d0d3
+          azure-resource-group: vm1_group
+          azure-vm-name: vm1
+        - timestamp: '2023-11-02T10:35:31.820Z'
+          cloud-vendor: azure
+          cpu-util: '0.314'
+          mem-availableGB: 0.48978984960000005
+          mem-usedGB: 0.5102101504
+          total-memoryGB: '1'
+          mem-util: 51.021015039999995
+          location: uksouth
+          cloud-instance-type: Standard_B1s
+          duration: 300
+          azure-observation-window: 5 min
+          azure-observation-aggregation: average
+          azure-subscription-id: 9de7e19f-8a18-4e73-9451-45fc74e7d0d3
+          azure-resource-group: vm1_group
+          azure-vm-name: vm1
+        - timestamp: '2023-11-02T10:35:31.820Z'
+          cloud-vendor: azure
+          cpu-util: '0.301'
+          mem-availableGB: 0.490733568
+          mem-usedGB: 0.509266432
+          total-memoryGB: '1'
+          mem-util: 50.9266432
+          location: uksouth
+          cloud-instance-type: Standard_B1s
+          duration: 300
+          azure-observation-window: 5 min
+          azure-observation-aggregation: average
+          azure-subscription-id: 9de7e19f-8a18-4e73-9451-45fc74e7d0d3
+          azure-resource-group: vm1_group
+          azure-vm-name: vm1
+        - timestamp: '2023-11-02T10:35:31.820Z'
+          cloud-vendor: azure
+          cpu-util: '0.298'
+          mem-availableGB: 0.490733568
+          mem-usedGB: 0.509266432
+          total-memoryGB: '1'
+          mem-util: 50.9266432
+          location: uksouth
+          cloud-instance-type: Standard_B1s
+          duration: 300
+          azure-observation-window: 5 min
+          azure-observation-aggregation: average
+          azure-subscription-id: 9de7e19f-8a18-4e73-9451-45fc74e7d0d3
+          azure-resource-group: vm1_group
+          azure-vm-name: vm1
+        - timestamp: '2023-11-02T10:35:31.820Z'
+          cloud-vendor: azure
+          cpu-util: '0.301'
+          mem-availableGB: 0.49178214400000003
+          mem-usedGB: 0.5082178559999999
+          total-memoryGB: '1'
+          mem-util: 50.82178559999999
+          location: uksouth
+          cloud-instance-type: Standard_B1s
+          duration: 300
+          azure-observation-window: 5 min
+          azure-observation-aggregation: average
+          azure-subscription-id: 9de7e19f-8a18-4e73-9451-45fc74e7d0d3
+          azure-resource-group: vm1_group
+          azure-vm-name: vm1
+        - timestamp: '2023-11-02T10:35:31.820Z'
+          cloud-vendor: azure
+          cpu-util: '0.298'
+          mem-availableGB: 0.49178214400000003
+          mem-usedGB: 0.5082178559999999
+          total-memoryGB: '1'
+          mem-util: 50.82178559999999
+          location: uksouth
+          cloud-instance-type: Standard_B1s
+          duration: 300
+          azure-observation-window: 5 min
+          azure-observation-aggregation: average
+          azure-subscription-id: 9de7e19f-8a18-4e73-9451-45fc74e7d0d3
+          azure-resource-group: vm1_group
+          azure-vm-name: vm1
+        - timestamp: '2023-11-02T10:35:31.820Z'
+          cloud-vendor: azure
+          cpu-util: '0.304'
+          mem-availableGB: 0.492306432
+          mem-usedGB: 0.507693568
+          total-memoryGB: '1'
+          mem-util: 50.7693568
+          location: uksouth
+          cloud-instance-type: Standard_B1s
+          duration: 300
+          azure-observation-window: 5 min
+          azure-observation-aggregation: average
+          azure-subscription-id: 9de7e19f-8a18-4e73-9451-45fc74e7d0d3
+          azure-resource-group: vm1_group
+          azure-vm-name: vm1
+        - timestamp: '2023-11-02T10:35:31.820Z'
+          cloud-vendor: azure
+          cpu-util: '0.3'
+          mem-availableGB: 0.49283072000000006
+          mem-usedGB: 0.50716928
+          total-memoryGB: '1'
+          mem-util: 50.716927999999996
+          location: uksouth
+          cloud-instance-type: Standard_B1s
+          duration: 300
+          azure-observation-window: 5 min
+          azure-observation-aggregation: average
+          azure-subscription-id: 9de7e19f-8a18-4e73-9451-45fc74e7d0d3
+          azure-resource-group: vm1_group
+          azure-vm-name: vm1
+        - timestamp: '2023-11-02T10:35:31.820Z'
+          cloud-vendor: azure
+          cpu-util: '0.636'
+          mem-availableGB: 0.5062524928000001
+          mem-usedGB: 0.49374750719999994
+          total-memoryGB: '1'
+          mem-util: 49.374750719999994
+          location: uksouth
+          cloud-instance-type: Standard_B1s
+          duration: 300
+          azure-observation-window: 5 min
+          azure-observation-aggregation: average
+          azure-subscription-id: 9de7e19f-8a18-4e73-9451-45fc74e7d0d3
+          azure-resource-group: vm1_group
+          azure-vm-name: vm1
+        - timestamp: '2023-11-02T10:35:31.820Z'
+          cloud-vendor: azure
+          cpu-util: '0.29500000000000004'
+          mem-availableGB: 0.509607936
+          mem-usedGB: 0.490392064
+          total-memoryGB: '1'
+          mem-util: 49.039206400000005
+          location: uksouth
+          cloud-instance-type: Standard_B1s
+          duration: 300
+          azure-observation-window: 5 min
+          azure-observation-aggregation: average
+          azure-subscription-id: 9de7e19f-8a18-4e73-9451-45fc74e7d0d3
+          azure-resource-group: vm1_group
+          azure-vm-name: vm1
+        - timestamp: '2023-11-02T10:35:31.820Z'
+          cloud-vendor: azure
+          cpu-util: '0.309'
+          mem-availableGB: 0.5106565120000001
+          mem-usedGB: 0.48934348799999994
+          total-memoryGB: '1'
+          mem-util: 48.934348799999995
+          location: uksouth
+          cloud-instance-type: Standard_B1s
+          duration: 300
+          azure-observation-window: 5 min
+          azure-observation-aggregation: average
+          azure-subscription-id: 9de7e19f-8a18-4e73-9451-45fc74e7d0d3
+          azure-resource-group: vm1_group
+          azure-vm-name: vm1
+        - timestamp: '2023-11-02T10:35:31.820Z'
+          cloud-vendor: azure
+          cpu-util: '0.484'
+          mem-availableGB: 0.5106565120000001
+          mem-usedGB: 0.48934348799999994
+          total-memoryGB: '1'
+          mem-util: 48.934348799999995
+          location: uksouth
+          cloud-instance-type: Standard_B1s
+          duration: 300
+          azure-observation-window: 5 min
+          azure-observation-aggregation: average
+          azure-subscription-id: 9de7e19f-8a18-4e73-9451-45fc74e7d0d3
+          azure-resource-group: vm1_group
+          azure-vm-name: vm1

package/.github/workflows/nodejs-ci.yml

@@ -16,17 +16,9 @@ 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
 

package/README.md

@@ -1,8 +1,8 @@
-# Impact Engine Framework
+# Impact Framework
 
-[Impact Engine Framework](https://greensoftwarefoundation.atlassian.net/wiki/spaces/~612dd45e45cd76006a84071a/pages/17072136/Opensource+Impact+Engine+Framework) is an [Incubation](https://oc.greensoftware.foundation/project-lifecycle.html#incubation) project from the [Open Source Working Group](https://greensoftwarefoundation.atlassian.net/wiki/spaces/~612dd45e45cd76006a84071a/pages/852049/Open+Source+Working+Group) in the [Green Software Foundation](https://greensoftware.foundation/).
+[Impact Framework](https://greensoftwarefoundation.atlassian.net/wiki/spaces/~612dd45e45cd76006a84071a/pages/17072136/Opensource+Impact+Engine+Framework) (IF) is an [Incubation](https://oc.greensoftware.foundation/project-lifecycle.html#incubation) project from the [Open Source Working Group](https://greensoftwarefoundation.atlassian.net/wiki/spaces/~612dd45e45cd76006a84071a/pages/852049/Open+Source+Working+Group) in the [Green Software Foundation](https://greensoftware.foundation/).
 
-**IEF** is a framework to **M**odel, **M**easure, si**M**ulate and **M**onitor the environmental impacts of software
+**IF** is a framework to **M**odel, **M**easure, si**M**ulate and **M**onitor the environmental impacts of software
 
 Modern applications are composed of many smaller pieces of software (components) running on many different environments, for example, private cloud, public cloud, bare-metal, virtualized, containerized, mobile, laptops, and desktops.
 
@@ -15,12 +15,51 @@ Read the [specification and design docs](https://github.com/Green-Software-Found
 
 ## Get started
 
-The first thing to understand is that IF is a framework for running model plugins. This means that in order to do some calculations, you need to load some models from some external resource. We provide a [standard library of models](https://github.com/Green-Software-Foundation/if-models) and a repository of [community models](https://github.com/Green-Software-Foundation/if-community-models) to get you started. 
+The first thing to understand is that IF is a framework for running model plugins. This means that in order to do some calculations, you need to load some models from some external resource. We provide a [standard library of models](https://github.com/Green-Software-Foundation/if-models) and a repository of [community models](https://github.com/Green-Software-Foundation/if-unofficial-models) to get you started. 
 
-Start by installing some models:
+Start by installing framework itself:
 
 ```sh
-yarn add https://github.com/Green-Software-Foundation/if-models
+npm install -g "@grnsft/if"
+```
+Then installing some models:
+
+```sh
+npm install -g "@grnsft/if-models"
+```
+
+Then create an `impl` file that describes your application (see our docs for a detailed explanation).
+
+Then, run `impact-engine` using the following command:
+
+```sh
+impact-engine --impl <path-to-your-impl-file>
+```
+
+You can also add an optional savepath for your output yaml (if you do not provide one, the output will be printed to the console):
+
+```sh
+impact-engine --impl <path-to-your-impl-file> --ompl <your-savepath>
+```
+
+The `impact-engine` CLI tool will configure and run the models defined in your input `yaml` (`impl`) and return the results as an output `yaml` (`ompl`).
+
+### Alternate version
+
+Start by cloning repository locally:
+
+```sh
+git clone https://github.com/Green-Software-Foundation/if
+
+cd if
+
+yarn install
+```
+
+Then installing some models:
+
+```sh
+yarn add "@grnsft/if-models"
 ```
 
 Then create an `impl` file that describes your application (see our docs for a detailed explanation).
@@ -28,24 +67,24 @@ Then create an `impl` file that describes your application (see our docs for a d
 Then, run `impact-engine` using the following command:
 
 ```sh
-npx ts-node impact-engine.ts --impl <path-to-your-impl-file>
+yarn impact-engine -- --impl <path-to-your-impl-file>
 ```
 
 You can also add an optional savepath for your output yaml (if you do not provide one, the output will be printed to the console):
 
 ```sh
-npx ts-node impact-engine.ts --impl <path-to-your-impl-file> --ompl <your-savepath>
+yarn impact-engine -- --impl <path-to-your-impl-file> --ompl <your-savepath>
 ```
 
 The `impact-engine` CLI tool will configure and run the models defined in your input `yaml` (`impl`) and return the results as an output `yaml` (`ompl`).
 
+
 ## Video walk-through
 
 Watch this video to learn how to create and run an `impl`.
 
 [![Watch the walk-through video](https://i3.ytimg.com/vi/R-6eDM8AsvY/maxresdefault.jpg)](https://youtu.be/R-6eDM8AsvY)
 
-
 ## Run tests
 
 To run the complete set of tests simply run

package/build/index.js

@@ -17,7 +17,6 @@ const { DISCLAIMER_MESSAGE, SOMETHING_WRONG } = config_1.STRINGS;
  * 3. Initializes models.
  * 4. Initializes graph, does computing.
  * 5. Saves processed object as a yaml file.
- * @example run `npx ts-node impact-engine.ts --impl ./test.yml --ompl ./result.yml`
  * @example run `npm run impact-engine -- --impl ./test.yml --ompl ./result.yml`
  */
 const impactEngine = async () => {
@@ -44,4 +43,4 @@ const impactEngine = async () => {
     return Promise.reject(new CliInputError(SOMETHING_WRONG));
 };
 impactEngine().catch(helpers_1.andHandle);
-//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiaW5kZXguanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi9zcmMvaW5kZXgudHMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6Ijs7O0FBQ0EsMkRBQXFEO0FBQ3JELHVEQUFrRDtBQUVsRCxzQ0FBaUQ7QUFDakQsMENBQXFDO0FBQ3JDLDRDQUF5QztBQUN6QyxvREFBZ0Q7QUFDaEQsc0NBQWlFO0FBRWpFLHFDQUFpQztBQUVqQyxNQUFNLEVBQUMsYUFBYSxFQUFDLEdBQUcsZUFBTSxDQUFDO0FBRS9CLE1BQU0sRUFBQyxrQkFBa0IsRUFBRSxlQUFlLEVBQUMsR0FBRyxnQkFBTyxDQUFDO0FBRXREOzs7Ozs7OztHQVFHO0FBQ0gsTUFBTSxZQUFZLEdBQUcsS0FBSyxJQUFJLEVBQUU7SUFDOUIsT0FBTyxDQUFDLEdBQUcsQ0FBQyxrQkFBa0IsQ0FBQyxDQUFDO0lBRWhDLE1BQU0sYUFBYSxHQUFHLElBQUEsMkJBQW9CLEdBQUUsQ0FBQztJQUU3QyxJQUFJLGFBQWEsRUFBRTtRQUNqQixNQUFNLEVBQUMsU0FBUyxFQUFFLFVBQVUsRUFBQyxHQUFHLGFBQWEsQ0FBQztRQUM5QyxNQUFNLE9BQU8sR0FBRyxNQUFNLElBQUEsMkJBQW9CLEVBQUMsU0FBUyxDQUFDLENBQUM7UUFFdEQsdUJBQXVCO1FBQ3ZCLE1BQU0sSUFBSSxHQUFHLElBQUEsMEJBQVksRUFBQyxPQUFPLENBQUMsQ0FBQztRQUVuQyw4QkFBOEI7UUFDOUIsTUFBTSxjQUFjLEdBQUcsSUFBSSxnQ0FBYyxFQUFFLENBQUM7UUFDNUMsSUFBSSxDQUFDLFVBQVUsQ0FBQyxNQUFNLENBQUMsT0FBTyxDQUFDLENBQUMsS0FBVSxFQUFFLEVBQUUsQ0FDNUMsY0FBYyxDQUFDLFNBQVMsQ0FBQyxLQUFLLENBQUMsQ0FDaEMsQ0FBQztRQUVGLHNCQUFzQjtRQUN0QixNQUFNLGNBQWMsR0FBRyxJQUFJLDZCQUFhLENBQUMsSUFBSSxFQUFFLGNBQWMsQ0FBQyxDQUFDO1FBQy9ELE1BQU0sSUFBSSxHQUFHLE1BQU0sY0FBYyxDQUFDLE9BQU8sRUFBRSxDQUFDO1FBRTVDLElBQUksQ0FBQyxVQUFVLEVBQUU7WUFDZixPQUFPLENBQUMsR0FBRyxDQUFDLElBQUksQ0FBQyxTQUFTLENBQUMsSUFBSSxDQUFDLENBQUMsQ0FBQztZQUNsQyxPQUFPO1NBQ1I7UUFFRCxNQUFNLElBQUEscUJBQWMsRUFBQyxJQUFJLEVBQUUsVUFBVSxDQUFDLENBQUM7UUFFdkMsT0FBTztLQUNSO0lBRUQsT0FBTyxPQUFPLENBQUMsTUFBTSxDQUFDLElBQUksYUFBYSxDQUFDLGVBQWUsQ0FBQyxDQUFDLENBQUM7QUFDNUQsQ0FBQyxDQUFDO0FBRUYsWUFBWSxFQUFFLENBQUMsS0FBSyxDQUFDLG1CQUFTLENBQUMsQ0FBQyIsInNvdXJjZXNDb250ZW50IjpbIiMhL3Vzci9iaW4vZW52IG5vZGVcbmltcG9ydCB7TW9kZWxzVW5pdmVyc2V9IGZyb20gJy4vbGliL21vZGVscy11bml2ZXJzZSc7XG5pbXBvcnQge1N1cGVyY29tcHV0ZXJ9IGZyb20gJy4vbGliL3N1cGVyY29tcHV0ZXInO1xuXG5pbXBvcnQge3BhcnNlUHJvY2Vzc0FyZ3VtZW50fSBmcm9tICcuL3V0aWwvYXJncyc7XG5pbXBvcnQge0VSUk9SU30gZnJvbSAnLi91dGlsL2Vycm9ycyc7XG5pbXBvcnQge2FuZEhhbmRsZX0gZnJvbSAnLi91dGlsL2hlbHBlcnMnO1xuaW1wb3J0IHt2YWxpZGF0ZUltcGx9IGZyb20gJy4vdXRpbC92YWxpZGF0aW9ucyc7XG5pbXBvcnQge29wZW5ZYW1sRmlsZUFzT2JqZWN0LCBzYXZlWWFtbEZpbGVBc30gZnJvbSAnLi91dGlsL3lhbWwnO1xuXG5pbXBvcnQge1NUUklOR1N9IGZyb20gJy4vY29uZmlnJztcblxuY29uc3Qge0NsaUlucHV0RXJyb3J9ID0gRVJST1JTO1xuXG5jb25zdCB7RElTQ0xBSU1FUl9NRVNTQUdFLCBTT01FVEhJTkdfV1JPTkd9ID0gU1RSSU5HUztcblxuLyoqXG4gKiAxLiBQYXJzZXMgeW1sIGlucHV0L291dHB1dCBwcm9jZXNzIGFyZ3VtZW50cy5cbiAqIDIuIE9wZW5zIHlhbWwgZmlsZSBhcyBhbiBvYmplY3QuXG4gKiAzLiBJbml0aWFsaXplcyBtb2RlbHMuXG4gKiA0LiBJbml0aWFsaXplcyBncmFwaCwgZG9lcyBjb21wdXRpbmcuXG4gKiA1LiBTYXZlcyBwcm9jZXNzZWQgb2JqZWN0IGFzIGEgeWFtbCBmaWxlLlxuICogQGV4YW1wbGUgcnVuIGBucHggdHMtbm9kZSBpbXBhY3QtZW5naW5lLnRzIC0taW1wbCAuL3Rlc3QueW1sIC0tb21wbCAuL3Jlc3VsdC55bWxgXG4gKiBAZXhhbXBsZSBydW4gYG5wbSBydW4gaW1wYWN0LWVuZ2luZSAtLSAtLWltcGwgLi90ZXN0LnltbCAtLW9tcGwgLi9yZXN1bHQueW1sYFxuICovXG5jb25zdCBpbXBhY3RFbmdpbmUgPSBhc3luYyAoKSA9PiB7XG4gIGNvbnNvbGUubG9nKERJU0NMQUlNRVJfTUVTU0FHRSk7XG5cbiAgY29uc3QgcHJvY2Vzc1BhcmFtcyA9IHBhcnNlUHJvY2Vzc0FyZ3VtZW50KCk7XG5cbiAgaWYgKHByb2Nlc3NQYXJhbXMpIHtcbiAgICBjb25zdCB7aW5wdXRQYXRoLCBvdXRwdXRQYXRofSA9IHByb2Nlc3NQYXJhbXM7XG4gICAgY29uc3QgcmF3SW1wbCA9IGF3YWl0IG9wZW5ZYW1sRmlsZUFzT2JqZWN0KGlucHV0UGF0aCk7XG5cbiAgICAvLyBMaWZlY3ljbGUgVmFsaWRhdGlvblxuICAgIGNvbnN0IGltcGwgPSB2YWxpZGF0ZUltcGwocmF3SW1wbCk7XG5cbiAgICAvLyBMaWZlY3ljbGUgSW5pdGlhbGl6ZSBNb2RlbHNcbiAgICBjb25zdCBtb2RlbHNIYW5kYm9vayA9IG5ldyBNb2RlbHNVbml2ZXJzZSgpO1xuICAgIGltcGwuaW5pdGlhbGl6ZS5tb2RlbHMuZm9yRWFjaCgobW9kZWw6IGFueSkgPT5cbiAgICAgIG1vZGVsc0hhbmRib29rLndyaXRlRG93bihtb2RlbClcbiAgICApO1xuXG4gICAgLy8gTGlmZWN5Y2xlIENvbXB1dGluZ1xuICAgIGNvbnN0IGF0ZXJ1aUNvbXB1dGVyID0gbmV3IFN1cGVyY29tcHV0ZXIoaW1wbCwgbW9kZWxzSGFuZGJvb2spO1xuICAgIGNvbnN0IG9tcGwgPSBhd2FpdCBhdGVydWlDb21wdXRlci5jb21wdXRlKCk7XG5cbiAgICBpZiAoIW91dHB1dFBhdGgpIHtcbiAgICAgIGNvbnNvbGUubG9nKEpTT04uc3RyaW5naWZ5KG9tcGwpKTtcbiAgICAgIHJldHVybjtcbiAgICB9XG5cbiAgICBhd2FpdCBzYXZlWWFtbEZpbGVBcyhvbXBsLCBvdXRwdXRQYXRoKTtcblxuICAgIHJldHVybjtcbiAgfVxuXG4gIHJldHVybiBQcm9taXNlLnJlamVjdChuZXcgQ2xpSW5wdXRFcnJvcihTT01FVEhJTkdfV1JPTkcpKTtcbn07XG5cbmltcGFjdEVuZ2luZSgpLmNhdGNoKGFuZEhhbmRsZSk7XG4iXX0=
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiaW5kZXguanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi9zcmMvaW5kZXgudHMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6Ijs7O0FBQ0EsMkRBQXFEO0FBQ3JELHVEQUFrRDtBQUVsRCxzQ0FBaUQ7QUFDakQsMENBQXFDO0FBQ3JDLDRDQUF5QztBQUN6QyxvREFBZ0Q7QUFDaEQsc0NBQWlFO0FBRWpFLHFDQUFpQztBQUVqQyxNQUFNLEVBQUMsYUFBYSxFQUFDLEdBQUcsZUFBTSxDQUFDO0FBRS9CLE1BQU0sRUFBQyxrQkFBa0IsRUFBRSxlQUFlLEVBQUMsR0FBRyxnQkFBTyxDQUFDO0FBRXREOzs7Ozs7O0dBT0c7QUFDSCxNQUFNLFlBQVksR0FBRyxLQUFLLElBQUksRUFBRTtJQUM5QixPQUFPLENBQUMsR0FBRyxDQUFDLGtCQUFrQixDQUFDLENBQUM7SUFFaEMsTUFBTSxhQUFhLEdBQUcsSUFBQSwyQkFBb0IsR0FBRSxDQUFDO0lBRTdDLElBQUksYUFBYSxFQUFFO1FBQ2pCLE1BQU0sRUFBQyxTQUFTLEVBQUUsVUFBVSxFQUFDLEdBQUcsYUFBYSxDQUFDO1FBQzlDLE1BQU0sT0FBTyxHQUFHLE1BQU0sSUFBQSwyQkFBb0IsRUFBQyxTQUFTLENBQUMsQ0FBQztRQUV0RCx1QkFBdUI7UUFDdkIsTUFBTSxJQUFJLEdBQUcsSUFBQSwwQkFBWSxFQUFDLE9BQU8sQ0FBQyxDQUFDO1FBRW5DLDhCQUE4QjtRQUM5QixNQUFNLGNBQWMsR0FBRyxJQUFJLGdDQUFjLEVBQUUsQ0FBQztRQUM1QyxJQUFJLENBQUMsVUFBVSxDQUFDLE1BQU0sQ0FBQyxPQUFPLENBQUMsQ0FBQyxLQUFVLEVBQUUsRUFBRSxDQUM1QyxjQUFjLENBQUMsU0FBUyxDQUFDLEtBQUssQ0FBQyxDQUNoQyxDQUFDO1FBRUYsc0JBQXNCO1FBQ3RCLE1BQU0sY0FBYyxHQUFHLElBQUksNkJBQWEsQ0FBQyxJQUFJLEVBQUUsY0FBYyxDQUFDLENBQUM7UUFDL0QsTUFBTSxJQUFJLEdBQUcsTUFBTSxjQUFjLENBQUMsT0FBTyxFQUFFLENBQUM7UUFFNUMsSUFBSSxDQUFDLFVBQVUsRUFBRTtZQUNmLE9BQU8sQ0FBQyxHQUFHLENBQUMsSUFBSSxDQUFDLFNBQVMsQ0FBQyxJQUFJLENBQUMsQ0FBQyxDQUFDO1lBQ2xDLE9BQU87U0FDUjtRQUVELE1BQU0sSUFBQSxxQkFBYyxFQUFDLElBQUksRUFBRSxVQUFVLENBQUMsQ0FBQztRQUV2QyxPQUFPO0tBQ1I7SUFFRCxPQUFPLE9BQU8sQ0FBQyxNQUFNLENBQUMsSUFBSSxhQUFhLENBQUMsZUFBZSxDQUFDLENBQUMsQ0FBQztBQUM1RCxDQUFDLENBQUM7QUFFRixZQUFZLEVBQUUsQ0FBQyxLQUFLLENBQUMsbUJBQVMsQ0FBQyxDQUFDIiwic291cmNlc0NvbnRlbnQiOlsiIyEvdXNyL2Jpbi9lbnYgbm9kZVxuaW1wb3J0IHtNb2RlbHNVbml2ZXJzZX0gZnJvbSAnLi9saWIvbW9kZWxzLXVuaXZlcnNlJztcbmltcG9ydCB7U3VwZXJjb21wdXRlcn0gZnJvbSAnLi9saWIvc3VwZXJjb21wdXRlcic7XG5cbmltcG9ydCB7cGFyc2VQcm9jZXNzQXJndW1lbnR9IGZyb20gJy4vdXRpbC9hcmdzJztcbmltcG9ydCB7RVJST1JTfSBmcm9tICcuL3V0aWwvZXJyb3JzJztcbmltcG9ydCB7YW5kSGFuZGxlfSBmcm9tICcuL3V0aWwvaGVscGVycyc7XG5pbXBvcnQge3ZhbGlkYXRlSW1wbH0gZnJvbSAnLi91dGlsL3ZhbGlkYXRpb25zJztcbmltcG9ydCB7b3BlbllhbWxGaWxlQXNPYmplY3QsIHNhdmVZYW1sRmlsZUFzfSBmcm9tICcuL3V0aWwveWFtbCc7XG5cbmltcG9ydCB7U1RSSU5HU30gZnJvbSAnLi9jb25maWcnO1xuXG5jb25zdCB7Q2xpSW5wdXRFcnJvcn0gPSBFUlJPUlM7XG5cbmNvbnN0IHtESVNDTEFJTUVSX01FU1NBR0UsIFNPTUVUSElOR19XUk9OR30gPSBTVFJJTkdTO1xuXG4vKipcbiAqIDEuIFBhcnNlcyB5bWwgaW5wdXQvb3V0cHV0IHByb2Nlc3MgYXJndW1lbnRzLlxuICogMi4gT3BlbnMgeWFtbCBmaWxlIGFzIGFuIG9iamVjdC5cbiAqIDMuIEluaXRpYWxpemVzIG1vZGVscy5cbiAqIDQuIEluaXRpYWxpemVzIGdyYXBoLCBkb2VzIGNvbXB1dGluZy5cbiAqIDUuIFNhdmVzIHByb2Nlc3NlZCBvYmplY3QgYXMgYSB5YW1sIGZpbGUuXG4gKiBAZXhhbXBsZSBydW4gYG5wbSBydW4gaW1wYWN0LWVuZ2luZSAtLSAtLWltcGwgLi90ZXN0LnltbCAtLW9tcGwgLi9yZXN1bHQueW1sYFxuICovXG5jb25zdCBpbXBhY3RFbmdpbmUgPSBhc3luYyAoKSA9PiB7XG4gIGNvbnNvbGUubG9nKERJU0NMQUlNRVJfTUVTU0FHRSk7XG5cbiAgY29uc3QgcHJvY2Vzc1BhcmFtcyA9IHBhcnNlUHJvY2Vzc0FyZ3VtZW50KCk7XG5cbiAgaWYgKHByb2Nlc3NQYXJhbXMpIHtcbiAgICBjb25zdCB7aW5wdXRQYXRoLCBvdXRwdXRQYXRofSA9IHByb2Nlc3NQYXJhbXM7XG4gICAgY29uc3QgcmF3SW1wbCA9IGF3YWl0IG9wZW5ZYW1sRmlsZUFzT2JqZWN0KGlucHV0UGF0aCk7XG5cbiAgICAvLyBMaWZlY3ljbGUgVmFsaWRhdGlvblxuICAgIGNvbnN0IGltcGwgPSB2YWxpZGF0ZUltcGwocmF3SW1wbCk7XG5cbiAgICAvLyBMaWZlY3ljbGUgSW5pdGlhbGl6ZSBNb2RlbHNcbiAgICBjb25zdCBtb2RlbHNIYW5kYm9vayA9IG5ldyBNb2RlbHNVbml2ZXJzZSgpO1xuICAgIGltcGwuaW5pdGlhbGl6ZS5tb2RlbHMuZm9yRWFjaCgobW9kZWw6IGFueSkgPT5cbiAgICAgIG1vZGVsc0hhbmRib29rLndyaXRlRG93bihtb2RlbClcbiAgICApO1xuXG4gICAgLy8gTGlmZWN5Y2xlIENvbXB1dGluZ1xuICAgIGNvbnN0IGF0ZXJ1aUNvbXB1dGVyID0gbmV3IFN1cGVyY29tcHV0ZXIoaW1wbCwgbW9kZWxzSGFuZGJvb2spO1xuICAgIGNvbnN0IG9tcGwgPSBhd2FpdCBhdGVydWlDb21wdXRlci5jb21wdXRlKCk7XG5cbiAgICBpZiAoIW91dHB1dFBhdGgpIHtcbiAgICAgIGNvbnNvbGUubG9nKEpTT04uc3RyaW5naWZ5KG9tcGwpKTtcbiAgICAgIHJldHVybjtcbiAgICB9XG5cbiAgICBhd2FpdCBzYXZlWWFtbEZpbGVBcyhvbXBsLCBvdXRwdXRQYXRoKTtcblxuICAgIHJldHVybjtcbiAgfVxuXG4gIHJldHVybiBQcm9taXNlLnJlamVjdChuZXcgQ2xpSW5wdXRFcnJvcihTT01FVEhJTkdfV1JPTkcpKTtcbn07XG5cbmltcGFjdEVuZ2luZSgpLmNhdGNoKGFuZEhhbmRsZSk7XG4iXX0=

package/examples/impls/test/azure.yml

@@ -4,7 +4,7 @@ tags:
 initialize:
   models:
     - name: azure-importer
-      path: if-models
+      path: "@grnsft/if-unofficial-models"
       model: AzureImporterModel
       kind: plugin
 graph:
@@ -15,12 +15,12 @@ graph:
       config:
         azure-importer:
       inputs:
-          - timestamp: '2023-11-02T10:35:31.820Z'
-            duration: 3600
-            azure-observation-window: 5 min # value and unit must be space separated 
-            azure-observation-aggregation: 'average'
-            azure-subscription-id: 9de7e19f-8a18-4e73-9451-45fc74e7d0d3
-            azure-resource-group: vm1_group
-            azure-vm-name: vm1
+        - timestamp: '2023-11-02T10:35:31.820Z'
+          duration: 3600
+          azure-observation-window: 5 min # value and unit must be space separated 
+          azure-observation-aggregation: 'average'
+          azure-subscription-id: 9de7e19f-8a18-4e73-9451-45fc74e7d0d3
+          azure-resource-group: vm1_group
+          azure-vm-name: vm1
 
 

package/examples/impls/test/ccf.yml

@@ -1,9 +1,11 @@
 name: ccf-demo
 description: example impl invoking CCF model
+tags:
 initialize:
   models:
     - name: ccf
-      kind: builtin
+      model: CloudCarbonFootprint
+      path: "@grnsft/if-unofficial-models"
 graph:
   children:
     child:
@@ -11,8 +13,8 @@ graph:
         - ccf
       config:
         ccf:
-          vendor: aws
-          instance-type: m5n.large
+          vendor: 'aws'
+          instance-type: 'm5n.large'
       inputs:
         - timestamp: 2023-07-06T00:00 # [KEYWORD] [NO-SUBFIELDS] time when measurement occurred
           duration: 1

package/examples/impls/test/if-demo.yml

@@ -4,21 +4,29 @@ tags:
 initialize:
   models:
     - name: azure-importer
-      kind: builtin
+      model: AzureImporterModel
+      path: "@grnsft/if-unofficial-models"
     - name: cloud-instance-metadata
-      kind: builtin
+      model: CloudInstanceMetadataModel
+      path: "@grnsft/if-models"
     - name: teads-curve
-      kind: builtin
+      model: TeadsCurveModel
+      path: "@grnsft/if-unofficial-models"
     - name: sci-e
-      kind: builtin
+      model: SciEModel
+      path: "@grnsft/if-models"
     - name: sci-o
-      kind: builtin
+      model: SciOModel
+      path: "@grnsft/if-models"
     - name: sci-e
-      kind: builtin
+      model: SciEModel
+      path: "@grnsft/if-models"
     - name: sci-m
-      kind: builtin
+      model: SciMModel
+      path: "@grnsft/if-models"
     - name: sci
-      kind: builtin
+      model: SciModel
+      path: "@grnsft/if-models"
 graph:
   children:
     child:
@@ -31,6 +39,8 @@ graph:
         - sci-m
         - sci
       config:
+        sci-o:
+          grid-carbon-intensity: 951
         sci:
           functional-unit: ''
           functional-unit-time: hour
@@ -43,9 +53,9 @@ graph:
             azure-subscription-id: 9de7e19f-8a18-4e73-9451-45fc74e7d0d3
             azure-resource-group: vm1_group
             azure-vm-name: vm1
-            grid-carbon-intensity: 951
             total-embodied-emissions: 1533.12
             time-reserved: 300
             expected-lifespan: 94348800 # 3 yrs in seconds
             resources-reserved: 1
             total-resources: 64
+

package/examples/impls/test/metadata.yml

@@ -1,10 +1,11 @@
-name: sci-m
+name: cloud-instance-metadata
 description: simple demo invoking metadata lookup
 tags: null
 initialize:
   models:
     - name: cloud-instance-metadata
-      kind: builtin
+      model: CloudInstanceMetadataModel
+      path: "@grnsft/if-models"
 graph:
   children:
     child:

package/examples/impls/test/nesting.yml

@@ -7,23 +7,20 @@ tags:
 initialize:
   models:
     - name: teads-curve
-      kind: builtin
+      model: TeadsCurveModel
+      path: "@grnsft/if-unofficial-models"
     - name: sci-e
-      kind: builtin
-      verbose: false
-      path: ''
+      model: SciEModel
+      path: "@grnsft/if-models"
     - name: sci-m
-      kind: builtin
-      verbose: false
-      path: ''
+      path: "@grnsft/if-models"
+      model: SciMModel
     - name: sci-o
-      kind: builtin
-      verbose: false
-      path: ''
+      model: SciOModel
+      path: "@grnsft/if-models"
     - name: sci
-      kind: builtin
-      verbose: false
-      path: ''
+      model: SciModel
+      path: "@grnsft/if-models"
 graph:
   children:
     child: # an advanced grouping node

package/examples/impls/test/sci-e.yml

@@ -7,7 +7,7 @@ initialize:
       kind: plugin
       verbose: false
       model: SciEModel
-      path: if-models
+      path: "@grnsft/if-models"
 graph:
   children:
     child:

package/examples/impls/test/sci-m.yml

@@ -4,9 +4,9 @@ tags:
 initialize:
   models:
     - name: sci-m # a model that calculates m from te, tir, el, rr and rtor
-      kind: builtin
+      model: SciMModel
       verbose: false
-      path: ''
+      path: "@grnsft/if-models"
 graph:
   children:
     child:

package/examples/impls/test/sci-o.yml

@@ -5,14 +5,12 @@ initialize:
   models:
     - name: sci-e
       kind: plugin
-      verbose: false
       model: SciEModel
-      path: if-models
+      path: "@grnsft/if-models"
     - name: sci-o
-      kind: plugin
       verbose: false
       model: SciOModel
-      path: if-models
+      path: "@grnsft/if-models"
 graph:
   children:
     child:

package/examples/impls/test/sci.yml

@@ -5,9 +5,8 @@ initialize:
   models:
     - name: sci 
       kind: plugin
-      verbose: false
       model: SciModel
-      path: if-models
+      path: "@grnsft/if-models"
 graph:
   children:
     child:

package/examples/impls/test/shell.yml

@@ -4,7 +4,8 @@ tags:
 initialize:
   models:
     - name: sampler
-      kind: shell
+      model: ShellModel
+      path: "@grnsft/if-models"
 graph:
   children:
     child:

package/examples/impls/{tdp-finder-test.yml → test/tdp-finder.yml}

@@ -1,19 +1,19 @@
-name: tdp-tester
+name: tdp-finder
+description: demo
+tags:
 initialize:
   models:
     - name: tdp-finder # a model that returns an embodied value given the sci embodied attribution equation.
-      kind: builtin
-      verbose: false
-      path: ''
+      model: TdpFinderModel 
+      path: "@grnsft/if-models"
 graph:
   children:
-    backend:
+    child:
       pipeline: 
         - tdp-finder
       config:
-        tdp-finder:
-          tdp:
-      observations:
+      inputs:
         - timestamp: 2023-07-06T00:00
+          duration: 300
           physical-processor: AMD 3020e
 

package/examples/ompls/ccf.yml

@@ -1,9 +1,11 @@
 name: ccf-demo
 description: example impl invoking CCF model
+tags:
 initialize:
   models:
     - name: ccf
-      kind: builtin
+      model: CloudCarbonMetadataModel
+      path: if-models
 graph:
   children:
     child: