@grnsft/if 0.5.0 → 0.6.0

package/src/{builtins → if-run/builtins}/csv-lookup/README.md

@@ -13,19 +13,17 @@ For example, for the following CSV:
 | 2022 | Google Cloud   | asia-east2      | Hong Kong  | HK         | HK           | Hong Kong | 22.3,114.2       | 0.28       |            |                        | 0          | 453                        |                                   |                                |                                  | 360                   |
 | 2022 | Google Cloud   | asia-northeast1 | Tokyo      | JP-TK      | JP-TK        | Tokyo     | 35.6897,139.692  | 0.28       |            |                        | 0          | 463                        |                                   |                                |                                  | 463                   |
 
-
 You could select all the data for the cloud provider `Google Cloud` in the region `asia-east2` using the following configuration:
 
 ```yaml
 filepath: https://raw.githubusercontent.com/Green-Software-Foundation/if-data/main/region-metadata.csv
 query:
-  cloud-provider: "cloud/provider"
-  cloud-region: "cloud/region"
-output: "*"
+  cloud-provider: 'cloud/provider'
+  cloud-region: 'cloud/region'
+output: '*'
 ```
 
-Notice that the query parameters are key/value pairs where the key is the column name in the target CSV and the value is a **reference to a value** in your `input` data (*not* an actual value - a reference). This is to enable you to chain CSV lookups together based on information from other plugins in your pipeline.
-
+Notice that the query parameters are key/value pairs where the key is the column name in the target CSV and the value is a **reference to a value** in your `input` data (_not_ an actual value - a reference). This is to enable you to chain CSV lookups together based on information from other plugins in your pipeline.
 
 ## Parameters
 
@@ -33,28 +31,43 @@ Notice that the query parameters are key/value pairs where the key is the column
 
 - `filepath` - path to a csv file, either on the local filesystem or on the internet
 - `query` - an array of key/value pairs where the key is a column name in the target csv and the value is a parameter from inputs
-- `output` - the columns to grab data from and add to output data - should support wildcard or multiple values. 
+- `output` - the columns to grab data from and add to output data - should support wildcard or multiple values.
 
-The plugin also supports data renaming. This means you can grab data from a named column but push it into your manifest file data under another name, for example, maybe we want to grab data from the `processor-name` column int he target csv and add it to the manifest file data as `processor-id` because this is the name expected by some other plugin in your piepline. You can do this by passing comma separated values in arrays. 
+The plugin also supports data renaming. This means you can grab data from a named column but push it into your manifest file data under another name, for example, maybe we want to grab data from the `processor-name` column int he target csv and add it to the manifest file data as `processor-id` because this is the name expected by some other plugin in your piepline. You can do this by passing comma separated values in arrays.
 
 ```yaml
-output:
-  ["processor-name": "processor-id"]
+output: ['processor-name': 'processor-id']
 ```
 
 You can nest arrays to do this renaming for multiple columns.
 
 ```yaml
 output:
-  [["processor-name", "processor-model-id"],["tdp","thermal-design-power"]]
+  [['processor-name', 'processor-model-id'], ['tdp', 'thermal-design-power']]
 ```
 
 All the following values are valid for the `output` field:
+
 - `"*"`
 - `"tdp"`
 - `["processor-name", "processor-model-id"]`
 - `[["processor-name", "processor-model-id"],["tdp","thermal-design-power"]]`
 
+### Plugin parameter metadata
+
+The `parameter-metadata` section contains information about `description`, `unit` and `aggregation-method` of the parameters of the inputs and outputs
+
+- `inputs`: describe the parameters of the `inputs`. Each parameter has:
+
+  - `description`: description of the parameter
+  - `unit`: unit of the parameter
+  - `aggregation-method`: aggregation method of the parameter (it can be `sum`, `avg` or `none`)
+
+- `outputs`: describe the parameters in the `output` of the config block. The parameter has the following attributes:
+  - `description`: description of the parameter
+  - `unit`: unit of the parameter
+  - `aggregation-method`: aggregation method of the parameter (it can be `sum`, `avg` or `none`)
+
 ### Inputs
 
 There are no strict requirements on input for this plugin because they depend upon the contents of the target CSV and your input data at the time the CSV lookup is invoked. Please make sure you are requesting data from columns that exist in the target csv file and that your query values are available in your `input` data.
