message_ix_models.tools.iea.eei.IEA_EEI
- class message_ix_models.tools.iea.eei.IEA_EEI(*args, **kwargs)[source]
Bases:
ExoDataSource
Provider of exogenous data from the IEA Energy Efficiency Indicators source.
- __init__(*args, **kwargs) None [source]
Create an instance and prepare info for
transform()
/get()
.The base implementation:
Sets
options
—if not already set—by passing kwargs toOptions
.Raises an exception if there are other/unhandled args or kwargs.
If
key
is not set, constructs it with:Name
name
ormeasure
in lower case.Dimensions
dims
.
Subclasses may pre-empt this behaviour by setting
key
statically or dynamically.
A concrete class implementation must:
Set
options
, either directly or by callingsuper().__init__()
with or without keyword arguments.Set
key
, either directly or by callingsuper().__init__()
. In the latter case, it may setname
,measure
, and/ordims
to control the behaviour.Raise an exception if unrecognized or invalid kwargs are passed.
and may:
Transform kwargs or
options
arguments 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
get()
.Log messages that give information that helps to debug exceptions.
It must not perform any time- or memory-intensive operations, such as actually loading or fetching data. Those operations should be in
get()
.
Methods
__init__
(*args, **kwargs)Create an instance and prepare info for
transform()
/get()
.add_tasks
(c, *args[, context, strict])Add tasks to c to provide and transform the data.
get
()Return the data.
transform
(c, base_key)Add tasks to c to transform raw data from base_key.
Attributes
True
to allow the class to look up and use test data.where
keyword argument topath_fallback()
.Instance of the
Options
class.Key for the returned
Quantity
.- class Options(aggregate: bool = False, interpolate: bool = False, measure: str = '', name: str = '', dims: tuple[str, ...] = ('n', 'y'), broadcast_map: ForwardRef('Key') | None = None, plot: bool = False)[source]
Bases:
BaseOptions
- broadcast_map: Key | None = None
Name of a
Key
containing a mapping forgenno.operator.broadcast_map()
.
- classmethod from_args(source_id: str | ExoDataSource, *args, **kwargs)
Construct an instance from keyword arguments.
- Parameters:
source_id – For backwards-compatibility with
prepare_computer()
.
- classmethod add_tasks(c: Computer, *args, context: Context | None = None, strict: bool = True, **kwargs) tuple
Add tasks to c to provide and transform the data.
The first returned key is
key
, and will trigger the following tasks:Load or retrieve data by invoking
ExoDataSource.get()
.If
BaseOptions.aggregate
isTrue
, aggregate on the \(n\) (node) dimension according toConfig.regions
.If
BaseOptions.interpolate
isTrue
, interpolate on the \(y\) (year) dimension according toConfig.years
.
Steps (2) and (3) are added by
transform()
and may differ in concrete classes.Other returned keys include further transformations:
key + "y0_indexed"
: same askey
, but indexed to the values as of the first model period.
Other keys that are created but not returned can be accessed on c:
key + "message_ix_models.foo.bar.CLASS"
: the raw data, with a tag from the fully-qualified name of the ExoDataSource class.
To support the loading and transformation of data,
add_structure()
is first called with c.Todo
Add option/tasks to index to a particular label on the \(n\) dimension.
- get() AnyQuantity [source]
Return the data.
Implementations in concrete classes may load data from file, retrieve from remote sources or local caches, generate data, or anything else.
The Quantity returned by this method must have dimensions corresponding to
key
. If the original/upstream/raw data has different dimensionality (fewer or more dimensions; different dimension IDs), a concrete class must transform these, make appropriate selections, etc.
- key: Key
Key for the returned
Quantity
. This may either be set statically on a concrete subclass, or created via__init__()
.
- options: Options
Instance of the
Options
class.A concrete class that overrides
Options
should redefine this attribute, to facilitate type checking.
- transform(c: Computer, base_key: Key) Key [source]
Add tasks to c to transform raw data from base_key.
base_key refers to the
Quantity
returned byget()
. Viaadd_tasks()
,transform()
adds additional tasks to c that further transform the data. (Such operations may be done inget()
directly, buttransform()
allows use ofgenno
operators and conveniences.)In the default implementation:
If
aggregate
isTrue
, aggregate the data (genno.operator.aggregate()
) on the \(n\) dimension using the key “n::groups”.If
interpolate
isTrue
, interpolate the data (genno.operator.interpolate()
) on the \(y\) dimension using “y::coords”.
Concrete classes may override this method to, for instance, change how aggregate and interpolate are handled, or add further steps. Such overrides may call the base implementation, or not.
- Returns:
referring to the data from base_key after any transformation. This may be the same as base_key.
- Return type:
- use_test_data: bool = False
True
to allow the class to look up and use test data. If no test data exists, this setting has no effect. See_where()
.
- where: list[str | 'Path'] = ['local', 'private']
where
keyword argument topath_fallback()
. See_where()
.