package carbon

You can search for identifiers within the package.

in-package search v0.2.0

On This Page

Low-level API Access
Generic Interface

carbon
- Carbon
  - Co2_signal
    
    Intensity
    
    Zone
  - Fr
  - Gb
    
    Error
    
    Factors
    
    Intensity
    
    Period
  - Intensity
    
    Co2_signal
    
    C
    
    Fr
    
    Gb

Legend:
Library
Module
Module type
Parameter
Class
Class type

Carbon is a library for inquiring information about the carbon intensity of energy grids around the world. It integrates various APIs to be able to do this. Some require API keys others do not.

Carbon intensity values are measured in grams of carbon dioxide equivalent per kilowatt hour. Carbon dioxide equivalent (CO₂-eq) is a unit for measuring the impact of various greenhouse gases. This makes it possible to compare say methane and CO₂ for their global-warming potential.

A killowatt hour is a measurement of energy use. 1kWh is the energy used by an appliance with a 1kW power rating for one hour.

So far there are two APIs available for use:

Gb uses carbonintensity.org.uk which does not require any API key, but it only works for Great Britain.
Co2_signal uses co2signal.com which does require an API key but has many more countries available.

Low-level API Access

module Gb : sig ... end

module Fr : sig ... end

module Co2_signal : sig ... end

Generic Interface

module Intensity : sig ... end