@@ -86,7 +99,7 @@ const globalConfig = {
   },
   output: ['cpu-tdp', 'tdp'],
 };
-const divide = CSVLookup(globalConfig);
+const csvLookup = CSVLookup(globalConfig);
 
 const input = [
   {
@@ -108,8 +121,6 @@ name: csv-lookup-demo
 description:
 tags:
 initialize:
-  outputs:
-    - yaml
   plugins:
     cloud-metadata:
       method: CSVLookup
@@ -117,14 +128,15 @@ initialize:
       global-config:
         filepath: https://raw.githubusercontent.com/Green-Software-Foundation/if-data/main/region-metadata.csv
         query:
-          cloud-provider: "cloud/provider"
-          cloud-region: "cloud/region"
-        output: "*"
+          cloud-provider: 'cloud/provider'
+          cloud-region: 'cloud/region'
+        output: '*'
 tree:
   children:
     child:
       pipeline:
-        - cloud-metadata
+        compute:
+          - cloud-metadata
       inputs:
         - timestamp: 2023-08-06T00:00
           duration: 3600
@@ -141,7 +153,6 @@ if-run --manifest manifests/plugins/csv-lookup.yml --output manifests/outputs/cs
 
 The results will be saved to a new `yaml` file in `manifests/outputs`.
 
-
 ## Errors
 
 Coefficient exposes six of the IF error classes.
@@ -171,10 +182,11 @@ This error arises due to problems parsing CSV data into IF. This can occur when
 You will receive an error starting `GlobalConfigError: ` if you have not provided the expected configuration data in the plugin's `initialize` block.
 
 The required parameters are:
+
 - `filepath`: This must be a path to a csv file
 - `query`: this must be an array of key-value pairs where the key is a string containing a column name an the value is a string containing the name of a value in `inputs`
 - `output`: this must be a string containing a name or a wildcard character (`"*"`)
 
 You can fix this error by checking you are providing valid values for each parameter in the config.
 
-For more information on our error classes, please visit [our docs](https://if.greensoftware.foundation/reference/errors
+For more information on our error classes, please visit [our docs](https://if.greensoftware.foundation/reference/errors)

package/src/{builtins → if-run/builtins}/divide/README.md

@@ -12,6 +12,21 @@ You provide the names of the values you want to divide, and a name to use to add
 - `denominator` - a parameter by a specific configured number or the number by which `numerator` is divided
 - `output` - the number to a configured output parameter
 
+### Plugin parameter metadata
+
+The `parameter-metadata` section contains information about `description`, `unit` and `aggregation-method` of the parameters of the inputs and outputs
+
+- `inputs`: describe the parameter of the `numerator` of the global config. The parameter has the following attributes:
+
+  - `description`: description of the parameter
+  - `unit`: unit of the parameter
+  - `aggregation-method`: aggregation method of the parameter (it can be `sum`, `avg` or `none`)
+
+- `outputs`: describe the parameter of the `denominator` of the global config. The parameter has the following attributes:
+  - `description`: description of the parameter
+  - `unit`: unit of the parameter
+  - `aggregation-method`: aggregation method of the parameter (it can be `sum`, `avg` or `none`)
+
 ### Inputs
 
 - `numerator` - as input parameter, must be available in the input array
@@ -24,7 +39,7 @@ You provide the names of the values you want to divide, and a name to use to add
 
 The plugin throws an exception if the division result is not a number.
 
->Note: Plugin will warn and return `numerator` value in case if `denominator` is zero.
+> Note: Plugin will warn and return `numerator` value in case if `denominator` is zero.
 
 ## Calculation
 
@@ -42,7 +57,7 @@ const globalConfig = {
   denominator: 2,
   output: 'cpu/number-cores',
 };
-const divide = Divide(globalConfig);
+const divide = Divide(globalConfig, parametersMetadata);
 
 const input = [
   {
@@ -62,8 +77,6 @@ name: divide-demo
 description:
 tags:
 initialize:
-  outputs:
-    - yaml
   plugins:
     divide:
       method: Divide
@@ -76,9 +89,8 @@ tree:
   children:
     child:
       pipeline:
-        - divide
-      config:
-        divide:
+        compute:
+          - divide
       inputs:
         - timestamp: 2023-08-06T00:00
           duration: 3600
@@ -103,6 +115,7 @@ The results will be saved to a new `yaml` file in `./examples/outputs`.
 You will receive an error starting `GlobalConfigError: ` if you have not provided the expected configuration data in the plugin's `initialize` block.
 
 The required parameters are:
+
 - `numerator`: a string containing the name of the input parameter whose value should be divided by `denominator`
 - `denominator`: a number to use as the denominator
 - ``output`: a string containing the name to assign the result of the division
@@ -113,9 +126,9 @@ You can fix this error by checking you are providing valid values for each param
 
 This error arises when a necessary piece of input data is missing from the `inputs` array.
 Every element in the ``inputs` array must contain:
+
 - `timestamp`
 - `duration`
 - whatever value you passed to `numerator`
 
-
 For more information on our error classes, please visit [our docs](https://if.greensoftware.foundation/reference/errors

package/src/{builtins → if-run/builtins}/exponent/README.md

@@ -16,6 +16,21 @@ Three parameters are required in global config: `input-parameter`, `exponent` an
 `exponent`: a number defining the exponent.
 `output-parameter`: a string defining the name to use to add the result of the exponent to the output array.
 
+### Plugin parameter metadata
+
+The `parameter-metadata` section contains information about `description`, `unit` and `aggregation-method` of the parameters of the inputs and outputs
+
+- `inputs`: describe the parameter of the `input-parameter` of the global config. The parameter has the following attributes:
+
+  - `description`: description of the parameter
+  - `unit`: unit of the parameter
+  - `aggregation-method`: aggregation method of the parameter (it can be `sum`, `avg` or `none`)
+
+- `outputs`: describe the parameter of the `output-parameter` of the global config. The parameter has the following attributes::
+  - `description`: description of the parameter
+  - `unit`: unit of the parameter
+  - `aggregation-method`: aggregation method of the parameter (it can be `sum`, `avg` or `none`)
+
 ### Inputs
 
 `input-parameter` and `exponent` must be available in the input array.
@@ -63,8 +78,6 @@ name: exponent demo
 description:
 tags:
 initialize:
-  outputs:
-    - yaml
   plugins:
     exponent:
       method: Exponent
@@ -77,9 +90,8 @@ tree:
   children:
     child:
       pipeline:
-        - exponent
-      config:
-        exponent:
+        compute:
+          - exponent
       inputs:
         - timestamp: 2023-08-06T00:00
           duration: 3600
@@ -91,7 +103,7 @@ You can run this example by saving it as `manifests/examples/test/exponent.yml`
 
 ```sh
 npm i -g @grnsft/if
-if-run --manifest manifests/examples/test/exponent.yml --output manifests/outputs/exponent.yml
+if-run --manifest manifests/examples/test/exponent.yml --output manifests/outputs/exponent
 ```
 
 The results will be saved to a new `yaml` file in `manifests/outputs`.
@@ -109,9 +121,8 @@ Every element in the `inputs` array must contain:
 - `duration`
 - whatever value you passed to `input-parameter`
 
-
 ### `InputValidationError`
 
 This error arises when an invalid value is passed to `Exponent`. Typically, this can occur when a non-numeric value (such as a string made of alphabetic characters) is passed where a number or numeric string is expected. Please check that the types are correct for all the relevant fields in your `inputs` array.
 
-For more information on our error classes, please visit [our docs](https://if.greensoftware.foundation/reference/errors
+For more information on our error classes, please visit [our docs](https://if.greensoftware.foundation/reference/errors)

package/src/{builtins → if-run/builtins}/interpolation/README.md

@@ -25,6 +25,21 @@ To employ the `Interpolation` plugin, adhere to these steps:
 
 `x` and `y` arrays must be equal lengths.
 
+## Plugin parameter metadata
+
+The `parameter-metadata` section contains information about `description`, `unit` and `aggregation-method` of the parameters of the inputs and outputs
+
+- `inputs`: describe the parameter of the `input-parameter` of the global config. The parameter has the following attributes:
+
+  - `description`: description of the parameter
+  - `unit`: unit of the parameter
+  - `aggregation-method`: aggregation method of the parameter (it can be `sum`, `avg` or `none`)
+
+- `outputs`: describe the parameters of the `output-parameter` of the global config. The parameter has the following attributes:
+  - `description`: description of the parameter
+  - `unit`: unit of the parameter
+  - `aggregation-method`: aggregation method of the parameter (it can be `sum`, `avg` or `none`)
+
 ## Input Parameters
 
 The plugin expects the following input parameters:
@@ -102,8 +117,6 @@ name: interpolation-demo
 description: simple demo of interpolation plugin
 tags:
 initialize:
-  outputs:
-    - yaml
   plugins:
     interpolation:
       method: Interpolation
@@ -118,7 +131,8 @@ tree:
   children:
     child:
       pipeline:
-        - interpolation
+        compute:
+          - interpolation
       inputs:
         - timestamp: 2023-07-06T00:00
           duration: 3600
@@ -132,8 +146,6 @@ name: interpolation-demo
 description: simple demo of interpolation plugin
 tags:
 initialize:
-  outputs:
-    - yaml
   plugins:
     interpolation:
       method: Interpolation
@@ -148,7 +160,8 @@ tree:
   children:
     child:
       pipeline:
-        - interpolation
+        compute:
+          - interpolation
       inputs:
         - timestamp: 2023-07-06T00:00
           duration: 3600
@@ -178,6 +191,7 @@ if-run --manifest ./manifests/examples/interpolation.yml --output ./manifests/ou
 You will receive an error starting `GlobalConfigError: ` if you have not provided the expected configuration data in the plugin's `initialize` block.
 
 The required parameters are:
+
 - `method`: a string containing either `linear`, `spline` or `polynomial`
 - `x`: an array of numbers
 - `y`: an array of numbers
@@ -189,6 +203,7 @@ You can fix this error by checking you are providing valid values for each param
 ### Validation errors
 
 There are also several validation errors that can arise, including:
+
 - if the lengths of `x` and `y` are not equal
 - if `x` or `y` are empty
 - if the requested point to interpolate at is outside the range of `x`

package/src/{builtins → if-run/builtins}/mock-observations/README.md

@@ -17,6 +17,21 @@ The mode currently mocks 2 types of observation data:
 - `generators` define which fields to generate for each observation
 - `components` define the components for which to generate observations. The observations generated according to `timestamp-from`, `timestamp-to`, `duration` and `generators` will be duplicated for each component.
 
+### Plugin parameter metadata
+
+The `parameter-metadata` section contains information about `description`, `unit` and `aggregation-method` of the parameters of the inputs and outputs
+
+- `inputs`: describe the parameters of the `inputs`. Each parameter has:
+
+  - `description`: description of the parameter
+  - `unit`: unit of the parameter
+  - `aggregation-method`: aggregation method of the parameter (it can be `sum`, `avg` or `none`)
+
+- `outputs`: describe the output parameters. The parameter has the following attributes:
+  - `description`: description of the parameter
+  - `unit`: unit of the parameter
+  - `aggregation-method`: aggregation method of the parameter (it can be `sum`, `avg` or `none`)
+
 ### Authentication
 
 N/A
@@ -47,15 +62,13 @@ const result = await mockObservations.execute([]);
 
 ### manifest Example
 
-IF users will typically call the plugin as part of a pipeline defined in a `manifest` file. In this case, instantiating the plugin is handled by `ie` and does not have to be done explicitly by the user. The following is an example `manifest` that calls `mock-observation`:
+IF users will typically call the plugin as part of a pipeline defined in a `manifest` file. In this case, instantiating the plugin is handled by `if-run` and does not have to be done explicitly by the user. The following is an example `manifest` that calls `mock-observation`:
 
 ```yaml
 name: mock-observation-demo
 description: example invoking mock-observation plugin
 tags:
 initialize:
-  outputs:
-    - yaml
   plugins:
     mock-observations:
       kind: plugin
@@ -83,7 +96,8 @@ tree:
   children:
     child:
       pipeline:
-        - mock-observations
+        observe:
+          - mock-observations
       inputs:
 ```
 

package/src/{builtins → if-run/builtins}/multiply/README.md

@@ -15,6 +15,21 @@ Two parameters are required in global config: `input-parameters` and `output-par
 `input-parameters`: an array of strings. Each string should match an existing key in the `inputs` array
 `output-parameter`: a string defining the name to use to add the product of the input parameters to the output array.
 
+### Plugin parameter metadata
+
+The `parameter-metadata` section contains information about `description`, `unit` and `aggregation-method` of the parameters of the inputs and outputs
+
+- `inputs`: describe parameters of the `input-parameters` of the global config. Each parameter has:
+
+  - `description`: description of the parameter
+  - `unit`: unit of the parameter
+  - `aggregation-method`: aggregation method of the parameter (it can be `sum`, `avg` or `none`)
+
+- `outputs`: describe the parameter of the `output-parameter` of the global config. The parameter has the following attributes:
+  - `description`: description of the parameter
+  - `unit`: unit of the parameter
+  - `aggregation-method`: aggregation method of the parameter (it can be `sum`, `avg` or `none`)
+
 ### Inputs
 
 All of `input-parameters` must be available in the input array.
@@ -41,8 +56,8 @@ const config = {
   outputParameter: 'energy-product',
 };
 
-const mult = Multiply(config);
-const result = await mult.execute([
+const multiply = Multiply(config, parametersMetadata);
+const result = await multiply.execute([
   {
     duration: 3600,
     timestamp: '2021-01-01T00:00:00Z',
@@ -61,8 +76,6 @@ name: multiply-demo
 description:
 tags:
 initialize:
-  outputs:
-    - yaml
   plugins:
     multiply:
       method: Multiply
@@ -74,9 +87,8 @@ tree:
   children:
     child:
       pipeline:
-        - multiply
-      config:
-        multiply:
+        compute:
+          - multiply
       inputs:
         - timestamp: 2023-08-06T00:00
           duration: 3600
@@ -93,7 +105,6 @@ if-run --manifest ./examples/manifests/test/multiply.yml --output ./examples/out
 
 The results will be saved to a new `yaml` file in `./examples/outputs`
 
-
 ## Errors
 
 `Multiply` uses one of the IF error classes.
@@ -102,6 +113,7 @@ The results will be saved to a new `yaml` file in `./examples/outputs`
 
 This error arises when a necessary piece of input data is missing from the `inputs` array.
 Every element in the `inputs` array must contain:
+
 - `timestamp`
 - `duration`
 - whatever values you passed to `input-parameters`

package/src/{builtins → if-run/builtins}/regex/README.md

@@ -16,20 +16,34 @@ Intel® Xeon® Platinum 8272CL,Intel® Xeon® 8171M 2.1 GHz,Intel® Xeon® E5-26
 - `match` - a regex by which needs to match the `parameter`
 - `output` - output parameter name in the input
 
+### Plugin parameter metadata
+
+The `parameter-metadata` section contains information about `description`, `unit` and `aggregation-method` of the parameters of the inputs and outputs
+
+- `inputs`: describe the parameter of the `parameter` value of the global config. The parameter has the following attributes:
+
+  - `description`: description of the parameter
+  - `unit`: unit of the parameter
+  - `aggregation-method`: aggregation method of the parameter (it can be `sum`, `avg` or `none`)
+
+- `outputs`: describe the parameters of the `output` of the global config. The parameter has the following attributes:
+  - `description`: description of the parameter
+  - `unit`: unit of the parameter
+  - `aggregation-method`: aggregation method of the parameter (it can be `sum`, `avg` or `none`)
+
 ### Inputs
 
 - `parameter` - as input parameter, must be available in the input array
 
 ## Returns
 
-- `output`: the first match of `parameter` with the parameter name with `match` defined in global config.
+- `output`: The match of the `parameter` value using the `match` regex defined in the global config. If the `match` regex includes the global flag (`g`), a string containing all matches separated by spaces.
 
 ## Implementation
 
 To run the plugin, you must first create an instance of `Regex`. Then, you can call `execute()`.
 
 ```typescript
-
 const globalConfig = {
   parameter: 'physical-processor',
   match: '^[^,]+',
@@ -56,8 +70,6 @@ name: regex-demo
 description:
 tags:
 initialize:
-  outputs:
-    - yaml
   plugins:
     regex:
       method: Regex
@@ -70,9 +82,8 @@ tree:
   children:
     child:
       pipeline:
-        - regex
-      config:
-        regex:
+        compute:
+          - regex
       inputs:
         - timestamp: 2023-08-06T00:00
           duration: 3600
@@ -96,11 +107,11 @@ The results will be saved to a new `yaml` file in `manifests/outputs`.
 
 This error arises when a necessary piece of input data is missing from the `inputs` array.
 Every element in the `inputs` array must contain:
+
 - `timestamp`
 - `duration`
 - whatever value you passed to `parameter`
 
-
 ### `GlobalConfigError`
 
 You will receive an error starting `GlobalConfigError: ` if you have not provided the expected configuration data in the plugin's `initialize` block.
@@ -113,7 +124,6 @@ The required parameters are:
 
 You can fix this error by checking you are providing valid values for each parameter in the config.
 
-
 ### `RegexMismatchError`
 
 This error arises when the requested regex cannot find any matches in the given data. If there are multiple matches, the plugin returns the first, but if there are none, it throws this error.

package/src/{builtins → if-run/builtins}/sci/README.md

@@ -8,9 +8,22 @@
 
 - `functional-unit`: the name of the functional unit in which to express the carbon impact (required)
 
+### Plugin parameter metadata
 
-### Inputs
+The `parameter-metadata` section contains information about `description`, `unit` and `aggregation-method` of the parameters of the inputs and outputs
+
+- `inputs`: describe parameters of the `inputs`. Each parameter has:
+
+  - `description`: description of the parameter
+  - `unit`: unit of the parameter
+  - `aggregation-method`: aggregation method of the parameter (it can be `sum`, `avg` or `none`)
+
+- `outputs`: describe the `sci` parameter which has the following attributes:
+  - `description`: description of the parameter
+  - `unit`: unit of the parameter
+  - `aggregation-method`: aggregation method of the parameter (it can be `sum`, `avg` or `none`)
 
+### Inputs
 
 - `carbon`: total carbon in gCO2eq (required)
 - `functional-unit`: whatever `functional-unit` you define in global config also has to be present in each input, for example if you provide `functional-unit: requests` in global config, `requests` must be present in your input data.
@@ -19,7 +32,7 @@
 
 - `sci`: carbon expressed in terms of the given functional unit
 
->Note: Plugin will warn and return `carbon` value in case if `functional-unit`'s value is zero.
+> Note: Plugin will warn and return `carbon` value in case if `functional-unit`'s value is zero.
 
 ## Calculation
 
@@ -29,7 +42,6 @@ SCI is calculated as:
 sci = carbon / functional unit
 ```
 
-
 ## IF Implementation
 
 To run the plugin, you must first create an instance of `Sci`. Then, you can call `execute()` to return `sci`.
@@ -60,8 +72,6 @@ name: sci-demo
 description: example invoking sci plugin
 tags:
 initialize:
-  outputs:
-    - yaml
   plugins:
     sci:
       method: Sci
@@ -72,8 +82,8 @@ tree:
   children:
     child:
       pipeline:
-        - sci
-      config:
+        compute:
+          - sci
       inputs:
         - timestamp: 2023-07-06T00:00
           carbon: 5
@@ -99,14 +109,14 @@ The results will be saved to a new `yaml` file.
 This error arises when a necessary piece of input data is missing from the `inputs` array.
 
 Every element in the `inputs` array must contain:
+
 - `timestamp`
 - `duration`
 - `carbon`: a numeric value named `carbon` must exist in the inputs array
 - whatever value you passed to `functional-unit`
 
-
 ### Validation errors
 
 There is also a validation step that checks that the `functional-unit` was provided in the plugin config. If you see an error reporting this value as missing, please check you have provided it.
 
-For more information on our error classes, please visit [our docs](https://if.greensoftware.foundation/reference/errors
+For more information on our error classes, please visit [our docs](https://if.greensoftware.foundation/reference/errors)

package/src/{builtins → if-run/builtins}/sci-embodied/README.md

@@ -10,6 +10,21 @@ Read more on [embodied carbon](https://github.com/Green-Software-Foundation/sci/
 
 Not Needed
 
+### Plugin parameter metadata
+
+The `parameter-metadata` section contains information about `description`, `unit` and `aggregation-method` of the parameters of the inputs and outputs
+
+- `inputs`: describe the parameters of the `inputs`. Each parameter has:
+
+  - `description`: description of the parameter
+  - `unit`: unit of the parameter
+  - `aggregation-method`: aggregation method of the parameter (it can be `sum`, `avg` or `none`)
+
+- `outputs`: describe the `carbon-embodied` parameter. The parameter has the following attributes:
+  - `description`: description of the parameter
+  - `unit`: unit of the parameter
+  - `aggregation-method`: aggregation method of the parameter (it can be `sum`, `avg` or `none`)
+
 ### Inputs
 
 - `device/emissions-embodied`: the sum of Life Cycle Assessment (LCA) emissions for the component
@@ -79,8 +94,6 @@ name: sci-embodied
 description: simple demo invoking sci-embodied
 tags:
 initialize:
-  outputs:
-    - yaml
   plugins:
     sci-embodied:
       method: SciEmbodied
@@ -89,7 +102,8 @@ tree:
   children:
     child:
       pipeline:
-        - sci-embodied # duration & config -> embodied
+        compute:
+          - sci-embodied # duration & config -> embodied
       defaults:
         device/emissions-embodied: 1533.120 # gCO2eq
         device/expected-lifespan: 3 # 3 years in seconds
@@ -109,7 +123,6 @@ if-run --manifest manifests/plugins/sci-embodied.yml --output manifests/outputs/
 
 The results will be saved to a new `yaml` file in `./examples/outputs`.
 
-
 ## Errors
 
 `SciEmbodied` uses one of IF's error classes
@@ -120,5 +133,4 @@ This error class is used to describe a problem with one of the input values to `
 
 You will receive a specific error message explaining which parameter is problematic, and you can check and replace where appropriate.
 
-
 For more information on our error classes, please visit [our docs](https://if.greensoftware.foundation/reference/errors