message_ix_models.tools.iea.eei.IEA_EEI

class message_ix_models.tools.iea.eei.IEA_EEI(source, source_kw)

Bases: ExoDataSource

Provider of exogenous data from the IEA Energy Efficiency Indicators data source.

To use data from this source, call exo_data.prepare_computer() with the arguments:

• source: “IEA_EEI”.

• source_kw including:

  • measure: name of a measure or indicator in the data.

  • broadcast_map (optional): name of a Key containing a mapping for genno.operator.broadcast_map().

  • plot (optional, default False): add a task with the key “plot IEA_EEI debug” to generate diagnostic plot using Plot.

  • aggregate, interpolate: see ExoDataSource.transform().

__init__(source, source_kw)

Handle source and source_kw.

An implementation must:

• Raise ValueError if it does not recognize or cannot handle the arguments in source or source_kw.

• Recognize and handle (if possible) a “measure” keyword in source_kw from MEASURES.

It may:

• Transform these into other values, for instance by mapping certain values to others, applying regular expressions, or other operations.

• Store those values as instance attributes for use in __call__().

• Set name and/or extra_dims to control the behaviour of prepare_computer().

• Log messages that give information that may help to debug a ValueError for source or source_kw that cannot be handled.

It should not actually load data or perform any time- or memory-intensive operations; these should only be triggered by __call__().

Methods

__init__(source, source_kw)	Handle source and source_kw.
raise_on_extra_kw(kwargs)	Helper for subclasses to handle the source_kw argument.
transform(c, base_key)	Prepare c to transform raw data from base_key.

Attributes

aggregate	By default, do not aggregate.
extra_dims	Optional additional dimensions for the returned Key/Quantity.
id	Identifier for this particular source.
interpolate	By default, do not interpolate.
name	Optional name for the returned Key/Quantity.

aggregate: bool = False

By default, do not aggregate.

extra_dims: Tuple[str, ...] = ()

Optional additional dimensions for the returned Key/Quantity. If not set by __init__(), the dimensions are \((n, y)\).

id: str = 'IEA EEI'

Identifier for this particular source.

interpolate: bool = False

By default, do not interpolate.

name: str = ''

Optional name for the returned Key/Quantity. If not set by __init__(), then the “measure” keyword is used.

raise_on_extra_kw(kwargs) → None

Helper for subclasses to handle the source_kw argument.

1. Store aggregate and interpolate, if they remain in kwargs.

2. Raise ValueError if there are any other, unhandled keyword arguments in kwargs.

transform(c: Computer, base_key: Key) → Key

Prepare c to transform raw data from base_key.

base_key identifies the Quantity that is returned by __call__(). Before the data is returned, transform() allows the data source to add additional tasks or computations to c that further transform the data. (These operations may be done in __call__() directly, but transform() allows use of other genno operators and conveniences.)

The default implementation:

1. If aggregate is True, aggregates the data ( genno.operator.aggregate()) on the \(n\) dimension using the key “n::groups”.

2. If interpolate is True, interpolates the data ( genno.operator.interpolate()) on the \(y\) dimension using “y::coords”.