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:

message_ix/message_ix/model/MESSAGE/parameter_def.gms

Lines 483 to 487 in 154c581

	Parameters
	historical_emission(node,emission,type_tec,year_all) historical emissions by technology type (including land)
	emission_scaling(type_emission,emission) scaling factor to harmonize bounds or taxes across tpes
	bound_emission(node,type_emission,type_tec,type_year) upper bound on emissions
	tax_emission(node,type_emission,type_tec,type_year) emission tax

The parameter is used here:

message_ix/message_ix/model/MESSAGE/model_core.gms

Lines 1701 to 1708 in 154c581

	EMISSION_CONSTRAINT(node,type_emission,type_tec,type_year)$is_bound_emission(node,type_emission,type_tec,type_year)..
	SUM( (year_all2,emission)$( cat_year(type_year,year_all2) AND cat_emission(type_emission,emission) ),
	duration_period(year_all2) * emission_scaling(type_emission,emission) *
	( EMISS(node,emission,type_tec,year_all2)$( year(year_all2) )
	+ historical_emission(node,emission,type_tec,year_all2) )
	)
	/ SUM(year_all2$( cat_year(type_year,year_all2) ), duration_period(year_all2) )
	=L= bound_emission(node,type_emission,type_tec,type_year) ;

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'

[glatterf42]

I'm closing this issue since @khaeru's understanding seems to be correct. As far as I can tell, @francescolovat tried adapting the parameter definition as suggested here, which didn't work. He then reverted the change because it "ha[d] no sense and [was] wrong", so if it is an actual error or if you find any new errors, please create a new issue for them :)