diff --git a/src/lib/co2js/README.md b/src/lib/co2js/README.md index 64ffc2d..00c8622 100644 --- a/src/lib/co2js/README.md +++ b/src/lib/co2js/README.md @@ -1,19 +1,11 @@ # CO2.JS -> [!NOTE] > `CO2.JS` ([thegreenwebfoundation/co2.js](https://github.com/thegreenwebfoundation/co2.js)) is a community model, not part of the IF standard library. This means the IF core team are not closely monitoring these models to keep them up to date. You should do your own research before implementing them! +> [!NOTE] > `CO2.JS` ([thegreenwebfoundation/co2.js](https://github.com/thegreenwebfoundation/co2.js)) is a community plugin, not part of the IF standard library. This means the IF core team are not closely monitoring these plugins to keep them up to date. You should do your own research before implementing them! # Parameters -## model config +## Plugin global config -- `type`: supported models by the library, `swd` or `1byte` - -## observations - -- `bytes`: the number of bytes transferred -- `green-web-host`: true if the website is hosted on a green web host, false otherwise -- `duration`: the amount of time the observation covers, in seconds -- `timestamp`: a timestamp for the observation - `options`: **SWD Model Only** an object containing any Sustainable Web Design specific variables to the changed. All keys are optional. - `dataReloadRatio` - a value between 0 and 1 representing the percentage of data that is downloaded by return visitors. -`firstVisitPercentage` - a value between 0 and 1 representing the percentage of new visitors. - `returnVisitPercentage` - a value between 0 and 1 representing the percentage of returning visitors. @@ -24,23 +16,34 @@ The value for `device`, `dataCenter`, or `networks` can be a number representing the carbon intensity for the given segment (in grams per kilowatt-hour). Or, an object, which contains a key of country and a value that is an Alpha-3 ISO country code. +## Plugin node config + +- `type`: supported plugins by the library, `swd` or `1byte` +- `green-web-host`: true if the website is hosted on a green web host, false otherwise + +## Inputs + +- `network/data/bytes`: the number of bytes transferred or `network/data` if the number is in GB +- `duration`: the amount of time the observation covers, in seconds +- `timestamp`: a timestamp for the observation + ## Returns -- `operational-carbon`: carbon emissions from the operation of the website, in grams of CO2e +- `carbon-operational`: carbon emissions from the operation of the website, in grams of CO2e # IF Implementation -IF utilizes the CO2JS Framework to calculate the carbon emissions of a website. The CO2JS Framework is a collection of models that calculate the carbon emissions of a website based on different parameters. IF installs the CO2js npm package from `@tgwf/co2js` and invokes its functions from a model plugin. +IF utilizes the CO2JS Framework to calculate the carbon emissions of a website. The CO2JS Framework is a collection of plugins that calculate the carbon emissions of a website based on different parameters. IF installs the CO2js npm package from `@tgwf/co2js` and invokes its functions from a plugin plugin. -The CO2JS Framework is a community model, not part of the IF standard library. This means the IF core team are not closely monitoring these models to keep them up to date. You should do your own research before implementing them! +The CO2JS Framework is a community plugin, not part of the IF standard library. This means the IF core team are not closely monitoring these plugins to keep them up to date. You should do your own research before implementing them! ## Usage -In IEF the model is called from an `impl`. An `impl` is a `.yaml` file that contains configuration metadata and usage inputs. This is interpreted by the command line tool, `impact-engine`. There, the model's `configure` method is called first. +In IEF the plugin is called from an `impl`. An `impl` is a `.yaml` file that contains configuration metadata and usage inputs. This is interpreted by the command line tool, `if`. There, the plugin's `configure` method is called first. -The model config should define a `type` supported by the CO2.JS library (either `swd` or `1byte`). These are different ways to calculate the operational carbon associated with a web application; `swd` is shorthand for 'sustainable web design' model and `1byte` refers to the OneByte mdoel. You can read about the details of these models and how they differ at the [Green Web Foundation website](https://developers.thegreenwebfoundation.org/co2js/explainer/methodologies-for-calculating-website-carbon/). +The plugin config should define a `type` supported by the CO2.JS library (either `swd` or `1byte`). These are different ways to calculate the operational carbon associated with a web application; `swd` is shorthand for 'sustainable web design' plugin and `1byte` refers to the OneByte mdoel. You can read about the details of these plugins and how they differ at the [Green Web Foundation website](https://developers.thegreenwebfoundation.org/co2js/explainer/methodologies-for-calculating-website-carbon/). -Each input is expected to contain `bytes`, `green-web-host`, `duration` and `timestamp` fields. +Each input is expected to contain `network/data/bytes` or `network/data`, `duration` and `timestamp` fields. ## IMPL @@ -48,14 +51,23 @@ The following is an example of how CO2.JS can be invoked using an `impl`. ```yaml name: co2js-demo -description: example impl invoking CO2.JS model +description: example impl invoking CO2.JS plugin tags: initialize: - models: - - name: co2js - model: Co2jsModel - path: '@grnsft/if-unofficial-models' -graph: + plugins: + co2js: + function: Co2js + path: '@grnsft/if-unofficial-plugins' + global-config: + options: + dataReloadRatio: 0.6 + firstVisitPercentage: 0.9 + returnVisitPercentage: 0.1 + gridIntensity: + device: 560.98 + dataCenter: + country: 'TWN' +tree: children: child: pipeline: @@ -63,27 +75,19 @@ graph: config: co2js: type: swd + green-web-host: true inputs: - - timestamp: 2023-07-06T00:00 # [KEYWORD] [NO-SUBFIELDS] time when measurement occurred + - timestamp: 2023-07-06T00:00 duration: 1 - bytes: 1000000 - green-web-host: true - options: - dataReloadRatio: 0.6, - firstVisitPercentage: 0.9, - returnVisitPercentage: 0.1, - gridIntensity: - device: 560.98 - dataCenter: - country: 'TWN' + network/data/bytes: 1000000 ``` -This impl is run using `impact-engine` using the following command, run from the project root: +This impl is run using `if` using the following command, run from the project root: ```sh npm i -g @grnsft/if -npm i -g @grnsft/if-unofficial-models -impact-engine --impl ./examples/impls/test/co2js.yml --ompl ./examples/ompls/co2js.yml +npm i -g @grnsft/if-unofficial-plugins +if --impl ./examples/impls/test/co2js.yml --ompl ./examples/ompls/co2js.yml ``` This yields a result that looks like the following (saved to `/ompls/co2js.yml`): @@ -91,13 +95,22 @@ This yields a result that looks like the following (saved to `/ompls/co2js.yml`) ```yaml name: co2js-demo description: example impl invoking CO2.JS model -tags: +tags: null initialize: - models: - - name: co2js - model: Co2jsModel + plugins: + co2js: path: '@grnsft/if-unofficial-models' -graph: + model: Co2js + global-config: + options: + dataReloadRatio: 0.6 + firstVisitPercentage: 0.9 + returnVisitPercentage: 0.1 + gridIntensity: + device: 560.98 + dataCenter: + country: TWN +tree: children: child: pipeline: @@ -105,74 +118,73 @@ graph: config: co2js: type: swd + green-web-host: true inputs: - timestamp: 2023-07-06T00:00 duration: 1 - bytes: 1000000 - green-web-host: true + network/data/bytes: 1000000 outputs: - timestamp: 2023-07-06T00:00 - operational-carbon: 0.03 duration: 1 - bytes: 1000000 - green-web-host: true - options: - dataReloadRatio: 0.6, - firstVisitPercentage: 0.9, - returnVisitPercentage: 0.1, - gridIntensity: - device: 560.98 - dataCenter: - country: 'TWN' + network/data/bytes: 1000000 + carbon-operational: 0.34497244224000007 ``` ## TypeScript -You can see example Typescript invocations for each model below. +You can see example Typescript invocations for each plugin below. ### SWD ```typescript -import {Co2jsModel} from '@grnsft/if-unofficial-models'; - -const co2js = await new Co2jsModel().configure({ - type: 'swd', -}); -const results = co2js.execute([ - { - duration: 3600, // duration institute - timestamp: '2021-01-01T00:00:00Z', // ISO8601 / RFC3339 timestamp - bytes: 1000000, // bytes transferred - 'green-web-host': true, // true if the website is hosted on a green web host, false otherwise - options: { - // Optional - dataReloadRatio: 0.6, - firstVisitPercentage: 0.9, - returnVisitPercentage: 0.1, - gridIntensity: { - device: 560.98, - dataCenter: 50, - networks: 437.66, - }, +import {Co2js} from '@grnsft/if-unofficial-plugins'; + +const globalConfig = { + options: { + // Optional + dataReloadRatio: 0.6, + firstVisitPercentage: 0.9, + returnVisitPercentage: 0.1, + gridIntensity: { + device: 560.98, + dataCenter: 50, + networks: 437.66, }, }, -]); +}; +const co2js = Co2js(globalConfig); +const results = co2js.execute( + [ + { + duration: 3600, // duration institute + timestamp: '2021-01-01T00:00:00Z', // ISO8601 / RFC3339 timestamp + 'network/data/bytes': 1000000, // bytes transferred + }, + ], + { + type: 'swd', + 'green-web-host': true, // true if the website is hosted on a green web host, false otherwise + } +); ``` ### 1byte ```typescript -import {Co2jsModel} from '@grnsft/if-unofficial-models'; - -const co2js = await new Co2jsModel().configure({ - type: '1byte', -}); -const results = co2js.execute([ +import {Co2js} from '@grnsft/if-unofficial-plugins'; + +const co2js = Co2js(); +const results = co2js.execute( + [ + { + duration: 3600, // duration institute + timestamp: '2021-01-01T00:00:00Z', // ISO8601 / RFC3339 timestamp + 'network/data/bytes': 1000000, // bytes transferred + }, + ], { - duration: 3600, // duration institute - timestamp: '2021-01-01T00:00:00Z', // ISO8601 / RFC3339 timestamp - bytes: 1000000, // bytes transferred + type: '1byte', 'green-web-host': true, // true if the website is hosted on a green web host, false otherwise - }, -]); + } +); ```