adding unit tests for emission bounds (either cumulative or per speci…

…fic period) (iiasa#187)

RELEASE_NOTES.md

@@ -119,3 +119,4 @@ jdbc.pwd = ixmp
 - [#65](https://github.com/iiasa/message_ix/pull/65): Bugfix for downloading tutorials. Now downloads current installed version by default.
 - [#60](https://github.com/iiasa/message_ix/pull/60): Add basic ability to write and read model input to/from Excel
 - [#59](https://github.com/iiasa/message_ix/pull/59): Added MacOSX CI support
+- [#187](https://github.com/iiasa/message_ix/pull/187): Test for cumulative bound on emissions

tests/test_bound_emission.py

@@ -0,0 +1,78 @@
+
+from message_ix import Scenario
+
+
+def model_setup(scen, years):
+ scen.add_set('node', 'node')
+ scen.add_set('lvl_spatial', 'country')
+ scen.add_set('map_spatial_hierarchy', ['country', 'node', 'World'])
+ scen.add_set('commodity', 'comm')
+ scen.add_set('emission', 'emiss')
+ scen.add_cat('emission', 'emiss_type', 'emiss')
+ scen.add_set('level', 'level')
+ scen.add_set('year', years)
+ scen.add_set('type_year', years)
+
+ scen.add_set('technology', ['tec1', 'tec2'])
+ scen.add_set('mode', 'mode')
+ output_specs = ['node', 'comm', 'level', 'year', 'year']
+ dict_var_cost = {'tec1': 1, 'tec2': 2}
+ dict_em_factor = {'tec1': 1.5, 'tec2': 1}
+
+ for yr in years:
+ scen.add_par('demand', ['node', 'comm', 'level', yr, 'year'], 1, 'GWa')
+ for t in dict_var_cost.keys():
+ tec_specs = ['node', t, yr, yr, 'mode']
+ scen.add_par('output', tec_specs + output_specs, 1, 'GWa')
+ scen.add_par('var_cost',
+ tec_specs + ['year'], dict_var_cost[t], 'USD/GWa')
+ scen.add_par('emission_factor',
+ tec_specs + ['emiss'], dict_em_factor[t], 'kg/kWa')
+
+
+def add_bound_emission(scen, bound, year='cumulative'):
+ scen.check_out()
+ scen.add_par('bound_emission',
+ ['node', 'emiss_type', 'all', year], bound, 'kg')
+ scen.commit('Emission bound added')
+
+
+def assert_function(scen, year):
+ var_em = scen.var('EMISS', {'node': 'node'}).set_index(['year'])['lvl']
+ bound_em = float(scen.par('bound_emission', {'type_year': year})['value'])
+
+ if year == 'cumulative':
+ duration = scen.par('duration_period').set_index('year')['value']
+ assert sum(var_em * duration) / sum(duration) <= bound_em
+ else:
+ assert var_em[year] <= bound_em
+
+
+# Testing emission bound per one year
+def test_bound_emission_year(test_mp):
+ scen = Scenario(test_mp, 'test_bound_emission', 'standard', version='new')
+ model_setup(scen, [2020, 2030])
+ scen.commit('initialize test model')
+ add_bound_emission(scen, bound=1.250, year=2020)
+ scen.solve(case='bound_emission_year')
+ assert_function(scen, year=2020)
+
+
+# Testing cumulative emission bound for model years with equal intervals
+def test_bound_emission_10y(test_mp):
+ scen = Scenario(test_mp, 'test_bound_emission', 'standard', version='new')
+ model_setup(scen, [2020, 2030, 2040, 2050])
+ scen.commit('initialize test model')
+ add_bound_emission(scen, bound=1.250)
+ scen.solve(case='bound_emission_10y')
+ assert_function(scen, year='cumulative')
+
+
+# Testing cumulative emission bound for model years with mixed intervals
+def test_bound_emission_5y(test_mp):
+ scen = Scenario(test_mp, 'test_bound_emission', 'standard', version='new')
+ model_setup(scen, [2020, 2025, 2030, 2040])
+ scen.commit('initialize test model')
+ add_bound_emission(scen, bound=1.250)
+ scen.solve(case='bound_emission_5y')
+ assert_function(scen, year='cumulative')