Global Energy Assessment (project.gea)

Handle data from the Global Energy Assessment (GEA).

Although free of charge, the GEA data can not be downloaded automatically. This source requires that users first submit personal information to register before being able to retrieve the data. message_ix_models does not circumvent this requirement. Thus:

  • A copy of the data are stored in message_data.

  • message_ix_models contains only a ‘fuzzed’ version of the data (same structure, random values) for testing purposes.

class message_ix_models.project.gea.data.GEA(*args, **kwargs)[source]

Provider of exogenous data from the GEA data source.

Per Options.measure, see the source data for details.

class Options(aggregate: bool = False, interpolate: bool = False, measure: str = '', name: str = '', dims: tuple[str, ...] = ('n', 'y'), model: str = '', scenario: str = '')[source]
aggregate: bool = False

By default, do not aggregate.

interpolate: bool = False

By default, do not interpolate.

model: str = ''

Model name.

scenario: str = ''

Scenario name.

get() → :data:`~genno.core.quantity.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.

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]

Prepare c to transform raw data from base_key.

Compared to ExoDataSource.transform(), this version:

  • Does not perform interpolation.

where: list[str | 'Path'] = ['private']

where keyword argument to path_fallback(). See _where().

message_ix_models.project.gea.data.get_model_scenario() → set[tuple[str, str]][source]

Return a set of valid GEA (model name, scenario name) combinations.

These are read from data/gea/model-scenario.json.

Todo

Convert to Codelist.