Create a Climatiq.io plugin

[jcendava]

Prize Category

Best Model

Story

As an IF user, I want to use a plugin that utilizes Climatiq's APIs to determine electricity consumption, and the operational & embodied CO2e emissions of the compute and storage resources within my application, based on observations or estimated utilisation.

Rationale

This will allow users to access compute energy, CO2e and derived carbon intensity calculations from Climatiq rather than using the teads-curve model. It will also enable organisations who use Climatiq for other reporting activities to use Impact Framework pipelines with consistent calculations. It may offer scope to broaden out to non-cloud calculation cases.

Scope

Creation of new model that conforms to the IF model plugin interface.
Creation of README documentation to describe the Climatiq subscription requirements, manifest file structure, input and output parameters.

Impact

3/5

Implementation Guidelines

• The model MUST conform to the IF model plugin interface
• The model MUST require Climatiq API key in environment parameters.
• The model MUST require cloud provider, and resource sku, timespan & utilisation input parameters
• The model MUST return energy, operational and embodied CO2e and optional carbon intensity data for the specified resources
• The model MUST return data in standard IF units
• The model MUST accept duration in units of seconds as an input.
• The model SHOULD perform any conversion needed between Climatiq and IF standard units.
• The model SHOULD be written in Typescript
• The model MUST have unit tests that demonstrate correct execution
• The model MUST have documentation in the form of a README that explains usage.

Difficulty
3/5

This submission forms part of a group of ideas supporting formatting Endava's Fraud Detection Tool SCI case-study into an Impact Framework solution.