if-carbon-hack-plugin

if-carbon-hack-plugin is an environmental impact calculator template which exposes an API for IF to retrieve energy and embodied carbon estimates.

Plugins

The project contains the following plugins:

• Ramboll-Resilio - estimation based on using a figure for total annual energy reported per user, divided by the storage allocated per user
• Cloud Storage Metadata - return a replication factor based on the type of cloud service you were using
• Storage Energy - estimates the energy consumption of stored data
• Storage Read Write Energy - estimates the energy used to read/write data to a storage device

Implementation

Here can be implementation details of the plugin. For example which API is used, transformations and etc.

Usage

To run the if-carbon-hack-plugin, an instance of PluginInterface must be created. Then, the plugin's execute() method can be called, passing required arguments to it.

This is how you could run the model in Typescript:

async function runPlugin() {
  const newModel = new ObjectStorage({});
  const usage = await newModel.execute([
    {
      timestamp: '2021-01-01T00:00:00Z',
      duration: '15s',
      'cpu-util': 34,
    },
    {
      timestamp: '2021-01-01T00:00:15Z',
      duration: '15s',
      'cpu-util': 12,
    },
  ]);

  console.log(usage);
}

runPlugin();

Testing model integration

The plugin's unit tests can be run with npm test

Examples

The examples sub folder contains example manifest files, and is configured as a minimal npm package to aid in running them using this plugin. The package has a file based link back to the parent folder to allow it to install the plugin along with the Impact Framework dependency. Starting from the root directory you should be able to run this manifest by following these steps:

npm install
cd examples
npm install
npx ie --manifest plugin-demo-link.yml

Using local links

For using locally developed model in IF Framework please follow these steps:

1. On the root level of a locally developed model run npm link, which will create global package. It uses package.json file's name field as a package name. Additionally name can be checked by running npm ls -g --depth=0 --link=true.
2. Use the linked model in impl by specifying name, method, path in initialize models section.

name: plugin-demo-link
description: loads plugin
tags: null
initialize:
  plugins:
    my-custom-plugin:
      method: ObjectStorage
      path: 'if-carbon-hack-plugin'
      global-config: ...

Using directly from Github

You can simply push your model to the public Github repository and pass the path to it in your impl. For example, for a model saved in github.com/my-repo/my-model you can do the following:

npm install your model:

npm install -g https://github.com/my-repo/my-model

Then, in your impl, provide the path in the model instantiation. You also need to specify which class the model instantiates. In this case you are using the PluginInterface, so you can specify OutputModel.

name: plugin-demo-git
description: loads plugin
tags: null
initialize:
  plugins:
    my-custom-plugin:
      method: MyCustomPlugin
      path: https://github.com/my-repo/my-model
      global-config: ...

Now, when you run the manifest using the IF CLI, it will load the model automatically. Run using:

ie --manifest <path-to-your-impl> --output <path-to-save-output>