Mistakes in documentation of the parameters

[ClaraLuisa]

Some parameters are described inaccurately on http://messageix.iiasa.ac.at/. eg "historical_emission" should be something like:

• node | type_emission | type_tec | type_year

instead it reads:

• node | emission | type_tec | year

[khaeru]

I came across this while looking for documentation-related issues.

The docstring seems to correctly match the definition: https://github.com/iiasa/message_ix/blob/154c58150755f1445ed48de028656daefccde995/message_ix/model/MESSAGE/parameter_def.gms#L483-L487

The parameter is used here: https://github.com/iiasa/message_ix/blob/154c58150755f1445ed48de028656daefccde995/message_ix/model/MESSAGE/model_core.gms#L1701-L1708

As far as I can tell:

• The historical emissions are added to projected emissions for each species—i.e. each member of the set emission, e.g. "CO2", "CH4", etc.—separately.
• After this, emissions are summed across sets of species (e.g. "GHG"s) appearing in type_emission.
• year_all is the set of all historical and future years.
• Other parameters like bound_emission may be defined as applying not only to particular years, but to "cumulative" emissions; "cumulative" is a member of type_year with the special meaning "sum across year_all".
• But, historical emissions are specific to particular years.

So the definition and description here seem to be correct.

Can @OFR-IIASA, @danielhuppmann or someone else confirm this is the right interpretation?

[francescolovat]

Hi @ClaraLuisa ,

have you found other innaccuracies like the one you presented here?

[ClaraLuisa]

@khaeru sorry for this edit, but I just tried to change my code to the parameter convention of node | emission | type_tec | year and now the parameter does not make it through to the database instead gives me the error message: KeyError: 'type_emission'